The postoffice Reference Manual

Table of Contents

The postoffice Reference Manual

This is the postoffice Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:59:38 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 postoffice

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Franz, Inc

License

GNU Lesser General Public License

Description

Franz’s Post Office Package

Long Description

Post Office provides an interface to the SMTP, POP, and IMAP servers. It uses the ACL-COMPAT library for use with non-Allegro CL implementations.

Dependency

acl-compat

Source

postoffice.asd (file)

Components

• package.lisp (file)
• smtp.lisp (file)
• imap.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 postoffice.asd

Location

postoffice.asd

Systems

postoffice (system)

Packages

postoffice-system

2.1.2 postoffice/package.lisp

Parent

postoffice (system)

Location

package.lisp

Packages

net.post-office

2.1.3 postoffice/smtp.lisp

Dependency

package.lisp (file)

Parent

postoffice (system)

Location

smtp.lisp

Exported Definitions

• send-letter (function)
• send-smtp (function)
• test-email-address (function)

Internal Definitions

• *smtp-debug* (special variable)
• connect-to-mail-server (function)
• determine-mail-server (function)
• read-a-line (function)
• response-case (macro)
• smtp-command (function)
• wait-for-response (function)

2.1.4 postoffice/imap.lisp

Dependency

package.lisp (file)

Parent

postoffice (system)

Location

imap.lisp

Exported Definitions

• *imap-version-number* (special variable)
• address-additional (function)
• (setf address-additional) (function)
• address-host (function)
• (setf address-host) (function)
• address-mailbox (function)
• (setf address-mailbox) (function)
• address-name (function)
• (setf address-name) (function)
• alter-flags (method)
• close-connection (method)
• close-connection (method)
• close-mailbox (method)
• copy-to-mailbox (method)
• create-mailbox (method)
• delete-letter (method)
• delete-letter (method)
• delete-mailbox (method)
• envelope-bcc (function)
• (setf envelope-bcc) (function)
• envelope-cc (function)
• (setf envelope-cc) (function)
• envelope-date (function)
• (setf envelope-date) (function)
• envelope-from (function)
• (setf envelope-from) (function)
• envelope-in-reply-to (function)
• (setf envelope-in-reply-to) (function)
• envelope-message-id (function)
• (setf envelope-message-id) (function)
• envelope-reply-to (function)
• (setf envelope-reply-to) (function)
• envelope-sender (function)
• (setf envelope-sender) (function)
• envelope-subject (function)
• (setf envelope-subject) (function)
• envelope-to (function)
• (setf envelope-to) (function)
• expunge-mailbox (method)
• fetch-field (function)
• fetch-letter (method)
• fetch-letter (method)
• fetch-parts (method)
• mailbox-flags (method)
• (setf mailbox-flags) (method)
• mailbox-list (method)
• mailbox-list-flags (function)
• (setf mailbox-list-flags) (function)
• mailbox-list-name (function)
• (setf mailbox-list-name) (function)
• mailbox-list-separator (function)
• (setf mailbox-list-separator) (function)
• mailbox-message-count (method)
• (setf mailbox-message-count) (method)
• mailbox-message-count (method)
• (setf mailbox-message-count) (method)
• mailbox-permanent-flags (method)
• (setf mailbox-permanent-flags) (method)
• mailbox-recent-messages (method)
• (setf mailbox-recent-messages) (method)
• mailbox-separator (method)
• (setf mailbox-separator) (method)
• mailbox-uidvalidity (method)
• (setf mailbox-uidvalidity) (method)
• make-envelope-from-text (function)
• make-imap-connection (function)
• make-pop-connection (function)
• noop (method)
• noop (method)
• parse-mail-header (function)
• po-condition (function)
• po-condition (condition)
• po-condition-identifier (method)
• po-condition-server-string (method)
• po-error (function)
• po-error (condition)
• rename-mailbox (method)
• search-mailbox (method)
• select-mailbox (method)
• top-lines (method)
• unique-id (method)

