This is the clonsigna Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:42:14 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
clonsignaSimple IMAP4rev1 client library
Andrea Chiumenti
iolib (system).
cl-base64 (system).
cl-ppcre (system).
split-sequence (system).
alexandria (system).
cl+ssl (system).
babel (system).
src (module).
Modules are listed depth-first from the system components tree.
clonsigna/srcclonsigna (system).
packages.lisp (file).
conditions.lisp (file).
classes.lisp (file).
commons.lisp (file).
parsers.lisp (file).
commands.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clonsigna/clonsigna.asdclonsigna/src/packages.lispclonsigna/src/conditions.lispclonsigna/src/classes.lispclonsigna/src/commons.lispclonsigna/src/parsers.lispclonsigna/src/commands.lispclonsigna/src/packages.lispclonsigna/src/conditions.lisppackages.lisp (file).
src (module).
operational-error (condition).
server-error (condition).
encoding-error (condition).
imap-error (condition).
message (reader method).
clonsigna/src/classes.lisppackages.lisp (file).
src (module).
bodystructure (class).
bodystructure-attachment-list (reader method).
(setf bodystructure-attachment-list) (writer method).
bodystructure-body-list (reader method).
(setf bodystructure-body-list) (writer method).
bodystructure-cid-list (reader method).
(setf bodystructure-cid-list) (writer method).
imap-socket (class).
imap-socket-capabilities (reader method).
(setf imap-socket-capabilities) (writer method).
imap-socket-connected-p (generic function).
imap-socket-crlf-p (reader method).
(setf imap-socket-crlf-p) (writer method).
imap-socket-flush-buffer (generic function).
imap-socket-has-capability (generic function).
imap-socket-messages (reader method).
imap-socket-read-reply (generic function).
imap-socket-remote-host (reader method).
(setf imap-socket-remote-host) (writer method).
imap-socket-remote-port (reader method).
(setf imap-socket-remote-port) (writer method).
imap-socket-send-command (generic function).
imap-socket-socket (reader method).
(setf imap-socket-socket) (writer method).
imap-socket-status-changed-p (generic function).
imap-socket-uidnext (reader method).
imap-socket-update-status (generic function).
make-bodystructure (function).
make-imap (function).
structure-element (class).
structure-element-body-description (reader method).
(setf structure-element-body-description) (writer method).
structure-element-body-encoding (reader method).
(setf structure-element-body-encoding) (writer method).
structure-element-body-id (reader method).
(setf structure-element-body-id) (writer method).
structure-element-body-parameters (reader method).
(setf structure-element-body-parameters) (writer method).
structure-element-mime-type (reader method).
(setf structure-element-mime-type) (writer method).
structure-element-section (reader method).
(setf structure-element-section) (writer method).
%eol-p (generic function).
%make-structure-element (function).
%read-line (generic function).
%read-line-continuation (generic function).
bodystructure-report-list (reader method).
(setf bodystructure-report-list) (writer method).
imap-socket-counter (reader method).
imap-socket-line-separator (reader method).
(setf imap-socket-line-separator) (writer method).
imap-socket-message-id (generic function).
imap-socket-next-message (generic function).
imap-socket-others-namespaces (reader method).
(setf imap-socket-others-namespaces) (writer method).
imap-socket-personal-namespaces (reader method).
(setf imap-socket-personal-namespaces) (writer method).
imap-socket-shared-namespaces (reader method).
(setf imap-socket-shared-namespaces) (writer method).
imap-socket-ssl-p (reader method).
clonsigna/src/commons.lispconditions.lisp (file).
classes.lisp (file).
src (module).
ends-with (function).
starts-with (function).
%base64-decode (function).
%quoted-char-decode (function).
%quoted-decode (function).
convert-to-imap-list (function).
decode-header-value (function).
decode-string (function).
octets-to-string (function).
string-to-octets (function).
clonsigna/src/parsers.lispcommons.lisp (file).
src (module).
most-recents-from-parsed-thread (function).
parse-bodystructure (function).
parse-capability (function).
parse-examine (function).
parse-fetch-body (function).
parse-fetch-fields (function).
parse-list (function).
parse-lsub (function).
parse-namespace (function).
parse-search (function).
parse-select (function).
parse-sort (function).
parse-status (function).
parse-thread (function).
%alternative-from-text-position (function).
%alternative-p (function).
%attachment-p (function).
%attachment-sections-from-bodystructure (function).
%cid-sections-from-bodystructure (function).
%get-id-list (function).
%goto-section (function).
%id-uid-flags (function).
%make-text-bodystructure (function).
%multipart-subtype (function).
%parse-body-parameters (function).
%parse-list (function).
%parse-reply-result (function).
%parse-tagged-line (function).
%read-namespace-list (function).
%read-namespace-namespace (function).
%report-sections-from-bodystructure (function).
%scan-line-for-headers (function).
%text-position (function).
%text-section-from-alternative (function).
%text-sections-from-bodystructure (function).
clonsigna/src/commands.lispparsers.lisp (file).
src (module).
cmd-append (generic function).
cmd-authenticate-plain (generic function).
cmd-capability (generic function).
cmd-check (generic function).
cmd-close (generic function).
cmd-connect (generic function).
cmd-create (generic function).
cmd-delete (generic function).
cmd-examine (generic function).
cmd-expunge (generic function).
cmd-fetch (generic function).
cmd-fetch-body (generic function).
cmd-fetch-fields (generic function).
cmd-list (generic function).
cmd-login (generic function).
cmd-logout (generic function).
cmd-lsub (method).
cmd-namespace (generic function).
cmd-noop (generic function).
cmd-rename (generic function).
cmd-search (generic function).
cmd-select (generic function).
cmd-sort (generic function).
cmd-starttls (generic function).
cmd-status (generic function).
cmd-subscribe (generic function).
cmd-thread (generic function).
cmd-unsubscribe (generic function).
%pathname-to-mailbox (generic function).
Packages are listed by definition order.
clonsignaSimple IMAP4rev1 client library
common-lisp.
+debug+ (special variable).
bodystructure (class).
bodystructure-attachment-list (generic reader).
(setf bodystructure-attachment-list) (generic writer).
bodystructure-body-list (generic reader).
(setf bodystructure-body-list) (generic writer).
bodystructure-cid-list (generic reader).
(setf bodystructure-cid-list) (generic writer).
cmd-append (generic function).
cmd-authenticate-plain (generic function).
cmd-capability (generic function).
cmd-check (generic function).
cmd-close (generic function).
cmd-connect (generic function).
cmd-create (generic function).
cmd-delete (generic function).
cmd-examine (generic function).
cmd-expunge (generic function).
cmd-fetch (generic function).
cmd-fetch-body (generic function).
cmd-fetch-fields (generic function).
cmd-list (generic function).
cmd-login (generic function).
cmd-logout (generic function).
cmd-lsub (generic function).
cmd-namespace (generic function).
cmd-noop (generic function).
cmd-rename (generic function).
cmd-search (generic function).
cmd-select (generic function).
cmd-sort (generic function).
cmd-starttls (generic function).
cmd-status (generic function).
cmd-subscribe (generic function).
cmd-thread (generic function).
cmd-unsubscribe (generic function).
ends-with (function).
imap-socket (class).
imap-socket-capabilities (generic reader).
(setf imap-socket-capabilities) (generic writer).
imap-socket-connected-p (generic function).
imap-socket-crlf-p (generic reader).
(setf imap-socket-crlf-p) (generic writer).
imap-socket-flush-buffer (generic function).
imap-socket-has-capability (generic function).
imap-socket-messages (generic reader).
imap-socket-read-reply (generic function).
imap-socket-remote-host (generic reader).
(setf imap-socket-remote-host) (generic writer).
imap-socket-remote-port (generic reader).
(setf imap-socket-remote-port) (generic writer).
imap-socket-send-command (generic function).
imap-socket-socket (generic reader).
(setf imap-socket-socket) (generic writer).
imap-socket-status-changed-p (generic function).
imap-socket-uidnext (generic reader).
imap-socket-update-status (generic function).
make-bodystructure (function).
make-imap (function).
most-recents-from-parsed-thread (function).
operational-error (condition).
parse-bodystructure (function).
parse-capability (function).
parse-examine (function).
parse-fetch-body (function).
parse-fetch-fields (function).
parse-list (function).
parse-lsub (function).
parse-namespace (function).
parse-search (function).
parse-select (function).
parse-sort (function).
parse-status (function).
parse-thread (function).
server-error (condition).
starts-with (function).
structure-element (class).
structure-element-body-description (generic reader).
(setf structure-element-body-description) (generic writer).
structure-element-body-encoding (generic reader).
(setf structure-element-body-encoding) (generic writer).
structure-element-body-id (generic reader).
(setf structure-element-body-id) (generic writer).
structure-element-body-parameters (generic reader).
(setf structure-element-body-parameters) (generic writer).
structure-element-mime-type (generic reader).
(setf structure-element-mime-type) (generic writer).
structure-element-section (generic reader).
(setf structure-element-section) (generic writer).
%alternative-from-text-position (function).
%alternative-p (function).
%attachment-p (function).
%attachment-sections-from-bodystructure (function).
%base64-decode (function).
%cid-sections-from-bodystructure (function).
%eol-p (generic function).
%get-id-list (function).
%goto-section (function).
%id-uid-flags (function).
%make-structure-element (function).
%make-text-bodystructure (function).
%multipart-subtype (function).
%parse-body-parameters (function).
%parse-list (function).
%parse-reply-result (function).
%parse-tagged-line (function).
%pathname-to-mailbox (generic function).
%quoted-char-decode (function).
%quoted-decode (function).
%read-line (generic function).
%read-line-continuation (generic function).
%read-namespace-list (function).
%read-namespace-namespace (function).
%report-sections-from-bodystructure (function).
%scan-line-for-headers (function).
%text-position (function).
%text-section-from-alternative (function).
%text-sections-from-bodystructure (function).
bodystructure-report-list (generic reader).
(setf bodystructure-report-list) (generic writer).
convert-to-imap-list (function).
decode-header-value (function).
decode-string (function).
encoding-error (condition).
imap-error (condition).
imap-socket-counter (generic reader).
imap-socket-line-separator (generic reader).
(setf imap-socket-line-separator) (generic writer).
imap-socket-message-id (generic function).
imap-socket-next-message (generic function).
imap-socket-others-namespaces (generic reader).
(setf imap-socket-others-namespaces) (generic writer).
imap-socket-personal-namespaces (generic reader).
(setf imap-socket-personal-namespaces) (generic writer).
imap-socket-shared-namespaces (generic reader).
(setf imap-socket-shared-namespaces) (generic writer).
imap-socket-ssl-p (generic reader).
message (generic reader).
octets-to-string (function).
string-to-octets (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
When true it outputs to the standard output the commands sent to the server.
Functions that checks if the given STR ends with START regardless char case
This function creates a BODYSTRUCTURE object on a PARSE-BODYSTRUCTURE result. See CMD-FETCH-FIELDS for more details.
Creates an IMAP-SOCKET object
Paratmers:
HOST Remote IMAP server address
PORT Remote IMAP server port
CRLF-P IMAP line termination (it should always be true as spec. by rfc3501)
SSL-P When not null it instructs the client to connect to the server via SSL connection.
This function returns the most recent message in a thread (by greatest ID or UID). See PARSE-THREAD documentation for more details.
This function parses a body structure returning a plist where keys are:
:BODY :CID :ATTACHMENT :REPORT
See CMD-FETCH-FIELDS form more details
Function used to parse the result of CMD-CAPABILITY that returns a plist like the following:
(:ACL2 ("UNION") :ACL (T) :IDLE (T) :QUOTA (T) :SORT (T) :THREAD
("ORDEREDSUBJECT" "REFERENCES") :NAMESPACE (T) :CHILDREN (T) :UIDPLUS (T)
:IMAP4REV1 (T))
The result should be assigned to the CAPABILITIES slot of an IMAP-SOCKET object.
This function behaves exactly the same as PARSE-SELECT
This function parses the result of a CMD-FETCH-BODY.
It may be used to return the decoded body content string or to write it to the STREAM parameter.
See CMD-FETCH-BODY fore more info.
Parameters:
LINE a string contained the body in encoded form.
CHARSET when not null and when STREAM parameter is null it’s the default charset for the output
result. This parameter can be retrieved from the bodystructure of the message.
ENCODING the encoding format parameter. This is usually retrieved from the bodystructure
of the message.
STREAM when not nil the parsing result is directed to this stream and functiono output
becomes undefined.
Result:
When STREAM parameter is null, the decoded message string is returned.
See CMD-FETCH-BODY for more info.
This function is used to parse CMD-FETCH-FIELDS result. See CMD-FETCH-FIELDS documentation for more details.
This function is used to parse the result of CMD-LIST and produces a plist like the following:
((:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Trash")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.maildir")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Drafts")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.sent-mail")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Sent"))
This function is used to parse the result of CMD-LSUB and produces a plist like the following:
((:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Trash")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.maildir")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Drafts")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.sent-mail")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Sent"))
This functions is used to parse the result of CMD-NAMESPACE.
It returns a plist where keywords are
:PERSONAL :OTHERS and :SHARED
values are hashtables where key is the reference mailbox name and value is the delimiter.
This function parses the result of a CMD-SEARCH and produces a list of ID or UID depending by the kind of the command.
This function is used to parse the result of CMD-SELECT and produces a plist like the one
produced by CMD-STATUS so a plist with keywords:
:EXISTS :RECENT :UNSEEN :PERMANENTFLAGS :UIDNEX :UIDVALIDITY :FLAGS
is generated
This function parses the result of a CMD-SORT and produces a list of ID or UID depending by the kind of the command.
This functions is used to parse the result of CMD-STATUS.
It returns a plist that will be then used to update the status of the IMAP-SOCKET object.
A parsed status plist is something like:
(:MESSAGES 192 :RECENT 2 :UIDNEXT 6793 :UIDVALIDITY 1219826147 :UNSEEN 16)
This function is used to parse a CMD-THREAD result. a list of threads ID or UID is returned in descending order.
Functions that checks if the given STR starts with START regardless char case
bodystructure)) ¶bodystructure)) ¶Holds the attachment elements in a list of STRUCTURE-ELEMENT objects.
bodystructure)) ¶bodystructure)) ¶Holds the body elements in a list of STRUCTURE-ELEMENT objects.
body.
bodystructure)) ¶bodystructure)) ¶Holds the reference elements of a body element for inline content (as images) in a list of STRUCTURE-ELEMENT objects.
cid.
Performs an IMAP APPEND (rfc3501) command.
MAILBOX-NAME The mailbox name where to append the message (can be a pathname)
MASSAGE The message string in rfc2822 format.
FLAGS A list of strings that are the flags for the message to append.
DATE The date of the message (rfc2822)
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name message &key flags date) ¶Performs an IMAP AUTHENTICATE PLAIN (rfc3501 and rfc4616) command as an
alternative to LOGIN command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) login password) ¶Performs an IMAP CAPABILITY (rfc3501) command.
The result should usually be passed to the PARSE-CAPABILITY method that transforms it into
a plist that will be then used to update the capabilities slot of the IMAP-SOCKET object.
A parsed capability plist is something like:
(:ACL2 ("UNION") :ACL (T) :IDLE (T) :QUOTA (T) :SORT (T) :THREAD
("ORDEREDSUBJECT" "REFERENCES") :NAMESPACE (T) :CHILDREN (T) :UIDPLUS (T)
:IMAP4REV1 (T))
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP CHECK (rfc3501) command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP CLOSE (rfc3501) command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶This function is required to connect an IMAP-SOCKET object to an IMAP server.
Depending on the passed parameter it can connect via IMAP or IMAP over ssl.
After the connection has been succeded. The capabilities slot of the parameter object passed is filled.
Return: Returns plist of capabilities got from the server like the following:
(:STARTTLS (T) :ACL2 ("UNION") :ACL (T) :IDLE (T) :QUOTA (T) :SORT (T) :THREAD
("ORDEREDSUBJECT" "REFERENCES") :NAMESPACE (T) :CHILDREN (T) :UIDPLUS (T)
:IMAP4REV1 (T))
imap-socket)) ¶Performs an IMAP CREATE (rfc3501) command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶Performs an IMAP DELETE (rfc3501) command.
MAILBOX-NAME parameter is the mailbox name to delete(can be a pathname).
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶Performs an IMAP EXAMINE (rfc3501) command.
MAILBOX-NAME parameter is the mailbox name to examine(can be a pathname).
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶Performs an IMAP EXPUNGE (rfc3501) command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP FETCH or UID FETCH (rfc3501) command.
SEQUENCE-NUMBER Sequence set as defined in rfc3501 ir a number or a list of numbers
CRITERIA The fetching criteria as specified in rfc3501.
UID-P When not null performs an UID FETCH instead of a simple FETCH command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) sequence-number &key criteria uid-p) ¶Performs an IMAP FETCH BODY[<section>] or UID FETCH BODY[<section>] (rfc3501) command.
The element result list is usually passed to the PARSE-FETCH-BODY function that decodes the reply.
SEQUENCE-NUMBER Sequence set as defined in rfc3501 ir a number or a list of numbers
SECTION The section to fetch that can passed in list of number form and internally transformed to
the section (as described in rfc3501).
UID-P When not null performs an UID FETCH instead of a simple FETCH command.
Both for CMD-FETCH-BODY and for PARSE-FETCH-BODY a calls to
CMD-FETCH-FIELDS -> PARSE-FETCH-FIELDS -> PARSE-BODYSTRUCTURE -> MAKE-BODYSTRUCTURE usually happen.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) sequence-number &key section uid-p) ¶Performs an IMAP FETCH (FIELDS param) or UID FETCH (FIELDS param) (rfc3501) command.
The result is usually passed to the PARSE-FETCH-FIELDS function that produces a plist like the follofing.
((:ID 1 :UID 7 :FLAGS (SEEN) :BODYSTRUCTURE
("text" "plain" ("charset" "utf-8") NIL NIL "8bit" 298 11 NIL NIL NIL)
:HEADERS
(:MESSAGE-ID "<200808270928.m7R9SDvK008347@apache-5.foo.com>" :DATE
"Wed, 27 Aug 2008 12:28:08 +0300" :FROM
"\"StartCom CertMaster\" <certmaster@foo.com>" :TO "destination@yourserver.com"
:SUBJECT "Your Authentication Code, 27 Aug 2008 12:28")))
where :HEADERS is a plist of headers fields keywords and values where values are parsed into plain strings
(following rfc2822 specs).
The :BODYSTRUCTURE value can pe passed to PARSE-BODYSTRUCETURE function that produces a simplification of the
bodystructure as a plist like this:
(:BODY body-list :CID cid-list :ATTACHMENT attachment-list :REPORT report-list)
each property value is in turn a plist.
After the bodystructure has been parsed, the result can be passed to function MAKE-BODYSTRUCTURE function that
instantiates a bodystructure instance.
SEQUENCE-NUMBER Sequence set as defined in rfc3501 ir a number or a list of numbers
CRITERIA The fetching criteria as specified in rfc3501.
UID-P When not null performs an UID FETCH instead of a simple FETCH command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) sequence-number &key fields uid-p) ¶Performs an IMAP LIST (rfc3501) command.
The result should usually be passed to the PARSE-LIST method that transforms it into a
list of plist like the following:
((:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Trash")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.maildir")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Drafts")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.sent-mail")
(:NAME-ATTRIBUTES ("HasNoChildren") :HIERARCHY-DELIMITER "." :NAME
"INBOX.Sent"))
REFERENCE-NAME the reference mailbox name (can be a pathname).
MAILBOX-NAME the mailbox name (can be a pathname), or wildcards.
If a parameter is null, it’s converted to an empty string.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) reference-name mailbox-name) ¶Performs an IMAP LOGIN (rfc3501) command.
On success the client will be on an authenticated state and the return will be a triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) login password) ¶Performs an IMAP LOGOUT (rfc3501) command and so after the connection will be
closed.
Returns a triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply
imap-socket)) ¶imap-socket) reference-name mailbox-name) ¶Performs an IMAP NAMESPACE (rfc2342) command.
The result should usually be passed to the PARSE-NAMESPACE method that transforms it
into a plist where keywords are
:PERSONAL :OTHERS and :SHARED
values are hashtables where key is the reference mailbox name and value is the delimiter.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP NOOP (rfc3501) command.
This command is usually used as a sort of ‘keep alive‘ and should be
periodically called by a client application.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP RENAME (rfc3501) command.
MAILBOX-NAME parameter is the original mailbox name (can be a pathname).
NEW-MAILBOX-NAME is the new mailbox name (can be a pathname).
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name new-mailbox-name) ¶Performs an IMAP SEARCH or UID SEARCH (rfc3501) command.
The result should usually be passed to the PARSE-SEARCH that returns a list of message numbers
that match the CRITERIA
CAHRSET An optional parameter specifying the charset ot the CRITERIA
CRITERIA The searching criteria as specified in rfc3501.
UID-P When not null performs an UID SEARCH instead of a simple SEARCH command.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) &key charset criteria uid-p) ¶Performs an IMAP SELECT (rfc3501) command.
MAILBOX-NAME parameter is the mailbox name to select(can be a pathname).
The result can be parsed by the function PARSE-SELECT.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶Performs an IMAP SORT or UID SORT (rfc5256) command.
The result list is usually passed to the PARSE-SORT function that decodes the reply
and returns a list of ID or UID with the given sort program.
SORT is the sort program described in rfc5256.
CRITERIA is the searching criteria as specified in rfc5256.
UID-P when not nil performs an UID THREAD command.
CHARSET is the charset specification for the criteria.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) &key sort criteria uid-p charset) ¶Performs an IMAP STARTTLS (rfc3501) command and performs
the negotiation with the server.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket)) ¶Performs an IMAP STATUS (rfc3501) command.
The result should usually be passed to the PARSE-STATUS method that transforms it into
a plist that will be then used to update the status of the IMAP-SOCKET object.
A parsed status plist is something like:
(:MESSAGES 192 :RECENT 2 :UIDNEXT 6793 :UIDVALIDITY 1219826147 :UNSEEN 16)
STATUS-DATA-ITEM-NAMES List of keyword for status data item names.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name &optional status-data-item-names) ¶Performs an IMAP SUBSCRIBE (rfc3501) command.
MAILBOX-NAME parameter is the mailbox name to subscribe to(can be a pathname).
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶Performs an IMAP THREAD or UID THREAD (rfc5256) command.
The result list is usually passed to the PARSE-THREAD function that decodes the reply.
The parsed result is arranged in descending order by ID or UID.
THREAD is the threading algorithm that you can find inspecting the server capabilities.
CRITERIA is the searching criteria as specified in rfc5256.
UID-P when not nil performs an UID THREAD command.
CHARSET is the charset specification for the criteria.
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) &key thread criteria uid-p charset) ¶Performs an IMAP UNSUBSCRIBE (rfc3501) command.
MAILBOX-NAME parameter is the mailbox name to unsubscribe to (can be a pathname).
On success returns triplet of values:
1) reply list of strings
2) result-op alway OK
3) the result-op description (what comes after OK in the IMAP reply.
On failure a condition of type OPERATIONAL-ERROR or SERVER-ERROR will be signaled.
imap-socket) mailbox-name) ¶imap-socket)) ¶imap-socket)) ¶Stores the capabilities of the imap server after connection.
This function is used to test if an IMAP-SOCKET object is connected to the server
imap-socket)) ¶imap-socket)) ¶automatically generated reader method
crlf.
imap-socket)) ¶automatically generated writer method
crlf.
This method simply flush server messages discarding the reply. Ususally you will not need it but use the CMD-* command wrappers.
imap-socket)) ¶This function returns nil or a list of capabilities that
the IMAP-SOCKET has stored from the server.
CAPABILITY is a capability keyword.
See CMD-CAPABILITY for more details
imap-socket) capability) ¶imap-socket)) ¶Current messages number of the ’inbox’ mailbox
This function is a generic function that is used to read a reply from an IMAP server after a command has been called ono the server. Ususally you will not need it but use the CMD-* command wrappers.
imap-socket)) ¶imap-socket)) ¶imap-socket)) ¶IMAP server address
imap-socket)) ¶imap-socket)) ¶IMAP server port
This function is used to send generic commands to an IMAP server. It’s mainly used by all CMD-* command wrappers.
imap-socket) command &rest args) ¶imap-socket)) ¶imap-socket)) ¶Holds the socket stream
This function returns a not null value if the IMAP-SOCKET
last stored status is different from the one passed as parameter.
Check is done on MESSAGES and UIDNEXT slot values.
See CMD-STATUS for more details.
imap-socket) status) ¶imap-socket)) ¶Current uidnext of the ’inbox’ mailbox
This function updates MESSAGES and UIDNEXT slot values
of an IMAP-SOCKET object form the STATUS parameter.
This function is often called after a call to IMAP-SOCKET-STATUS-CHANGED-P
has returned a not null value.
See CMD-STATUS for more details.
imap-socket) status) ¶structure-element)) ¶structure-element)) ¶Holds the body description (rfc3501#7.4.2)
structure-element)) ¶structure-element)) ¶Holds the body encoding type (rfc3501#7.4.2, rfc2822)
structure-element)) ¶structure-element)) ¶Holds the body id (rfc3501#7.4.2)
structure-element)) ¶structure-element)) ¶Holds body parameters in a plist structure (you’ll usually get the :charset from here)
structure-element)) ¶structure-element)) ¶Holds the element mime-type
structure-element)) ¶structure-element)) ¶Holds a list of numbers that represents the element section.
This list should then be passed to CMD-FETCH-BODY to get the current element.
Condition signaled on NO responses
Condition signaled on BAD responses
After a bodystructure (rfc3501, rfc2822) has been parsed by PARSE-BODYSTRUCTURE function,
this class maps the parsed plist.
It is usually instantiated by MAKE-BODYSTRUCTURE function.
See CMD-FETCH-FIELDS, PARSE-BODYSTRUCTURE, MAKE-BODYSTRUCTURE
Holds the body elements in a list of STRUCTURE-ELEMENT objects.
:body
Holds the reference elements of a body element for inline content (as images) in a list of STRUCTURE-ELEMENT objects.
:cid
Holds the attachment elements in a list of STRUCTURE-ELEMENT objects.
:attachment
Holds the repot elements in a list of STRUCTURE-ELEMENT objects.
:report
This class holds the connection to an IMAP server.
It’s usually instantiated by the MAKE-IMAP function and activated by CMD-CONNECT.
%eol-p.
%pathname-to-mailbox.
%read-line.
%read-line-continuation.
cmd-append.
cmd-authenticate-plain.
cmd-capability.
cmd-check.
cmd-close.
cmd-connect.
cmd-create.
cmd-delete.
cmd-examine.
cmd-expunge.
cmd-fetch.
cmd-fetch-body.
cmd-fetch-fields.
cmd-list.
cmd-login.
cmd-logout.
cmd-lsub.
cmd-namespace.
cmd-noop.
cmd-rename.
cmd-search.
cmd-select.
cmd-sort.
cmd-starttls.
cmd-status.
cmd-subscribe.
cmd-thread.
cmd-unsubscribe.
(setf imap-socket-capabilities).
imap-socket-capabilities.
imap-socket-connected-p.
imap-socket-counter.
(setf imap-socket-crlf-p).
imap-socket-crlf-p.
imap-socket-flush-buffer.
imap-socket-has-capability.
(setf imap-socket-line-separator).
imap-socket-line-separator.
imap-socket-message-id.
imap-socket-messages.
imap-socket-next-message.
(setf imap-socket-others-namespaces).
imap-socket-others-namespaces.
(setf imap-socket-personal-namespaces).
imap-socket-personal-namespaces.
imap-socket-read-reply.
(setf imap-socket-remote-host).
imap-socket-remote-host.
(setf imap-socket-remote-port).
imap-socket-remote-port.
imap-socket-send-command.
(setf imap-socket-shared-namespaces).
imap-socket-shared-namespaces.
(setf imap-socket-socket).
imap-socket-socket.
imap-socket-ssl-p.
imap-socket-status-changed-p.
imap-socket-uidnext.
imap-socket-update-status.
| Initarg | Value |
|---|---|
:socket | nil |
:remote-host | 127.0.0.1 |
:remote-port | 143 |
:ssl-p | nil |
Holds the socket stream
:socket
IMAP server address
:remote-host
IMAP server port
:remote-port
0
This slot is read-only.
t
Stores the capabilities of the imap server after connection.
(format nil "~a" #\newline)
:line-separator
(make-hash-table :test (quote equal))
(make-hash-table :test (quote equal))
Current messages number of the ’inbox’ mailbox
0
This slot is read-only.
Current uidnext of the ’inbox’ mailbox
0
This slot is read-only.
:ssl-p
This slot is read-only.
This object may hold body, reference, attachment and message elements and
should not be directly instantiated. (rfc3501#7.4.2)
See CMD-FETCH-FIELDS, PARSE-BODYSTRUCTURE, MAKE-BODYSTRUCTURE
(setf structure-element-body-description).
structure-element-body-description.
(setf structure-element-body-encoding).
structure-element-body-encoding.
(setf structure-element-body-id).
structure-element-body-id.
(setf structure-element-body-parameters).
structure-element-body-parameters.
(setf structure-element-mime-type).
structure-element-mime-type.
(setf structure-element-section).
structure-element-section.
Holds the element mime-type
:mime-type
Holds body parameters in a plist structure (you’ll usually get the :charset from here)
:body-parameters
Holds the body id (rfc3501#7.4.2)
:body-id
Holds the body description (rfc3501#7.4.2)
:body-description
Holds the body encoding type (rfc3501#7.4.2, rfc2822)
:body-encoding
Holds a list of numbers that represents the element section.
This list should then be passed to CMD-FETCH-BODY to get the current element.
:section
imap-socket) byte) ¶imap-socket) pathname &optional ends-with-separator-p) ¶imap-socket)) ¶imap-socket) line) ¶bodystructure)) ¶bodystructure)) ¶Holds the repot elements in a list of STRUCTURE-ELEMENT objects.
imap-socket)) ¶automatically generated reader method
imap-socket)) ¶automatically generated reader method
imap-socket)) ¶automatically generated writer method
This function returns the current message sequence number of an IMAP-SOCKET object (see rfc3501)
imap-socket)) ¶This function increment the message sequence counter.
imap-socket)) ¶imap-socket)) ¶automatically generated reader method
imap-socket)) ¶automatically generated writer method
imap-socket)) ¶automatically generated reader method
imap-socket)) ¶automatically generated writer method
imap-socket)) ¶automatically generated reader method
ssl.
imap-error)) ¶| Jump to: | %
(
B C D E F G I M O P S |
|---|
| Jump to: | %
(
B C D E F G I M O P S |
|---|
| Jump to: | +
A B C L M O P R S U |
|---|
| Jump to: | +
A B C L M O P R S U |
|---|
| Jump to: | B C E F I M O P S |
|---|
| Jump to: | B C E F I M O P S |
|---|