This is the cl-smtp Reference Manual, version 20191031.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 19:38:17 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-smtpCommon Lisp smtp client.
Jan Idzikowski <jidzikowski@common-lisp.net>
Jan Idzikowski <jidzikowski@common-lisp.net>
LLGPL
20191031.1
alexandria (system).
usocket (system).
flexi-streams (system).
frugal-uuid/non-frugal (system).
cl-base64 (system).
cl+ssl (system).
package.lisp (file).
attachments.lisp (file).
cl-smtp.lisp (file).
mime-types.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-smtp/cl-smtp.asdcl-smtp/package.lispcl-smtp/attachments.lispcl-smtp/cl-smtp.lispcl-smtp/mime-types.lispcl-smtp/package.lispcl-smtp (system).
*debug* (special variable).
print-debug (macro).
cl-smtp/attachments.lisppackage.lisp (file).
cl-smtp (system).
attachment (class).
attachment-data-pathname (method).
attachment-data-pathname (method).
attachment-data-pathname (reader method).
(setf attachment-data-pathname) (writer method).
attachment-mime-type (method).
attachment-mime-type (method).
attachment-mime-type (reader method).
(setf attachment-mime-type) (writer method).
attachment-name (method).
attachment-name (method).
attachment-name (reader method).
(setf attachment-name) (writer method).
make-attachment (function).
rfc2231-encode-string (function).
*boundary-chars* (special variable).
base64-encode-file (function).
escape-rfc822-quoted-string (function).
generate-message-header (function).
generate-multipart-header (function).
make-random-boundary (function).
send-attachment (function).
send-attachment-header (function).
send-end-marker (function).
cl-smtp/cl-smtp.lispattachments.lisp (file).
cl-smtp (system).
*x-mailer* (special variable).
no-supported-authentication-method (condition).
rcpt-failed (condition).
rfc2045-q-encode-string (function).
send-email (function).
smtp-error (condition).
smtp-protocol-error (condition).
with-smtp-mail (macro).
write-rfc5322-message (function).
write-rfc8822-message (function).
*message-id-generator* (special variable).
*return-newline* (special variable).
+message-id-header-key+ (constant).
check-arg (function).
command (reader method).
do-with-smtp-mail (function).
expected-response-code (reader method).
extract-domain-from-email-address (function).
features (reader method).
finish-smtp-mail (function).
generate-email-message-id (function).
generate-email-message-id-random-part (function).
generate-message-id-header (generic function).
generate-message-id-uuidv7@domain (function).
get-email-date-string (function).
get-timezone-from-integer (function).
initiate-smtp-mail (function).
mask-dot (function).
mask-dot-stream (function).
read-from-smtp (function).
recipient (reader method).
response-code (reader method).
response-message (reader method).
rfc2045-q-encode-string-to-stream (function).
send-mail-headers (function).
send-multipart-headers (function).
send-smtp (function).
smtp-authenticate (function).
smtp-command (function).
smtp-handshake (function).
string-has-non-ascii (function).
string-to-base64-string (function).
substitute-return-newline (function).
write-blank-line (function).
write-to-smtp (function).
cl-smtp/mime-types.lispcl-smtp.lisp (file).
cl-smtp (system).
*mime-type-descriptions* (special variable).
*mime-types* (special variable).
lookup-mime-type (function).
Packages are listed by definition order.
cl-smtpcommon-lisp.
*debug* (special variable).
*x-mailer* (special variable).
attachment (class).
attachment-data-pathname (generic function).
(setf attachment-data-pathname) (generic writer).
attachment-mime-type (generic function).
(setf attachment-mime-type) (generic writer).
attachment-name (generic function).
(setf attachment-name) (generic writer).
make-attachment (function).
no-supported-authentication-method (condition).
rcpt-failed (condition).
rfc2045-q-encode-string (function).
rfc2231-encode-string (function).
send-email (function).
smtp-error (condition).
smtp-protocol-error (condition).
with-smtp-mail (macro).
write-rfc5322-message (function).
write-rfc8822-message (function).
*boundary-chars* (special variable).
*message-id-generator* (special variable).
*mime-type-descriptions* (special variable).
*mime-types* (special variable).
*return-newline* (special variable).
+message-id-header-key+ (constant).
base64-encode-file (function).
check-arg (function).
command (generic reader).
do-with-smtp-mail (function).
escape-rfc822-quoted-string (function).
expected-response-code (generic reader).
extract-domain-from-email-address (function).
features (generic reader).
finish-smtp-mail (function).
generate-email-message-id (function).
generate-email-message-id-random-part (function).
generate-message-header (function).
generate-message-id-header (generic function).
generate-message-id-uuidv7@domain (function).
generate-multipart-header (function).
get-email-date-string (function).
get-timezone-from-integer (function).
initiate-smtp-mail (function).
lookup-mime-type (function).
make-random-boundary (function).
mask-dot (function).
mask-dot-stream (function).
print-debug (macro).
read-from-smtp (function).
recipient (generic reader).
response-code (generic reader).
response-message (generic reader).
rfc2045-q-encode-string-to-stream (function).
send-attachment (function).
send-attachment-header (function).
send-end-marker (function).
send-mail-headers (function).
send-multipart-headers (function).
send-smtp (function).
smtp-authenticate (function).
smtp-command (function).
smtp-handshake (function).
string-has-non-ascii (function).
string-to-base64-string (function).
substitute-return-newline (function).
write-blank-line (function).
write-to-smtp (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Default value for the X-Mailer header, inserted by default in all outgoing e-mails. Bind to a string to customize the header’s value. If NIL, no X-Mailer header is generated at all.
Encapsulate a SMTP MAIl conversation. A connection to the SMTP server on HOST and PORT is established and a MAIL command is initiated with FROM being the mail sender and TO being the list of recipients. BODY is evaluated with STREAM-VAR being the stream connected to the remote SMTP server. BODY is expected to write the RFC2821 message (headers and body) to STREAM-VAR.
Deprecated function. Please change to write-rfc5322-message.
string)) ¶pathname)) ¶attachment)) ¶automatically generated reader method
attachment)) ¶automatically generated writer method
string)) ¶pathname)) ¶attachment)) ¶automatically generated reader method
attachment)) ¶automatically generated writer method
string)) ¶pathname)) ¶attachment)) ¶automatically generated reader method
name.
attachment)) ¶automatically generated writer method
name.
error.
:expected-response-code
This slot is read-only.
:response-code
This slot is read-only.
:response-message
This slot is read-only.
Encodes the file contents given by file-in, which can be of any form appropriate to with-open-file,
and write the base-64 encoded version to sock, which is a socket.
Buffer-size is ignored
Wrap-at-column controls where the encode string is divided for line breaks,
it is always set to a multiple of 3.
Finish sending an email to the SMTP server connected to on STREAM. The server is expected to be inside of the DATA SMTP command. The connection is then terminated by sending a QUIT command.
Initiate an SMTP MAIL command, sending a MAIL FROM command for the
email address in FROM and RCPT commands for all receipients in TO,
which is expected to be a list.
If any of the TO addresses is not accepted, a RCPT-FAILED condition is signalled. This condition may be handled by the caller in order to send the email anyway.
Extract mime type based on file-extension
Replace all occurences of single line #. with #.#.
Replace all occurences of single line #. with #.#.
Send email headers according to the given arguments to the SMTP server connected to on STREAM. The server is expected to have previously accepted the DATA SMTP command.
Authenticate to the SMTP server connected on STREAM.
AUTHENTICATION is a list of two or three elements. If the first
element is a keyword, it specifies the desired authentication
method (:PLAIN or :LOGIN), which is currently ignored. The actual
method used is determined by looking at the advertised features of
the SMTP server. The (other) two elements of the AUTHENTICATION
list are the login username and password. FEATURES is the list of
features announced by the SMTP server.
If the server does not announce any compatible authentication scheme, the NO-SUPPORTED-AUTHENTICATION-METHOD error is signalled.
Perform the initial SMTP handshake on STREAM. Returns the stream to use further down in the conversation, which may be different from the original stream if we switched to SSL.
Replace all occurences of rn in STR with spaces
smtp-protocol-error)) ¶smtp-protocol-error)) ¶no-supported-authentication-method)) ¶(eql :uuidv7)) sender-address) ¶(eql :uuidv7@domain)) sender-address) ¶null) sender-address) ¶string) sender-address) ¶rcpt-failed)) ¶smtp-protocol-error)) ¶smtp-protocol-error)) ¶| Jump to: | (
A B C D E F G I L M P R S W |
|---|
| Jump to: | (
A B C D E F G I L M P R S W |
|---|
| Jump to: | *
+
C D E F M N R S |
|---|
| Jump to: | *
+
C D E F M N R S |
|---|
| Jump to: | A C F M N P R S |
|---|
| Jump to: | A C F M N P R S |
|---|