Internal Definitions

• *char-to-kind* (special variable)
• *crlf* (special variable)
• *cur-imap-tags* (special variable)
• *debug-imap* (special variable)
• *imap-tags* (special variable)
• *line-buffers* (special variable)
• bss-int (function)
• build-search-string (function)
• check-for-success (function)
• convert-flags-plist (function)
• defsearchop (macro)
• first-unseen (method)
• (setf first-unseen) (method)
• free-line-buffer (function)
• get-and-parse-from-imap-server (method)
• get-and-parse-from-pop-server (method)
• get-block-of-data-from-server (function)
• get-line-buffer (function)
• get-line-from-server (function)
• get-next-sexpr (function)
• get-next-tag (function)
• get-next-token (function)
• handle-untagged-response (function)
• imap-mailbox (class)
• init-line-buffer (function)
• internalize-flags (function)
• kwd-intern (function)
• mailbox-name (method)
• (setf mailbox-name) (method)
• mailbox-uidnext (method)
• (setf mailbox-uidnext) (method)
• make-address (function)
• make-envelope (function)
• make-mailbox-list (function)
• message-set-string (function)
• parse-imap-response (function)
• parse-pop-response (function)
• pop-mailbox (class)
• post-office (class)
• post-office-host (method)
• (setf post-office-host) (method)
• post-office-socket (method)
• (setf post-office-socket) (method)
• post-office-state (method)
• (setf post-office-state) (method)
• post-office-user (method)
• (setf post-office-user) (method)
• send-command-get-results (method)
• send-pop-command-get-results (function)
• timeout (method)
• (setf timeout) (method)
• universal-time-to-rfc822-date (function)

3 Packages

Packages are listed by definition order.

3.1 postoffice-system

Source

postoffice.asd

Use List

• common-lisp
• asdf/interface

3.2 net.post-office

Source

package.lisp (file)

Use List

• acl-compat.mp
• acl-compat.socket
• acl-compat.excl
• common-lisp

Exported Definitions

• *imap-version-number* (special variable)
• address-additional (function)
• (setf address-additional) (function)
• address-host (function)
• (setf address-host) (function)
• address-mailbox (function)
• (setf address-mailbox) (function)
• address-name (function)
• (setf address-name) (function)
• alter-flags (generic function)
• alter-flags (method)
• close-connection (generic function)
• close-connection (method)
• close-connection (method)
• close-mailbox (generic function)
• close-mailbox (method)
• copy-to-mailbox (generic function)
• copy-to-mailbox (method)
• create-mailbox (generic function)
• create-mailbox (method)
• delete-letter (generic function)
• delete-letter (method)
• delete-letter (method)
• delete-mailbox (generic function)
• delete-mailbox (method)
• envelope-bcc (function)
• (setf envelope-bcc) (function)
• envelope-cc (function)
• (setf envelope-cc) (function)
• envelope-date (function)
• (setf envelope-date) (function)
• envelope-from (function)
• (setf envelope-from) (function)
• envelope-in-reply-to (function)
• (setf envelope-in-reply-to) (function)
• envelope-message-id (function)
• (setf envelope-message-id) (function)
• envelope-reply-to (function)
• (setf envelope-reply-to) (function)
• envelope-sender (function)
• (setf envelope-sender) (function)
• envelope-subject (function)
• (setf envelope-subject) (function)
• envelope-to (function)
• (setf envelope-to) (function)
• expunge-mailbox (generic function)
• expunge-mailbox (method)
• fetch-field (function)
• fetch-letter (generic function)
• fetch-letter (method)
• fetch-letter (method)
• fetch-parts (generic function)
• fetch-parts (method)
• mailbox-flags (generic function)
• mailbox-flags (method)
• (setf mailbox-flags) (method)
• (setf mailbox-flags) (generic function)
• mailbox-list (generic function)
• mailbox-list (method)
• mailbox-list-flags (function)
• (setf mailbox-list-flags) (function)
• mailbox-list-name (function)
• (setf mailbox-list-name) (function)
• mailbox-list-separator (function)
• (setf mailbox-list-separator) (function)
• mailbox-message-count (generic function)
• mailbox-message-count (method)
• (setf mailbox-message-count) (method)
• mailbox-message-count (method)
• (setf mailbox-message-count) (method)
• (setf mailbox-message-count) (generic function)
• mailbox-permanent-flags (generic function)
• mailbox-permanent-flags (method)
• (setf mailbox-permanent-flags) (method)
• (setf mailbox-permanent-flags) (generic function)
• mailbox-recent-messages (generic function)
• mailbox-recent-messages (method)
• (setf mailbox-recent-messages) (method)
• (setf mailbox-recent-messages) (generic function)
• mailbox-separator (generic function)
• mailbox-separator (method)
• (setf mailbox-separator) (method)
• (setf mailbox-separator) (generic function)
• mailbox-uidvalidity (generic function)
• mailbox-uidvalidity (method)
• (setf mailbox-uidvalidity) (method)
• (setf mailbox-uidvalidity) (generic function)
• make-envelope-from-text (function)
• make-imap-connection (function)
• make-pop-connection (function)
• noop (generic function)
• noop (method)
• noop (method)
• parse-mail-header (function)
• po-condition (function)
• po-condition (condition)
• po-condition-identifier (generic function)
• po-condition-identifier (method)
• po-condition-server-string (generic function)
• po-condition-server-string (method)
• po-error (function)
• po-error (condition)
• rename-mailbox (generic function)
• rename-mailbox (method)
• search-mailbox (generic function)
• search-mailbox (method)
• select-mailbox (generic function)
• select-mailbox (method)
• send-letter (function)
• send-smtp (function)
• test-email-address (function)
• top-lines (generic function)
• top-lines (method)
• unique-id (generic function)
• unique-id (method)

