Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-smtp Reference Manual, version 20191031.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:10:45 2022 GMT+0.
Next: Systems, Previous: The cl-smtp Reference Manual, Up: The cl-smtp Reference Manual [Contents][Index]
CL-SMTP is a simple lisp smtp client.
It works in ACL, SBCL, CMUCL, OPENMCL, LISPWORKS, CLISP and ECL.
new with support for send attachments, thanks Brian Sorg for the implementation
with authentication support for PLAIN and LOGIN authentication method
and ssl support with cl+ssl package
used cl-base64 and usocket packages (cl-base64 isn't a requirement on ACL)
See INSTALL for prerequisites and build details.
To use cl-smtp:
(asdf:operate 'asdf:load-op 'cl-smtp)
------------------------------------------------
(cl-smtp:send-email host from to subject message
&key (port 25) cc bcc reply-to extra-headers html-message
authentication attachments (buffer-size 256) ssl)
Send email.
Returns nil or error with message
arguments:
- host (String) : hostname or ip-address of the smtpserver
- from (String) : email address
- to (String or List of Strings) : email address
- subject (String) : subject text
- message (String) : message body
keywords:
- cc (String or List of Strings) : email adress carbon copy
- bcc (String or List of Strings): email adress blind carbon copy
- reply-to (String) : email adress
- display-name (String) : displayname of the sender
- extra-headers (List) : extra headers as alist
- html-message (String) : message body formatted with HTML tags
- authentication (List) : list with 2 or elements
([:method] "username" "password")
method is a keyword :plain or :login
If the method is not specified, the
proper method is determined automatically.
- attachments (Attachment Instance or String or Pathname: attachments to send
List of Attachment/String/Pathnames)
- buffer-size (Number default 256): is no longer used, will remove in the future
- ssl (or t :starttls :tls) : if t or :STARTTLS: use the STARTTLS functionality
if :TLS: use TLS directly
- external-format : symbol, default :utf-8
- envelope-sender : email adress,
if not set then envelope-sender = from
------------------------------------------------
(cl-smtp:rfc2045-q-encode-string str &key (external-format :utf8))
Decodes a string to an quoted-printable string.
Returns quoted-printable string
arguments:
- str : the string to encode
keywords:
- external-format : symbol, default :utf-8
------------------------------------------------
(cl-smtp:rfc2231-encode-string str &key (external-format :utf8))
Decodes a string to an rfc2231 encode string.
Returns rfc2231 encode string
arguments:
- str : the string to encode
keywords:
- external-format : symbol, default :utf-8
------------------------------------------------
(cl-smtp:write-rfc8822-message stream from to subject message
:cc cc :reply-to reply-to
:extra-headers extra-headers
:html-message html-message
:display-name display-name
:attachments attachments
:buffer-size buffer-size
:external-format external-format)
Writes a rfc8822 compatible email to the stream.
For arguments see the cl-smtp:send-email documentation.
------------------------------------------------
CLASS
cl-smtp:attachment
- accessor: attachment-name : string
- accessor: attachment-data-pathname : pathname
- accessor: attachment-mime-type : string (mime-type)
It is now possible to send a file under a different name.
See cl-smtp:make-attachment.
------------------------------------------------
(cl-smtp:make-attachment data-pathname
&key (name (file-namestring data-pathname))
(mime-type (lookup-mime-type name)))
Create a instance of cl-smtp:attachment.
Returns cl-smtp:attachment
arguments:
- data-pathname : pathname
keywords:
- name : string,
default (file-namestring data-pathname)
- mime-type : string,
default (lookup-mime-type name)
------------------------------------------------
For debug output set the parameter *debug* to t (default nil)
(setf cl-smtp::*debug* t)
CL-SMTP set automatically the Date header and the X-Mailer header.
X-Mailer: cl-smtp ((lisp-implementation-type) (lisp-implementation-version))
You can change this with setting the parameter *x-mailer*
(setf cl-smtp::*x-mailer* "my x-mailer string)
If you find bugs or want to send patches for enhancements, by email to
Jan Idzikowski
Next: Files, Previous: Introduction, Up: The cl-smtp Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Common Lisp smtp client.
Jan Idzikowski <jidzikowski@common-lisp.net>
Jan Idzikowski <jidzikowski@common-lisp.net>
LLGPL
20191031.1
Next: Packages, Previous: Systems, Up: The cl-smtp Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-smtp/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-smtp (system).
Next: cl-smtp/attachments.lisp, Previous: cl-smtp/cl-smtp.asd, Up: Lisp [Contents][Index]
cl-smtp (system).
Next: cl-smtp/cl-smtp.lisp, Previous: cl-smtp/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-smtp (system).
Next: cl-smtp/mime-types.lisp, Previous: cl-smtp/attachments.lisp, Up: Lisp [Contents][Index]
attachments.lisp (file).
cl-smtp (system).
Previous: cl-smtp/cl-smtp.lisp, Up: Lisp [Contents][Index]
cl-smtp.lisp (file).
cl-smtp (system).
Next: Definitions, Previous: Files, Up: The cl-smtp Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: Indexes, Previous: Packages, Up: The cl-smtp Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
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.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
name.
automatically generated writer method
name.
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
error.
:expected-response-code
This slot is read-only.
:response-code
This slot is read-only.
:response-message
This slot is read-only.
Previous: Conditions, Up: Public Interface [Contents][Index]
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
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
Previous: Ordinary functions, Up: Internals [Contents][Index]
Previous: Definitions, Up: The cl-smtp Reference Manual [Contents][Index]
| 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 |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| 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 |
|---|