Internal Definitions

• *char-to-kind* (special variable)
• *crlf* (special variable)
• *cur-imap-tags* (special variable)
• *debug-imap* (special variable)
• *imap-tags* (special variable)
• *line-buffers* (special variable)
• *smtp-debug* (special variable)
• bss-int (function)
• build-search-string (function)
• check-for-success (function)
• connect-to-mail-server (function)
• convert-flags-plist (function)
• copy-address (function)
• copy-envelope (function)
• copy-mailbox-list (function)
• defsearchop (macro)
• determine-mail-server (function)
• first-unseen (generic function)
• first-unseen (method)
• (setf first-unseen) (method)
• (setf first-unseen) (generic function)
• free-line-buffer (function)
• get-and-parse-from-imap-server (generic function)
• get-and-parse-from-imap-server (method)
• get-and-parse-from-pop-server (generic function)
• get-and-parse-from-pop-server (method)
• get-block-of-data-from-server (function)
• get-line-buffer (function)
• get-line-from-server (function)
• get-next-sexpr (function)
• get-next-tag (function)
• get-next-token (function)
• handle-untagged-response (function)
• imap-mailbox (class)
• init-line-buffer (function)
• internalize-flags (function)
• kwd-intern (function)
• mailbox-name (generic function)
• mailbox-name (method)
• (setf mailbox-name) (method)
• (setf mailbox-name) (generic function)
• mailbox-uidnext (generic function)
• mailbox-uidnext (method)
• (setf mailbox-uidnext) (method)
• (setf mailbox-uidnext) (generic function)
• make-address (function)
• make-envelope (function)
• make-mailbox-list (function)
• message-set-string (function)
• parse-imap-response (function)
• parse-pop-response (function)
• pop-mailbox (class)
• post-office (class)
• post-office-host (generic function)
• post-office-host (method)
• (setf post-office-host) (method)
• (setf post-office-host) (generic function)
• post-office-socket (generic function)
• post-office-socket (method)
• (setf post-office-socket) (method)
• (setf post-office-socket) (generic function)
• post-office-state (generic function)
• post-office-state (method)
• (setf post-office-state) (method)
• (setf post-office-state) (generic function)
• post-office-user (generic function)
• post-office-user (method)
• (setf post-office-user) (method)
• (setf post-office-user) (generic function)
• read-a-line (function)
• response-case (macro)
• send-command-get-results (generic function)
• send-command-get-results (method)
• send-pop-command-get-results (function)
• smtp-command (function)
• timeout (generic function)
• timeout (method)
• (setf timeout) (method)
• (setf timeout) (generic function)
• universal-time-to-rfc822-date (function)
• wait-for-response (function)

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *imap-version-number*

Package

net.post-office

Source

imap.lisp (file)

4.1.2 Functions

Function: address-additional STRUCTURE

Function: (setf address-additional) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: address-host STRUCTURE

Function: (setf address-host) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: address-mailbox STRUCTURE

Function: (setf address-mailbox) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: address-name STRUCTURE

Function: (setf address-name) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-bcc STRUCTURE

Function: (setf envelope-bcc) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-cc STRUCTURE

Function: (setf envelope-cc) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-date STRUCTURE

Function: (setf envelope-date) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-from STRUCTURE

Function: (setf envelope-from) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-in-reply-to STRUCTURE

Function: (setf envelope-in-reply-to) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-message-id STRUCTURE

Function: (setf envelope-message-id) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-reply-to STRUCTURE

Function: (setf envelope-reply-to) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-sender STRUCTURE

Function: (setf envelope-sender) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-subject STRUCTURE

Function: (setf envelope-subject) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: envelope-to STRUCTURE

Function: (setf envelope-to) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: fetch-field LETTER-NUMBER FIELD-NAME INFO &key UID

Package

net.post-office

Source

imap.lisp (file)

Function: mailbox-list-flags STRUCTURE

Function: (setf mailbox-list-flags) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: mailbox-list-name STRUCTURE

Function: (setf mailbox-list-name) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: mailbox-list-separator STRUCTURE

Function: (setf mailbox-list-separator) VALUE STRUCTURE

Package

net.post-office

Source

imap.lisp (file)

Function: make-envelope-from-text TEXT

Package

net.post-office

Source

imap.lisp (file)

Function: make-imap-connection HOST &key PORT USER PASSWORD TIMEOUT

Package

net.post-office

Source

imap.lisp (file)

Function: make-pop-connection HOST &key PORT USER PASSWORD TIMEOUT

Package

net.post-office

Source

imap.lisp (file)

Function: parse-mail-header TEXT

Package

net.post-office

Source

imap.lisp (file)

Function: po-condition IDENTIFIER &key SERVER-STRING FORMAT-CONTROL FORMAT-ARGUMENTS

Package

net.post-office

Source

imap.lisp (file)

Function: po-error IDENTIFIER &key SERVER-STRING FORMAT-CONTROL FORMAT-ARGUMENTS

Package

net.post-office

Source

imap.lisp (file)

Function: send-letter SERVER FROM TO MESSAGE &key CC BCC SUBJECT REPLY-TO HEADERS

Package

net.post-office

Source

smtp.lisp (file)

Function: send-smtp SERVER FROM TO &rest MESSAGES

Package

net.post-office

Source

smtp.lisp (file)

Function: test-email-address ADDRESS

Package

net.post-office

Source

smtp.lisp (file)

4.1.3 Generic functions

Generic Function: alter-flags MB MESSAGES &key FLAGS ADD-FLAGS REMOVE-FLAGS SILENT UID

Package

net.post-office

Methods

Method: alter-flags (MB imap-mailbox) MESSAGES &key FLAGS ADD-FLAGS REMOVE-FLAGS SILENT UID

Source

imap.lisp (file)

Generic Function: close-connection MB

Package

net.post-office

Methods

Method: close-connection (PB pop-mailbox)

Source

imap.lisp (file)

Method: close-connection (MB imap-mailbox)

Source

imap.lisp (file)

Generic Function: close-mailbox MB

Package

net.post-office

Methods

Method: close-mailbox (MB imap-mailbox)

Source

imap.lisp (file)

Generic Function: copy-to-mailbox MB MESSAGE-LIST DESTINATION &key UID

Package

net.post-office

Methods

Method: copy-to-mailbox (MB imap-mailbox) MESSAGE-LIST DESTINATION &key UID

Source

imap.lisp (file)

Generic Function: create-mailbox MB MAILBOX-NAME

Package

net.post-office

Methods

Method: create-mailbox (MB imap-mailbox) MAILBOX-NAME

Source

imap.lisp (file)

Generic Function: delete-letter MB MESSAGES &key EXPUNGE UID

Package

net.post-office

Methods

Method: delete-letter (PB pop-mailbox) MESSAGES &key EXPUNGE UID

Source

imap.lisp (file)

Method: delete-letter (MB imap-mailbox) MESSAGES &key EXPUNGE UID

Source

imap.lisp (file)

Generic Function: delete-mailbox MB MAILBOX-NAME

Package

net.post-office

Methods

Method: delete-mailbox (MB imap-mailbox) MAILBOX-NAME

Source

imap.lisp (file)

Generic Function: expunge-mailbox MB

Package

net.post-office

Methods

Method: expunge-mailbox (MB imap-mailbox)

Source

imap.lisp (file)

Generic Function: fetch-letter MB NUMBER &key UID

Package

net.post-office

Methods

Method: fetch-letter (PB pop-mailbox) NUMBER &key UID

Source

imap.lisp (file)

Method: fetch-letter (MB imap-mailbox) NUMBER &key UID

Source

imap.lisp (file)

Generic Function: fetch-parts MB NUMBER PARTS &key UID

Package

net.post-office

Methods

Method: fetch-parts (MB imap-mailbox) NUMBER PARTS &key UID

Source

imap.lisp (file)

Generic Function: mailbox-flags OBJECT

Generic Function: (setf mailbox-flags) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-flags (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-flags) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-list MB &key REFERENCE PATTERN

Package

net.post-office

Methods

Method: mailbox-list (MB imap-mailbox) &key REFERENCE PATTERN

Source

imap.lisp (file)

Generic Function: mailbox-message-count OBJECT

Generic Function: (setf mailbox-message-count) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-message-count (POP-MAILBOX pop-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-message-count) NEW-VALUE (POP-MAILBOX pop-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Method: mailbox-message-count (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-message-count) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-permanent-flags OBJECT

Generic Function: (setf mailbox-permanent-flags) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-permanent-flags (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-permanent-flags) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-recent-messages OBJECT

Generic Function: (setf mailbox-recent-messages) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-recent-messages (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-recent-messages) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-separator OBJECT

Generic Function: (setf mailbox-separator) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-separator (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-separator) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-uidvalidity OBJECT

Generic Function: (setf mailbox-uidvalidity) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-uidvalidity (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-uidvalidity) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: noop MB

Package

net.post-office

Methods

Method: noop (PB pop-mailbox)

Source

imap.lisp (file)

Method: noop (MB imap-mailbox)

Source

imap.lisp (file)

Generic Function: po-condition-identifier CONDITION

Package

net.post-office

Methods

Method: po-condition-identifier (CONDITION po-condition)

Source

imap.lisp (file)

Generic Function: po-condition-server-string CONDITION

Package

net.post-office

Methods

Method: po-condition-server-string (CONDITION po-condition)

Source

imap.lisp (file)

Generic Function: rename-mailbox MB OLD-MAILBOX-NAME NEW-MAILBOX-NAME

Package

net.post-office

Methods

Method: rename-mailbox (MB imap-mailbox) OLD-MAILBOX-NAME NEW-MAILBOX-NAME

Source

imap.lisp (file)

Generic Function: search-mailbox MB SEARCH-EXPRESSION &key UID

Package

net.post-office

Methods

Method: search-mailbox (MB imap-mailbox) SEARCH-EXPRESSION &key UID

Source

imap.lisp (file)

Generic Function: select-mailbox MB NAME

Package

net.post-office

Methods

Method: select-mailbox (MB imap-mailbox) NAME

Source

imap.lisp (file)

Generic Function: top-lines PB MESSAGE LINES

Package

net.post-office

Methods

Method: top-lines (PB pop-mailbox) MESSAGE LINES

Source

imap.lisp (file)

Generic Function: unique-id PB &optional MESSAGE

Package

net.post-office

Methods

Method: unique-id (PB pop-mailbox) &optional MESSAGE

Source

imap.lisp (file)

4.1.4 Conditions

Condition: po-condition ()

Package

net.post-office

Source

imap.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses

po-error (condition)

Direct methods

• po-condition-server-string (method)
• po-condition-identifier (method)

Direct slots

Slot: identifier

Initargs

:identifier

Initform

(quote :unknown)

Readers

po-condition-identifier (generic function)

Slot: server-string

Initargs

:server-string

Initform

(quote "")

Readers

po-condition-server-string (generic function)

Condition: po-error ()

Package

net.post-office

Source

imap.lisp (file)

Direct superclasses

• error (condition)
• po-condition (condition)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *char-to-kind*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *crlf*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *cur-imap-tags*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *debug-imap*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *imap-tags*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *line-buffers*

Package

net.post-office

Source

imap.lisp (file)

Special Variable: *smtp-debug*

Package

net.post-office

Source

smtp.lisp (file)

4.2.2 Macros

Macro: defsearchop NAME &rest OPERANDS

Package

net.post-office

Source

imap.lisp (file)

Macro: response-case (SMTP-STREAM &optional SMTP-RESPONSE RESPONSE-CODE) &rest CASE-CLAUSES

Package

net.post-office

Source

smtp.lisp (file)

4.2.3 Functions

Function: bss-int SEARCH STR

Package

net.post-office

Source

imap.lisp (file)

Function: build-search-string SEARCH

Package

net.post-office

Source

imap.lisp (file)

Function: check-for-success MB COMMAND COUNT EXTRA COMMENT COMMAND-STRING

Package

net.post-office

Source

imap.lisp (file)

Function: connect-to-mail-server SERVER

Package

net.post-office

Source

smtp.lisp (file)

Function: convert-flags-plist PLIST

Package

net.post-office

Source

imap.lisp (file)

Function: copy-address SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

net.post-office

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-envelope SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

net.post-office

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-mailbox-list SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

net.post-office

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: determine-mail-server NAME

Package

net.post-office

Source

smtp.lisp (file)

Function: free-line-buffer BUFF

Package

net.post-office

Source

imap.lisp (file)

Function: get-block-of-data-from-server MB COUNT &key SAVE-RETURNS

Package

net.post-office

Source

imap.lisp (file)

Function: get-line-buffer SIZE

Package

net.post-office

Source

imap.lisp (file)

Function: get-line-from-server MAILBOX

Package

net.post-office

Source

imap.lisp (file)

Function: get-next-sexpr LINE START END

Package

net.post-office

Source

imap.lisp (file)

Function: get-next-tag ()

Package

net.post-office

Source

imap.lisp (file)

Function: get-next-token LINE START END

Package

net.post-office

Source

imap.lisp (file)

Function: handle-untagged-response MB COMMAND COUNT EXTRA COMMENT

Package

net.post-office

Source

imap.lisp (file)

Function: init-line-buffer NEW OLD

Package

net.post-office

Source

imap.lisp (file)

Function: internalize-flags STUFF

Package

net.post-office

Source

imap.lisp (file)

Function: kwd-intern STRING

Package

net.post-office

Source

imap.lisp (file)

Function: make-address &key (NAME NAME) (ADDITIONAL ADDITIONAL) (MAILBOX MAILBOX) (HOST HOST)

Package

net.post-office

Source

imap.lisp (file)

Function: make-envelope &key (DATE DATE) (SUBJECT SUBJECT) (FROM FROM) (SENDER SENDER) (REPLY-TO REPLY-TO) (TO TO) (CC CC) (BCC BCC) (IN-REPLY-TO IN-REPLY-TO) (MESSAGE-ID MESSAGE-ID)

Package

net.post-office

Source

imap.lisp (file)

Function: make-mailbox-list &key (FLAGS FLAGS) (SEPARATOR SEPARATOR) (NAME NAME)

Package

net.post-office

Source

imap.lisp (file)

Function: message-set-string MESSAGES

Package

net.post-office

Source

imap.lisp (file)

Function: parse-imap-response LINE END

Package

net.post-office

Source

imap.lisp (file)

Function: parse-pop-response LINE END

Package

net.post-office

Source

imap.lisp (file)

Function: read-a-line STREAM RES

Package

net.post-office

Source

smtp.lisp (file)

Function: send-pop-command-get-results POP COMMAND &optional EXTRAP

Package

net.post-office

Source

imap.lisp (file)

Function: smtp-command STREAM &rest FORMAT-ARGS

Package

net.post-office

Source

smtp.lisp (file)

Function: universal-time-to-rfc822-date UT

Package

net.post-office

Source

imap.lisp (file)

Function: wait-for-response STREAM

Package

net.post-office

Source

smtp.lisp (file)

4.2.4 Generic functions

Generic Function: first-unseen OBJECT

Generic Function: (setf first-unseen) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: first-unseen (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf first-unseen) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: get-and-parse-from-imap-server MB

Package

net.post-office

Methods

Method: get-and-parse-from-imap-server (MB imap-mailbox)

Source

imap.lisp (file)

Generic Function: get-and-parse-from-pop-server MB

Package

net.post-office

Methods

Method: get-and-parse-from-pop-server (MB pop-mailbox)

Source

imap.lisp (file)

Generic Function: mailbox-name OBJECT

Generic Function: (setf mailbox-name) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-name (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-name) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: mailbox-uidnext OBJECT

Generic Function: (setf mailbox-uidnext) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: mailbox-uidnext (IMAP-MAILBOX imap-mailbox)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf mailbox-uidnext) NEW-VALUE (IMAP-MAILBOX imap-mailbox)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: post-office-host OBJECT

Generic Function: (setf post-office-host) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: post-office-host (POST-OFFICE post-office)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf post-office-host) NEW-VALUE (POST-OFFICE post-office)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: post-office-socket OBJECT

Generic Function: (setf post-office-socket) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: post-office-socket (POST-OFFICE post-office)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf post-office-socket) NEW-VALUE (POST-OFFICE post-office)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: post-office-state OBJECT

Generic Function: (setf post-office-state) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: post-office-state (POST-OFFICE post-office)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf post-office-state) NEW-VALUE (POST-OFFICE post-office)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: post-office-user OBJECT

Generic Function: (setf post-office-user) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: post-office-user (POST-OFFICE post-office)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf post-office-user) NEW-VALUE (POST-OFFICE post-office)

automatically generated writer method

Source

imap.lisp (file)

Generic Function: send-command-get-results MB COMMAND UNTAGGED-HANDLER TAGGED-HANDLER

Package

net.post-office

Methods

Method: send-command-get-results (MB imap-mailbox) COMMAND UNTAGGED-HANDLER TAGGED-HANDLER

Source

imap.lisp (file)

Generic Function: timeout OBJECT

Generic Function: (setf timeout) NEW-VALUE OBJECT

Package

net.post-office

Methods

Method: timeout (POST-OFFICE post-office)

automatically generated reader method

Source

imap.lisp (file)

Method: (setf timeout) NEW-VALUE (POST-OFFICE post-office)

automatically generated writer method

Source

imap.lisp (file)

4.2.5 Classes

Class: imap-mailbox ()

Package

net.post-office

Source

imap.lisp (file)

Direct superclasses

post-office (class)

Direct methods

• get-and-parse-from-imap-server (method)
• search-mailbox (method)
• copy-to-mailbox (method)
• close-mailbox (method)
• expunge-mailbox (method)
• alter-flags (method)
• rename-mailbox (method)
• delete-mailbox (method)
• create-mailbox (method)
• mailbox-list (method)
• noop (method)
• delete-letter (method)
• fetch-parts (method)
• fetch-letter (method)
• select-mailbox (method)
• send-command-get-results (method)
• close-connection (method)
• first-unseen (method)
• first-unseen (method)
• mailbox-permanent-flags (method)
• mailbox-permanent-flags (method)
• mailbox-flags (method)
• mailbox-flags (method)
• mailbox-uidnext (method)
• mailbox-uidnext (method)
• mailbox-uidvalidity (method)
• mailbox-uidvalidity (method)
• mailbox-recent-messages (method)
• mailbox-recent-messages (method)
• mailbox-message-count (method)
• mailbox-message-count (method)
• mailbox-separator (method)
• mailbox-separator (method)
• mailbox-name (method)
• mailbox-name (method)

Direct slots

Slot: mailbox-name

Readers

mailbox-name (generic function)

Writers

(setf mailbox-name) (generic function)

Slot: separator

Initform

""

Readers

mailbox-separator (generic function)

Writers

(setf mailbox-separator) (generic function)

Slot: message-count

Initform

0

Readers

mailbox-message-count (generic function)

Writers

(setf mailbox-message-count) (generic function)

Slot: recent-messages

Initform

0

Readers

mailbox-recent-messages (generic function)

Writers

(setf mailbox-recent-messages) (generic function)

Slot: uidvalidity

Initform

0

Readers

mailbox-uidvalidity (generic function)

Writers

(setf mailbox-uidvalidity) (generic function)

Slot: uidnext

Initform

0

Readers

mailbox-uidnext (generic function)

Writers

(setf mailbox-uidnext) (generic function)

Slot: flags

Readers

mailbox-flags (generic function)

Writers

(setf mailbox-flags) (generic function)

Slot: permanent-flags

Readers

mailbox-permanent-flags (generic function)

Writers

(setf mailbox-permanent-flags) (generic function)

Slot: first-unseen

Initform

0

Readers

first-unseen (generic function)

Writers

(setf first-unseen) (generic function)

Class: pop-mailbox ()

Package

net.post-office

Source

imap.lisp (file)

Direct superclasses

post-office (class)

Direct methods

• get-and-parse-from-pop-server (method)
• top-lines (method)
• unique-id (method)
• noop (method)
• delete-letter (method)
• fetch-letter (method)
• close-connection (method)
• mailbox-message-count (method)
• mailbox-message-count (method)

Direct slots

Slot: message-count

Initform

0

Readers

mailbox-message-count (generic function)

Writers

(setf mailbox-message-count) (generic function)

Class: post-office ()

Package

net.post-office

Source

imap.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• imap-mailbox (class)
• pop-mailbox (class)

Direct methods

• timeout (method)
• timeout (method)
• post-office-state (method)
• post-office-state (method)
• post-office-user (method)
• post-office-user (method)
• post-office-host (method)
• post-office-host (method)
• post-office-socket (method)
• post-office-socket (method)

Direct slots

Slot: socket

Initargs

:socket

Readers

post-office-socket (generic function)

Writers

(setf post-office-socket) (generic function)

Slot: host

Initargs

:host

Readers

post-office-host (generic function)

Writers

(setf post-office-host) (generic function)

Slot: user

Initargs

:user

Readers

post-office-user (generic function)

Writers

(setf post-office-user) (generic function)

Slot: state

Initargs

:state

Initform

:unconnected

Readers

post-office-state (generic function)

Writers

(setf post-office-state) (generic function)

Slot: timeout

Initargs

:timeout

Initform

60

Readers

timeout (generic function)

Writers

(setf timeout) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions