The copimap Reference Manual

This is the copimap Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:12:24 2026 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 copimap

IMAP client/sync library

Author

Mihai Bazon <>

License

MIT

Version

0.0.1

Dependencies
  • usocket (system).
  • cl+ssl (system).
  • flexi-streams (system).
  • named-readtables (system).
  • trivial-utf-8 (system).
  • cl-ppcre (system).
  • bordeaux-threads (system).
  • babel (system).
  • verbose (system).
  • alexandria (system).
  • cl-dbi (system).
  • cl-fad (system).
  • uiop (system).
  • local-time (system).
  • file-attributes (system).
  • cl-date-time-parser (system).
  • cl-base64 (system).
  • anaphora (system).
Source

copimap.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 copimap/copimap.asd

Source

copimap.asd.

Parent Component

copimap (system).

ASDF Systems

copimap.


3.1.2 copimap/package.lisp

Source

copimap.asd.

Parent Component

copimap (system).

Packages
Internals

*preserve-case-readtable* (special variable).


3.1.3 copimap/parse.lisp

Dependency

package.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Internals

3.1.4 copimap/mUTF-7.lisp

Dependency

parse.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Internals

3.1.5 copimap/imap.lisp

Dependency

mutf-7.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Public Interface

initialize-instance (method).

Internals

3.1.6 copimap/mailbox.lisp

Dependency

imap.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Public Interface

initialize-instance (method).

Internals

3.1.7 copimap/store.lisp

Dependency

mailbox.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Public Interface
Internals

3.1.8 copimap/store-db.lisp

Dependency

store.lisp (file).

Source

copimap.asd.

Parent Component

copimap (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 copimap-atoms

Source

package.lisp.


4.2 copimap

Source

package.lisp.

Use List
  • anaphora.
  • common-lisp.
  • editor-hints.named-readtables.
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Standalone methods

Method: initialize-instance :after ((conn imap+mailbox) &key &allow-other-keys)
Source

mailbox.lisp.

Method: initialize-instance :after ((store maildir-store) &key &allow-other-keys)
Source

store.lisp.

Method: initialize-instance :after ((imap imap) &key &allow-other-keys)
Source

imap.lisp.

Method: initialize-instance :after ((store store) &key &allow-other-keys)
Source

store.lisp.


5.2 Internals


5.2.1 Constants

Constant: +atoms-package+
Package

copimap.

Source

parse.lisp.


5.2.2 Special variables

Special Variable: *mod-b64-chars*
Package

copimap.

Source

mutf-7.lisp.

Special Variable: *mod-b64-chars-reverse*
Package

copimap.

Source

mutf-7.lisp.

Special Variable: *preserve-case-readtable*
Package

copimap.

Source

package.lisp.


5.2.3 Macros

Macro: for-maildir-files ((dir &key filename fullname mtime flags uid) &body body)
Package

copimap.

Source

store.lisp.

Macro: when-ok (arg &body body)
Package

copimap.

Source

imap.lisp.

Macro: with-idle-resume (conn &body body)

When the connection is idling, stop IDLE mode, execute ‘body’ and then restart IDLE mode. When IDLE mode is off, just execute ‘body’.

Package

copimap.

Source

imap.lisp.

Macro: with-local-store (conn &body body)
Package

copimap.

Source

mailbox.lisp.

Macro: with-sock-lock (conn &body body)
Package

copimap.

Source

imap.lisp.

Macro: with-socket-conditions (on-error &body body)
Package

copimap.

Source

imap.lisp.


5.2.4 Ordinary functions

Function: %add-x-keywords (body keywords)
Package

copimap.

Source

store.lisp.

Function: %fix-strings (conn list)
Package

copimap.

Source

store.lisp.

Function: %maybe-arg (input)
Package

copimap.

Source

parse.lisp.

Function: %read-list (input eol-char)
Package

copimap.

Source

parse.lisp.

Function: %read-token (input &optional in-seq reqid)
Package

copimap.

Source

parse.lisp.

Function: %read-until-char (input end)
Package

copimap.

Source

parse.lisp.

Function: %skip-more-whitespace (input)
Package

copimap.

Source

parse.lisp.

Function: %skip-whitespace (input)
Package

copimap.

Source

parse.lisp.

Function: as-string (thing)
Package

copimap.

Source

parse.lisp.

Function: decode-header (header &optional flatten-only)
Package

copimap.

Source

parse.lisp.

Function: destr (conn x)
Package

copimap.

Source

imap.lisp.

Function: encode-header (str)
Package

copimap.

Source

parse.lisp.

Function: enstr (conn x)
Package

copimap.

Source

imap.lisp.

Function: envelope-message-id (envelope)
Package

copimap.

Source

store.lisp.

Function: get-header (headers name)
Package

copimap.

Source

parse.lisp.

Function: imap-new-request-id (conn handler)
Package

copimap.

Source

imap.lisp.

Function: maildir-file-suffix-from-flags (flags)
Package

copimap.

Source

store.lisp.

Function: maildir-find-message-file (store uid)

Return the current filename for the given ‘store’ and ‘uid’ (it could have moved from new/ to cur/, or it could have various flags appended).

Package

copimap.

Source

store.lisp.

Function: maildir-flags-from-file-suffix (strflags)
Package

copimap.

Source

store.lisp.

Function: maildir-import-offlineimap (path)
Package

copimap.

Source

store.lisp.

Function: make-maildir-filename (uid)
Package

copimap.

Source

store.lisp.

Function: mutf-7-to-string (wtf)
Package

copimap.

Source

mutf-7.lisp.

Function: parse-imap-cmdline (input)
Package

copimap.

Source

parse.lisp.

Function: parse-internaldate (internaldate)
Package

copimap.

Source

parse.lisp.

Function: parse-rfc822-headers (input &optional handler)
Package

copimap.

Source

parse.lisp.

Function: sql-do-all (db &rest queries)
Package

copimap.

Source

store-db.lisp.

Function: sql-row (db query &rest args)
Package

copimap.

Source

store-db.lisp.

Function: sql-single (db query &rest args)
Package

copimap.

Source

store-db.lisp.

Function: sql-table-exists (db table)
Package

copimap.

Source

store-db.lisp.

Function: store-db-filename (store)
Package

copimap.

Source

store.lisp.

Function: store-file (store file)
Package

copimap.

Source

store.lisp.

Function: store-folder (store &optional folder)
Package

copimap.

Source

store.lisp.

Function: string-to-mutf-7 (str)
Package

copimap.

Source

mutf-7.lisp.

Function: write-rfc822-headers (headers &optional output)
Package

copimap.

Source

parse.lisp.


5.2.5 Generic functions

Generic Reader: imap-bin-stream (object)
Generic Writer: (setf imap-bin-stream) (object)
Package

copimap.

Methods
Reader Method: imap-bin-stream ((imap imap))
Writer Method: (setf imap-bin-stream) ((imap imap))

The binary stream, initialized in ‘imap-connect’

Source

imap.lisp.

Target Slot

bin-stream.

Generic Reader: imap-capability (object)
Package

copimap.

Methods
Reader Method: imap-capability ((imap imap))

Filled from the server (list of uppercase strings).

Source

imap.lisp.

Target Slot

capability.

Generic Function: (setf imap-capability) (conn)
Package

copimap.

Methods
Method: (setf imap-capability) ((conn imap))
Source

imap.lisp.

Generic Function: imap-close (imap)

Close the connection

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-close ((conn imap))
Generic Reader: imap-cmdqueue (object)
Generic Writer: (setf imap-cmdqueue) (object)
Package

copimap.

Methods
Reader Method: imap-cmdqueue ((imap imap))
Writer Method: (setf imap-cmdqueue) ((imap imap))

Handlers for commands awaiting replies.

Source

imap.lisp.

Target Slot

cmdqueue.

Generic Reader: imap-cmdseq (object)
Generic Writer: (setf imap-cmdseq) (object)
Package

copimap.

Methods
Reader Method: imap-cmdseq ((imap imap))
Writer Method: (setf imap-cmdseq) ((imap imap))

Current request id, incremented on each ‘imap-command’.

Source

imap.lisp.

Target Slot

cmdseq.

Generic Function: imap-command (imap cmd &optional handler)

Send a command to the IMAP server. The function returns immediately, and ‘handler’ will be invoked from the read thread when a tagged response comes back. See the documentation of the available methods; the most useful one is where ‘cmd’ is a list.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-command :around ((conn imap) cmd &optional handler)

Wrapper around ‘imap-command’ which turns off IDLE mode.

Method: imap-command :before ((conn imap) cmd &optional handler)
Method: imap-command ((conn imap) (cmd cons) &optional handler)

Send a command to the server. The command will be assembled from ‘cmd’, which should be a list. A few examples:

(imap-command imap ’(:list "" "*"))
(imap-command imap ’(:select inbox))
(imap-command imap ’(:uid :fetch (:range 1 5) (flags envelope))) (imap-command imap ’(:uid :fetch 1 (flags envelope (:binary.peek 1))))

Symbols will be sent as IMAP atoms; they don’t have to be keywords, but some keywords are treated specially:

(:range 1 5) -> 1:5
(:range 10 :*) -> 10:*
(:seq 1 3 5 6) -> 1,3,5,6

You can mix :seq and :range:

(:seq 1 (:range 5 10) 15) -> 1,5:10,15

You should wrap in (:astr ...) strings/symbols which might need to be mUTF-7 encoded, like mailbox names or flags.

The following are converted to the form BODY[1.1], used in FETCH commands; examples:

(:body) -> BODY[]
(:body 1 1) -> BODY[1.1]
(:binary 1) -> BINARY[1]
(:body.peek ...)
(:binary.peek ...)
(:binary.size ...)

Peculiarities of the protocol require us to write these arguments one by one, rather than assemble a full command in a string and write it at once. For example, some data may be binary (e.g. if you pass
a (vector (unsigned-byte 8))), and this requires writing to the binary stream. Or, depending on server capability (or lack thereof) we might need to send synchronizing literals (https://www.rfc-editor.org/rfc/rfc9051#name-string) which requires us to wait for a continuation request from the server. The mutex will be held until we encode the whole command and force output.

If you pass ‘handler’, it must be a function of at least one argument, but more can be sent for specific commands (e.g. SEARCH), so your handler should be prepared to accept (but not require) more than one argument. The handler will be called from the read loop thread when the server sends us a tagged response which includes the current request ID. The argument will be a list where the first item will be ‘$OK’ (symbol OK in the ‘+atoms-package+’) if the command was successful.

Various data requested by your command may come before your handler is called, via untagged notifications, for which the read loop will invoke ‘imap-handle’.

Method: imap-command ((conn imap) (cmd symbol) &optional handler)
Method: imap-command ((conn imap) (cmdstr string) &optional handler)

Send a raw command. Use this for simple commands, or if you know what you’re doing.

Generic Function: imap-command-sync (imap cmdstr &optional handler)

Synchronously execute command. This holds the mutex and parses server output until a tagged response for our command comes back (at which point ‘handler’ will be invoked with the argument). Note that you cannot use this for the IDLE command (there won’t be a tagged answer until you send DONE).

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-command-sync ((conn imap) cmd &optional handler)
Generic Function: imap-connect (imap)

Starts the IMAP connection. After successful authentication the read loop thread is started. Returns T on success.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-connect ((conn imap))
Generic Function: imap-handle (imap cmd arg)

Will be invoked by ‘imap-parse’ for untagged notification. ‘cmd’ is the notification label as a copimap symbol (e.g. $FETCH, $EXISTS etc.) and ‘arg’ contains whatever arguments were sent.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-handle ((conn imap+mailbox) (cmd (eql copimap-atoms::fetch)) arg)
Source

mailbox.lisp.

Method: imap-handle ((conn imap+mailbox) (cmd (eql copimap-atoms::recent)) arg)
Source

mailbox.lisp.

Method: imap-handle ((conn imap+mailbox) (cmd (eql copimap-atoms::exists)) arg)
Source

mailbox.lisp.

Method: imap-handle ((conn imap+mailbox) (cmd (eql copimap-atoms::flags)) arg)
Source

mailbox.lisp.

Method: imap-handle ((conn imap+mailbox) (cmd (eql copimap-atoms::ok)) arg)
Source

mailbox.lisp.

Method: imap-handle ((conn imap) cmd arg)
Method: imap-handle ((conn imap) (cmd (eql copimap-atoms::esearch)) arg)

The ESEARCH handler collects the argument, so that it can be passed to the handler when the command is done.

https://www.ietf.org/rfc/rfc9051.html#name-esearch-response

Method: imap-handle ((conn imap) (cmd (eql copimap-atoms::bye)) arg)

The BYE handler will close the socket.

Method: imap-handle ((conn imap) (cmd (eql copimap-atoms::no)) arg)
Method: imap-handle ((conn imap) (cmd (eql copimap-atoms::capability)) arg)
Method: imap-handle ((conn imap) (cmd (eql copimap-atoms::ok)) arg)

The default handler for untagged OK notifications. Sets ‘imap-capability’ if CAPABILITY is present in the argument (Dovecot does that).

Generic Function: imap-has-capability (imap capability)

Checks if the server advertises the ‘cap’ capability (should be a keyword symbol).

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-has-capability ((conn imap) (cap symbol))
Generic Reader: imap-host (object)
Generic Writer: (setf imap-host) (object)
Package

copimap.

Methods
Reader Method: imap-host ((imap imap))
Writer Method: (setf imap-host) ((imap imap))

IMAP server hostname

Source

imap.lisp.

Target Slot

host.

Generic Reader: imap-idling (object)
Generic Writer: (setf imap-idling) (object)
Package

copimap.

Methods
Reader Method: imap-idling ((imap imap))
Writer Method: (setf imap-idling) ((imap imap))

Used internally to keep track of wether an IDLE command is in progress. See ‘imap-start-idle’.

Source

imap.lisp.

Target Slot

idling.

Generic Reader: imap-last-command-time (object)
Generic Writer: (setf imap-last-command-time) (object)
Package

copimap.

Methods
Reader Method: imap-last-command-time ((imap imap))
Writer Method: (setf imap-last-command-time) ((imap imap))

Used internally for polling (keeps track of last command time).

Source

imap.lisp.

Target Slot

last-command-time.

Generic Function: imap-maybe-reconnect (conn)
Package

copimap.

Methods
Method: imap-maybe-reconnect ((conn imap))
Source

imap.lisp.

Generic Function: imap-on-connect (imap)

Will be invoked after successful authentication. Could be useful in subclasses, for example to re-SELECT the appropriate mailbox.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-on-connect ((conn imap+mailbox))
Source

mailbox.lisp.

Method: imap-on-connect ((conn imap))
Generic Function: imap-parse (imap)

Parse one command line from the server. Invokes ‘imap-handle’ for untagged notifications. On tagged responses it invokes the associated handler from ‘imap-cmdqueue’, if found.

The command line, as returned by ‘parse-imap-cmdline’, is a list of tokens (similar to the ones that you send to ‘imap-command’). The first is ‘:untagged’ for notifications or ‘:continue’ for continuation requests, otherwise it’s a request ID followed by return value.

IMAP atoms are similar to Lisp symbols, so they are parsed as such, and interned into ‘+atoms-package+’ (COPIMAP-ATOMS). Note that the reader syntax in ‘COPIMAP’ defines a custom reader for $ which interns symbols in ‘+atoms-package+’. This reader is case sensitive, so symbol ‘$OK’ will be different from ‘$ok’.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-parse ((conn imap))
Generic Reader: imap-password (object)
Package

copimap.

Methods
Reader Method: imap-password ((conn imap))
Source

imap.lisp.

Target Slot

password.

Generic Writer: (setf imap-password) (object)
Package

copimap.

Methods
Writer Method: (setf imap-password) ((imap imap))

IMAP user password. Pass either the raw password as string, or a list to invoke an external program (should write the password to standard output). External programs are run via ‘uiop:run-program’. If the form is (:shell "command") then we’ll pass :force-shell T.

Source

imap.lisp.

Target Slot

password.

Generic Reader: imap-poll-time (object)
Generic Writer: (setf imap-poll-time) (object)
Package

copimap.

Methods
Reader Method: imap-poll-time ((imap imap))
Writer Method: (setf imap-poll-time) ((imap imap))

If non-NIL, the read loop will send NOOP commands every so many seconds. Default is 20 minutes.

Source

imap.lisp.

Target Slot

poll-time.

Generic Reader: imap-port (object)
Generic Writer: (setf imap-port) (object)
Package

copimap.

Methods
Reader Method: imap-port ((imap imap))
Writer Method: (setf imap-port) ((imap imap))

Server port. Will default to 143 or 993, depending on the value of ‘use-ssl’.

Source

imap.lisp.

Target Slot

port.

Generic Function: imap-read-loop (imap)
Package

copimap.

Source

imap.lisp.

Methods
Method: imap-read-loop ((conn imap))
Generic Reader: imap-reconnect (object)
Generic Writer: (setf imap-reconnect) (object)
Package

copimap.

Methods
Reader Method: imap-reconnect ((imap imap))
Writer Method: (setf imap-reconnect) ((imap imap))

Wether to attempt reconnecting when the socket is closed. See ‘imap-maybe-reconnect’.

Source

imap.lisp.

Target Slot

reconnect.

Generic Reader: imap-running (object)
Generic Writer: (setf imap-running) (object)
Package

copimap.

Methods
Reader Method: imap-running ((imap imap))
Writer Method: (setf imap-running) ((imap imap))

The read loop will continue as long as this remains T.

Source

imap.lisp.

Target Slot

running.

Generic Reader: imap-sock (object)
Generic Writer: (setf imap-sock) (object)
Package

copimap.

Methods
Reader Method: imap-sock ((imap imap))
Writer Method: (setf imap-sock) ((imap imap))

The main connection, initialized in ‘imap-connect’ (‘usocket’)

Source

imap.lisp.

Target Slot

sock.

Generic Reader: imap-sock-lock (object)
Generic Writer: (setf imap-sock-lock) (object)
Package

copimap.

Methods
Reader Method: imap-sock-lock ((imap imap))
Writer Method: (setf imap-sock-lock) ((imap imap))

Mutex that will be held on reading/writing from the streams.

Source

imap.lisp.

Target Slot

sock-lock.

Generic Function: imap-start-idle (imap &optional handler)

Enter IDLE mode. While idling the server can send notifications which will be handled by the read loop thread via ‘imap-parse’. Sending any ‘imap-command’ while a connection is idling will automatically stop IDLE mode, and resume it back after sending the command. See also macro ‘with-idle-resume’.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-start-idle ((conn imap) &optional handler)
Generic Function: imap-start-read-loop (imap)
Package

copimap.

Source

imap.lisp.

Methods
Method: imap-start-read-loop ((conn imap))
Generic Function: imap-stop-idle (imap)

Ends IDLE mode.

Package

copimap.

Source

imap.lisp.

Methods
Method: imap-stop-idle ((conn imap))
Generic Reader: imap-text-stream (object)
Generic Writer: (setf imap-text-stream) (object)
Package

copimap.

Methods
Reader Method: imap-text-stream ((imap imap))
Writer Method: (setf imap-text-stream) ((imap imap))

The text stream (a ‘flexi-stream’)

Source

imap.lisp.

Target Slot

text-stream.

Generic Reader: imap-thread (object)
Generic Writer: (setf imap-thread) (object)
Package

copimap.

Methods
Reader Method: imap-thread ((imap imap))
Writer Method: (setf imap-thread) ((imap imap))

The read loop thread.

Source

imap.lisp.

Target Slot

thread.

Generic Reader: imap-use-ssl (object)
Generic Writer: (setf imap-use-ssl) (object)
Package

copimap.

Methods
Reader Method: imap-use-ssl ((imap imap))
Writer Method: (setf imap-use-ssl) ((imap imap))

Pass T to use SSL (default), ‘:STARTTLS’ or ‘:nope-just-send-my-password-in-clear-text’. Note that for ‘:STARTTLS’ we require the server to advertise the ‘STARTTLS’ capability; login will not be attempted over plain text.

Source

imap.lisp.

Target Slot

use-ssl.

Generic Reader: imap-user (object)
Generic Writer: (setf imap-user) (object)
Package

copimap.

Methods
Reader Method: imap-user ((imap imap))
Writer Method: (setf imap-user) ((imap imap))

IMAP username

Source

imap.lisp.

Target Slot

user.

Generic Reader: imap-utf-7 (object)
Package

copimap.

Methods
Reader Method: imap-utf-7 ((imap imap))

Whether we should do mUTF-7 conversion for ASTRING-s. Will be set when we receive capabilities if IMAP4rev1 is advertised.

Source

imap.lisp.

Target Slot

utf-7.

Generic Function: imap-write (imap str)
Package

copimap.

Source

imap.lisp.

Methods
Method: imap-write ((conn imap) (data string))
Generic Reader: mailbox-exists (object)
Package

copimap.

Methods
Reader Method: mailbox-exists ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

exists.

Generic Writer: (setf mailbox-exists) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-exists) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

exists.

Generic Function: mailbox-fetch (mailbox uids &optional handler)
Package

copimap.

Source

mailbox.lisp.

Methods
Method: mailbox-fetch ((conn imap+mailbox) uids &optional handler)
Generic Function: mailbox-fetch-changedsince (mailbox &optional handler)
Package

copimap.

Source

mailbox.lisp.

Methods
Method: mailbox-fetch-changedsince ((conn imap+mailbox) &optional handler)
Generic Function: mailbox-fetch-new (mailbox &optional handler)
Package

copimap.

Source

mailbox.lisp.

Methods
Method: mailbox-fetch-new ((conn imap+mailbox) &optional handler)
Generic Function: mailbox-fetch-remote-changes (mailbox)
Package

copimap.

Source

mailbox.lisp.

Generic Reader: mailbox-flags (object)
Package

copimap.

Methods
Reader Method: mailbox-flags ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

flags.

Generic Writer: (setf mailbox-flags) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-flags) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

flags.

Generic Reader: mailbox-gmail (object)
Package

copimap.

Methods
Reader Method: mailbox-gmail ((imap+mailbox imap+mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

gmail.

Generic Writer: (setf mailbox-gmail) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-gmail) ((imap+mailbox imap+mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

gmail.

Generic Reader: mailbox-highestmodseq (object)
Package

copimap.

Methods
Reader Method: mailbox-highestmodseq ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

highestmodseq.

Generic Writer: (setf mailbox-highestmodseq) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-highestmodseq) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

highestmodseq.

Generic Reader: mailbox-local-store (object)
Package

copimap.

Methods
Reader Method: mailbox-local-store ((imap+mailbox imap+mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

local-store.

Generic Writer: (setf mailbox-local-store) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-local-store) ((imap+mailbox imap+mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

local-store.

Generic Function: mailbox-local-store-directory (mailbox)
Package

copimap.

Source

mailbox.lisp.

Methods
Method: mailbox-local-store-directory ((conn imap+mailbox))
Generic Reader: mailbox-name (object)
Package

copimap.

Methods
Reader Method: mailbox-name ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

mailbox-name.

Generic Writer: (setf mailbox-name) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-name) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

mailbox-name.

Generic Reader: mailbox-permanent-flags (object)
Package

copimap.

Methods
Reader Method: mailbox-permanent-flags ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

permanent-flags.

Generic Writer: (setf mailbox-permanent-flags) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-permanent-flags) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

permanent-flags.

Generic Function: mailbox-push-local-changes (conn)
Package

copimap.

Methods
Method: mailbox-push-local-changes ((conn imap+mailbox))
Source

mailbox.lisp.

Generic Reader: mailbox-recent (object)
Package

copimap.

Methods
Reader Method: mailbox-recent ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

recent.

Generic Writer: (setf mailbox-recent) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-recent) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

recent.

Generic Reader: mailbox-uidnext (object)
Package

copimap.

Methods
Reader Method: mailbox-uidnext ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

uidnext.

Generic Writer: (setf mailbox-uidnext) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-uidnext) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

uidnext.

Generic Reader: mailbox-uidvalidity (object)
Package

copimap.

Methods
Reader Method: mailbox-uidvalidity ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

uidvalidity.

Generic Writer: (setf mailbox-uidvalidity) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-uidvalidity) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

uidvalidity.

Generic Reader: mailbox-unseen (object)
Package

copimap.

Methods
Reader Method: mailbox-unseen ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

unseen.

Generic Writer: (setf mailbox-unseen) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-unseen) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

unseen.

Generic Reader: mailbox-valid (object)
Package

copimap.

Methods
Reader Method: mailbox-valid ((mailbox mailbox))

automatically generated reader method

Source

mailbox.lisp.

Target Slot

valid.

Generic Writer: (setf mailbox-valid) (object)
Package

copimap.

Methods
Writer Method: (setf mailbox-valid) ((mailbox mailbox))

automatically generated writer method

Source

mailbox.lisp.

Target Slot

valid.

Generic Function: maildir-make-filename (store uid envelope)
Package

copimap.

Source

store.lisp.

Methods
Method: maildir-make-filename ((store maildir-store) uid envelope)
Generic Reader: q-add-flags (object)
Package

copimap.

Methods
Reader Method: q-add-flags ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-add-flags.

Generic Writer: (setf q-add-flags) (object)
Package

copimap.

Methods
Writer Method: (setf q-add-flags) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-add-flags.

Generic Reader: q-add-labels (object)
Package

copimap.

Methods
Reader Method: q-add-labels ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-add-labels.

Generic Writer: (setf q-add-labels) (object)
Package

copimap.

Methods
Writer Method: (setf q-add-labels) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-add-labels.

Generic Reader: q-del-flags (object)
Package

copimap.

Methods
Reader Method: q-del-flags ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-del-flags.

Generic Writer: (setf q-del-flags) (object)
Package

copimap.

Methods
Writer Method: (setf q-del-flags) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-del-flags.

Generic Reader: q-del-labels (object)
Package

copimap.

Methods
Reader Method: q-del-labels ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-del-labels.

Generic Writer: (setf q-del-labels) (object)
Package

copimap.

Methods
Writer Method: (setf q-del-labels) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-del-labels.

Generic Reader: q-del-message (object)
Package

copimap.

Methods
Reader Method: q-del-message ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-del-message.

Generic Writer: (setf q-del-message) (object)
Package

copimap.

Methods
Writer Method: (setf q-del-message) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-del-message.

Generic Reader: q-get-flags (object)
Package

copimap.

Methods
Reader Method: q-get-flags ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-get-flags.

Generic Writer: (setf q-get-flags) (object)
Package

copimap.

Methods
Writer Method: (setf q-get-flags) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-get-flags.

Generic Reader: q-get-labels (object)
Package

copimap.

Methods
Reader Method: q-get-labels ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-get-labels.

Generic Writer: (setf q-get-labels) (object)
Package

copimap.

Methods
Writer Method: (setf q-get-labels) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-get-labels.

Generic Reader: q-get-metadata (object)
Package

copimap.

Methods
Reader Method: q-get-metadata ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-get-metadata.

Generic Writer: (setf q-get-metadata) (object)
Package

copimap.

Methods
Writer Method: (setf q-get-metadata) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-get-metadata.

Generic Reader: q-insert-message (object)
Package

copimap.

Methods
Reader Method: q-insert-message ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-insert-message.

Generic Writer: (setf q-insert-message) (object)
Package

copimap.

Methods
Writer Method: (setf q-insert-message) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-insert-message.

Generic Reader: q-set-encountered (object)
Package

copimap.

Methods
Reader Method: q-set-encountered ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-set-encountered.

Generic Writer: (setf q-set-encountered) (object)
Package

copimap.

Methods
Writer Method: (setf q-set-encountered) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-set-encountered.

Generic Reader: q-set-metadata (object)
Package

copimap.

Methods
Reader Method: q-set-metadata ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

q-set-metadata.

Generic Writer: (setf q-set-metadata) (object)
Package

copimap.

Methods
Writer Method: (setf q-set-metadata) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

q-set-metadata.

Generic Reader: store-db (object)
Package

copimap.

Methods
Reader Method: store-db ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

db.

Generic Writer: (setf store-db) (object)
Package

copimap.

Methods
Writer Method: (setf store-db) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

db.

Generic Function: store-find-local-changes (store)
Package

copimap.

Source

store.lisp.

Methods
Method: store-find-local-changes ((store maildir-store))
Generic Function: store-get-by-path (store path)
Package

copimap.

Source

store.lisp.

Methods
Method: store-get-by-path ((store store) path)
Generic Function: store-get-by-uid (store uid)
Package

copimap.

Source

store.lisp.

Methods
Method: store-get-by-uid ((store store) uid)
Generic Function: store-get-flags (store uid)
Package

copimap.

Methods
Method: store-get-flags ((store store) uid)
Source

store.lisp.

Generic Function: store-get-labels (store uid)
Package

copimap.

Methods
Method: store-get-labels ((store store) uid)
Source

store.lisp.

Generic Function: store-get-last-uid (store)
Package

copimap.

Source

store.lisp.

Methods
Method: store-get-last-uid ((store store))
Generic Function: store-get-metadata (store key)
Package

copimap.

Source

store.lisp.

Methods
Method: store-get-metadata ((store store) (key symbol))
Method: store-get-metadata ((store store) (key string))
Generic Function: store-insert-message (store &key uid local-uid path internaldate message-id mtime flags labels)
Package

copimap.

Methods
Method: store-insert-message ((store store) &key uid local-uid path internaldate message-id mtime flags labels)
Source

store.lisp.

Generic Reader: store-path (object)
Package

copimap.

Methods
Reader Method: store-path ((store store))

automatically generated reader method

Source

store.lisp.

Target Slot

path.

Generic Writer: (setf store-path) (object)
Package

copimap.

Methods
Writer Method: (setf store-path) ((store store))

automatically generated writer method

Source

store.lisp.

Target Slot

path.

Generic Function: store-save-mailbox (store mailbox)
Package

copimap.

Source

store.lisp.

Methods
Method: store-save-mailbox ((store store) (mailbox mailbox))
Generic Function: store-save-messages (store imap messages)
Package

copimap.

Source

store.lisp.

Methods
Method: store-save-messages ((store maildir-store) (conn imap) messages)
Generic Function: store-set-flags (store uid flags)
Package

copimap.

Methods
Method: store-set-flags ((store store) uid flags)
Source

store.lisp.

Generic Function: store-set-labels (store uid labels)
Package

copimap.

Methods
Method: store-set-labels ((store store) uid labels)
Source

store.lisp.

Generic Function: store-set-metadata (store key &key intval txtval binval &allow-other-keys)
Package

copimap.

Source

store.lisp.

Methods
Method: store-set-metadata ((store store) (key symbol) &rest args &key &allow-other-keys)
Method: store-set-metadata ((store store) (key string) &key intval txtval binval)
Generic Function: store-update-for-changes (store changes)
Package

copimap.

Methods
Method: store-update-for-changes ((store maildir-store) changes)
Source

store.lisp.

Generic Function: store-upgrade-db (store version)
Package

copimap.

Source

store-db.lisp.

Methods
Method: store-upgrade-db ((store store) (version (eql 0)))
Method: store-upgrade-db ((store store) version)
Method: store-upgrade-db ((store store) (version (eql nil)))

5.2.6 Classes

Class: imap

Low-level IMAP class.

Supports plain authentication, sending commands and receiving output.

IMAP is a fully asynchronous protocol, in that when you request some data, the server will send results in the form of untagged notifications that can’t always be reliably linked to your request. The ‘imap-connect’ method will start a thread that continuously parses input from the server via ‘imap-parse’, which see. Use ‘imap-command’ to send commands to the IMAP server, and specialize ‘imap-handle’ in your own subclasses in order to retrieve results from the server.

Package

copimap.

Source

imap.lisp.

Direct subclasses

imap+mailbox.

Direct methods
Direct slots
Slot: host

IMAP server hostname

Initargs

:host

Readers

imap-host.

Writers

(setf imap-host).

Slot: user

IMAP username

Initargs

:user

Readers

imap-user.

Writers

(setf imap-user).

Slot: password

IMAP user password. Pass either the raw password as string, or a list to invoke an external program (should write the password to standard output). External programs are run via ‘uiop:run-program’. If the form is (:shell "command") then we’ll pass :force-shell T.

Initargs

:password

Readers

imap-password.

Writers

(setf imap-password).

Slot: use-ssl

Pass T to use SSL (default), ‘:STARTTLS’ or ‘:nope-just-send-my-password-in-clear-text’. Note that for ‘:STARTTLS’ we require the server to advertise the ‘STARTTLS’ capability; login will not be attempted over plain text.

Initform

t

Initargs

:use-ssl

Readers

imap-use-ssl.

Writers

(setf imap-use-ssl).

Slot: port

Server port. Will default to 143 or 993, depending on the value of ‘use-ssl’.

Initargs

:port

Readers

imap-port.

Writers

(setf imap-port).

Slot: capability

Filled from the server (list of uppercase strings).

Readers

imap-capability.

Writers

This slot is read-only.

Slot: sock

The main connection, initialized in ‘imap-connect’ (‘usocket’)

Readers

imap-sock.

Writers

(setf imap-sock).

Slot: bin-stream

The binary stream, initialized in ‘imap-connect’

Readers

imap-bin-stream.

Writers

(setf imap-bin-stream).

Slot: text-stream

The text stream (a ‘flexi-stream’)

Readers

imap-text-stream.

Writers

(setf imap-text-stream).

Slot: cmdseq

Current request id, incremented on each ‘imap-command’.

Initform

0

Readers

imap-cmdseq.

Writers

(setf imap-cmdseq).

Slot: cmdqueue

Handlers for commands awaiting replies.

Initform

(make-hash-table :test (quote equal))

Readers

imap-cmdqueue.

Writers

(setf imap-cmdqueue).

Slot: sock-lock

Mutex that will be held on reading/writing from the streams.

Readers

imap-sock-lock.

Writers

(setf imap-sock-lock).

Slot: thread

The read loop thread.

Readers

imap-thread.

Writers

(setf imap-thread).

Slot: running

The read loop will continue as long as this remains T.

Readers

imap-running.

Writers

(setf imap-running).

Slot: reconnect

Wether to attempt reconnecting when the socket is closed. See ‘imap-maybe-reconnect’.

Initform

t

Readers

imap-reconnect.

Writers

(setf imap-reconnect).

Slot: idling

Used internally to keep track of wether an IDLE command is in progress. See ‘imap-start-idle’.

Readers

imap-idling.

Writers

(setf imap-idling).

Slot: poll-time

If non-NIL, the read loop will send NOOP commands every so many seconds. Default is 20 minutes.

Initform

1200

Initargs

:poll-time

Readers

imap-poll-time.

Writers

(setf imap-poll-time).

Slot: last-command-time

Used internally for polling (keeps track of last command time).

Readers

imap-last-command-time.

Writers

(setf imap-last-command-time).

Slot: utf-7

Whether we should do mUTF-7 conversion for ASTRING-s. Will be set when we receive capabilities if IMAP4rev1 is advertised.

Readers

imap-utf-7.

Writers

This slot is read-only.

Class: imap+mailbox
Package

copimap.

Source

mailbox.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: local-store
Initargs

:local-store

Readers

mailbox-local-store.

Writers

(setf mailbox-local-store).

Slot: gmail
Readers

mailbox-gmail.

Writers

(setf mailbox-gmail).

Class: mailbox
Package

copimap.

Source

mailbox.lisp.

Direct subclasses

imap+mailbox.

Direct methods
Direct slots
Slot: mailbox-name
Initargs

:mailbox-name

Readers

mailbox-name.

Writers

(setf mailbox-name).

Slot: permanent-flags
Initargs

:permanent-flags

Readers

mailbox-permanent-flags.

Writers

(setf mailbox-permanent-flags).

Slot: flags
Initargs

:flags

Readers

mailbox-flags.

Writers

(setf mailbox-flags).

Slot: exists
Initform

0

Initargs

:exists

Readers

mailbox-exists.

Writers

(setf mailbox-exists).

Slot: recent
Initform

0

Initargs

:recent

Readers

mailbox-recent.

Writers

(setf mailbox-recent).

Slot: unseen
Initform

0

Initargs

:unseen

Readers

mailbox-unseen.

Writers

(setf mailbox-unseen).

Slot: uidvalidity
Initargs

:uidvalidity

Readers

mailbox-uidvalidity.

Writers

(setf mailbox-uidvalidity).

Slot: uidnext
Initform

0

Initargs

:uidnext

Readers

mailbox-uidnext.

Writers

(setf mailbox-uidnext).

Slot: highestmodseq
Initform

0

Initargs

:highestmodseq

Readers

mailbox-highestmodseq.

Writers

(setf mailbox-highestmodseq).

Slot: valid
Readers

mailbox-valid.

Writers

(setf mailbox-valid).

Class: maildir-store
Package

copimap.

Source

store.lisp.

Direct superclasses

store.

Direct methods
Class: store
Package

copimap.

Source

store.lisp.

Direct subclasses

maildir-store.

Direct methods
Direct slots
Slot: path
Initargs

:path

Readers

store-path.

Writers

(setf store-path).

Slot: db
Readers

store-db.

Writers

(setf store-db).

Slot: q-insert-message
Readers

q-insert-message.

Writers

(setf q-insert-message).

Slot: q-del-message
Readers

q-del-message.

Writers

(setf q-del-message).

Slot: q-add-flags
Readers

q-add-flags.

Writers

(setf q-add-flags).

Slot: q-del-flags
Readers

q-del-flags.

Writers

(setf q-del-flags).

Slot: q-get-flags
Readers

q-get-flags.

Writers

(setf q-get-flags).

Slot: q-add-labels
Readers

q-add-labels.

Writers

(setf q-add-labels).

Slot: q-del-labels
Readers

q-del-labels.

Writers

(setf q-del-labels).

Slot: q-get-labels
Readers

q-get-labels.

Writers

(setf q-get-labels).

Slot: q-set-encountered
Readers

q-set-encountered.

Writers

(setf q-set-encountered).

Slot: q-get-metadata
Readers

q-get-metadata.

Writers

(setf q-get-metadata).

Slot: q-set-metadata
Readers

q-set-metadata.

Writers

(setf q-set-metadata).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   D   E   F   G   I   M   P   Q   S   W  
Index Entry  Section

%
%add-x-keywords: Private ordinary functions
%fix-strings: Private ordinary functions
%maybe-arg: Private ordinary functions
%read-list: Private ordinary functions
%read-token: Private ordinary functions
%read-until-char: Private ordinary functions
%skip-more-whitespace: Private ordinary functions
%skip-whitespace: Private ordinary functions

(
(setf imap-bin-stream): Private generic functions
(setf imap-bin-stream): Private generic functions
(setf imap-capability): Private generic functions
(setf imap-capability): Private generic functions
(setf imap-cmdqueue): Private generic functions
(setf imap-cmdqueue): Private generic functions
(setf imap-cmdseq): Private generic functions
(setf imap-cmdseq): Private generic functions
(setf imap-host): Private generic functions
(setf imap-host): Private generic functions
(setf imap-idling): Private generic functions
(setf imap-idling): Private generic functions
(setf imap-last-command-time): Private generic functions
(setf imap-last-command-time): Private generic functions
(setf imap-password): Private generic functions
(setf imap-password): Private generic functions
(setf imap-poll-time): Private generic functions
(setf imap-poll-time): Private generic functions
(setf imap-port): Private generic functions
(setf imap-port): Private generic functions
(setf imap-reconnect): Private generic functions
(setf imap-reconnect): Private generic functions
(setf imap-running): Private generic functions
(setf imap-running): Private generic functions
(setf imap-sock): Private generic functions
(setf imap-sock): Private generic functions
(setf imap-sock-lock): Private generic functions
(setf imap-sock-lock): Private generic functions
(setf imap-text-stream): Private generic functions
(setf imap-text-stream): Private generic functions
(setf imap-thread): Private generic functions
(setf imap-thread): Private generic functions
(setf imap-use-ssl): Private generic functions
(setf imap-use-ssl): Private generic functions
(setf imap-user): Private generic functions
(setf imap-user): Private generic functions
(setf mailbox-exists): Private generic functions
(setf mailbox-exists): Private generic functions
(setf mailbox-flags): Private generic functions
(setf mailbox-flags): Private generic functions
(setf mailbox-gmail): Private generic functions
(setf mailbox-gmail): Private generic functions
(setf mailbox-highestmodseq): Private generic functions
(setf mailbox-highestmodseq): Private generic functions
(setf mailbox-local-store): Private generic functions
(setf mailbox-local-store): Private generic functions
(setf mailbox-name): Private generic functions
(setf mailbox-name): Private generic functions
(setf mailbox-permanent-flags): Private generic functions
(setf mailbox-permanent-flags): Private generic functions
(setf mailbox-recent): Private generic functions
(setf mailbox-recent): Private generic functions
(setf mailbox-uidnext): Private generic functions
(setf mailbox-uidnext): Private generic functions
(setf mailbox-uidvalidity): Private generic functions
(setf mailbox-uidvalidity): Private generic functions
(setf mailbox-unseen): Private generic functions
(setf mailbox-unseen): Private generic functions
(setf mailbox-valid): Private generic functions
(setf mailbox-valid): Private generic functions
(setf q-add-flags): Private generic functions
(setf q-add-flags): Private generic functions
(setf q-add-labels): Private generic functions
(setf q-add-labels): Private generic functions
(setf q-del-flags): Private generic functions
(setf q-del-flags): Private generic functions
(setf q-del-labels): Private generic functions
(setf q-del-labels): Private generic functions
(setf q-del-message): Private generic functions
(setf q-del-message): Private generic functions
(setf q-get-flags): Private generic functions
(setf q-get-flags): Private generic functions
(setf q-get-labels): Private generic functions
(setf q-get-labels): Private generic functions
(setf q-get-metadata): Private generic functions
(setf q-get-metadata): Private generic functions
(setf q-insert-message): Private generic functions
(setf q-insert-message): Private generic functions
(setf q-set-encountered): Private generic functions
(setf q-set-encountered): Private generic functions
(setf q-set-metadata): Private generic functions
(setf q-set-metadata): Private generic functions
(setf store-db): Private generic functions
(setf store-db): Private generic functions
(setf store-path): Private generic functions
(setf store-path): Private generic functions

A
as-string: Private ordinary functions

D
decode-header: Private ordinary functions
destr: Private ordinary functions

E
encode-header: Private ordinary functions
enstr: Private ordinary functions
envelope-message-id: Private ordinary functions

F
for-maildir-files: Private macros
Function, %add-x-keywords: Private ordinary functions
Function, %fix-strings: Private ordinary functions
Function, %maybe-arg: Private ordinary functions
Function, %read-list: Private ordinary functions
Function, %read-token: Private ordinary functions
Function, %read-until-char: Private ordinary functions
Function, %skip-more-whitespace: Private ordinary functions
Function, %skip-whitespace: Private ordinary functions
Function, as-string: Private ordinary functions
Function, decode-header: Private ordinary functions
Function, destr: Private ordinary functions
Function, encode-header: Private ordinary functions
Function, enstr: Private ordinary functions
Function, envelope-message-id: Private ordinary functions
Function, get-header: Private ordinary functions
Function, imap-new-request-id: Private ordinary functions
Function, maildir-file-suffix-from-flags: Private ordinary functions
Function, maildir-find-message-file: Private ordinary functions
Function, maildir-flags-from-file-suffix: Private ordinary functions
Function, maildir-import-offlineimap: Private ordinary functions
Function, make-maildir-filename: Private ordinary functions
Function, mutf-7-to-string: Private ordinary functions
Function, parse-imap-cmdline: Private ordinary functions
Function, parse-internaldate: Private ordinary functions
Function, parse-rfc822-headers: Private ordinary functions
Function, sql-do-all: Private ordinary functions
Function, sql-row: Private ordinary functions
Function, sql-single: Private ordinary functions
Function, sql-table-exists: Private ordinary functions
Function, store-db-filename: Private ordinary functions
Function, store-file: Private ordinary functions
Function, store-folder: Private ordinary functions
Function, string-to-mutf-7: Private ordinary functions
Function, write-rfc822-headers: Private ordinary functions

G
Generic Function, (setf imap-bin-stream): Private generic functions
Generic Function, (setf imap-capability): Private generic functions
Generic Function, (setf imap-cmdqueue): Private generic functions
Generic Function, (setf imap-cmdseq): Private generic functions
Generic Function, (setf imap-host): Private generic functions
Generic Function, (setf imap-idling): Private generic functions
Generic Function, (setf imap-last-command-time): Private generic functions
Generic Function, (setf imap-password): Private generic functions
Generic Function, (setf imap-poll-time): Private generic functions
Generic Function, (setf imap-port): Private generic functions
Generic Function, (setf imap-reconnect): Private generic functions
Generic Function, (setf imap-running): Private generic functions
Generic Function, (setf imap-sock): Private generic functions
Generic Function, (setf imap-sock-lock): Private generic functions
Generic Function, (setf imap-text-stream): Private generic functions
Generic Function, (setf imap-thread): Private generic functions
Generic Function, (setf imap-use-ssl): Private generic functions
Generic Function, (setf imap-user): Private generic functions
Generic Function, (setf mailbox-exists): Private generic functions
Generic Function, (setf mailbox-flags): Private generic functions
Generic Function, (setf mailbox-gmail): Private generic functions
Generic Function, (setf mailbox-highestmodseq): Private generic functions
Generic Function, (setf mailbox-local-store): Private generic functions
Generic Function, (setf mailbox-name): Private generic functions
Generic Function, (setf mailbox-permanent-flags): Private generic functions
Generic Function, (setf mailbox-recent): Private generic functions
Generic Function, (setf mailbox-uidnext): Private generic functions
Generic Function, (setf mailbox-uidvalidity): Private generic functions
Generic Function, (setf mailbox-unseen): Private generic functions
Generic Function, (setf mailbox-valid): Private generic functions
Generic Function, (setf q-add-flags): Private generic functions
Generic Function, (setf q-add-labels): Private generic functions
Generic Function, (setf q-del-flags): Private generic functions
Generic Function, (setf q-del-labels): Private generic functions
Generic Function, (setf q-del-message): Private generic functions
Generic Function, (setf q-get-flags): Private generic functions
Generic Function, (setf q-get-labels): Private generic functions
Generic Function, (setf q-get-metadata): Private generic functions
Generic Function, (setf q-insert-message): Private generic functions
Generic Function, (setf q-set-encountered): Private generic functions
Generic Function, (setf q-set-metadata): Private generic functions
Generic Function, (setf store-db): Private generic functions
Generic Function, (setf store-path): Private generic functions
Generic Function, imap-bin-stream: Private generic functions
Generic Function, imap-capability: Private generic functions
Generic Function, imap-close: Private generic functions
Generic Function, imap-cmdqueue: Private generic functions
Generic Function, imap-cmdseq: Private generic functions
Generic Function, imap-command: Private generic functions
Generic Function, imap-command-sync: Private generic functions
Generic Function, imap-connect: Private generic functions
Generic Function, imap-handle: Private generic functions
Generic Function, imap-has-capability: Private generic functions
Generic Function, imap-host: Private generic functions
Generic Function, imap-idling: Private generic functions
Generic Function, imap-last-command-time: Private generic functions
Generic Function, imap-maybe-reconnect: Private generic functions
Generic Function, imap-on-connect: Private generic functions
Generic Function, imap-parse: Private generic functions
Generic Function, imap-password: Private generic functions
Generic Function, imap-poll-time: Private generic functions
Generic Function, imap-port: Private generic functions
Generic Function, imap-read-loop: Private generic functions
Generic Function, imap-reconnect: Private generic functions
Generic Function, imap-running: Private generic functions
Generic Function, imap-sock: Private generic functions
Generic Function, imap-sock-lock: Private generic functions
Generic Function, imap-start-idle: Private generic functions
Generic Function, imap-start-read-loop: Private generic functions
Generic Function, imap-stop-idle: Private generic functions
Generic Function, imap-text-stream: Private generic functions
Generic Function, imap-thread: Private generic functions
Generic Function, imap-use-ssl: Private generic functions
Generic Function, imap-user: Private generic functions
Generic Function, imap-utf-7: Private generic functions
Generic Function, imap-write: Private generic functions
Generic Function, mailbox-exists: Private generic functions
Generic Function, mailbox-fetch: Private generic functions
Generic Function, mailbox-fetch-changedsince: Private generic functions
Generic Function, mailbox-fetch-new: Private generic functions
Generic Function, mailbox-fetch-remote-changes: Private generic functions
Generic Function, mailbox-flags: Private generic functions
Generic Function, mailbox-gmail: Private generic functions
Generic Function, mailbox-highestmodseq: Private generic functions
Generic Function, mailbox-local-store: Private generic functions
Generic Function, mailbox-local-store-directory: Private generic functions
Generic Function, mailbox-name: Private generic functions
Generic Function, mailbox-permanent-flags: Private generic functions
Generic Function, mailbox-push-local-changes: Private generic functions
Generic Function, mailbox-recent: Private generic functions
Generic Function, mailbox-uidnext: Private generic functions
Generic Function, mailbox-uidvalidity: Private generic functions
Generic Function, mailbox-unseen: Private generic functions
Generic Function, mailbox-valid: Private generic functions
Generic Function, maildir-make-filename: Private generic functions
Generic Function, q-add-flags: Private generic functions
Generic Function, q-add-labels: Private generic functions
Generic Function, q-del-flags: Private generic functions
Generic Function, q-del-labels: Private generic functions
Generic Function, q-del-message: Private generic functions
Generic Function, q-get-flags: Private generic functions
Generic Function, q-get-labels: Private generic functions
Generic Function, q-get-metadata: Private generic functions
Generic Function, q-insert-message: Private generic functions
Generic Function, q-set-encountered: Private generic functions
Generic Function, q-set-metadata: Private generic functions
Generic Function, store-db: Private generic functions
Generic Function, store-find-local-changes: Private generic functions
Generic Function, store-get-by-path: Private generic functions
Generic Function, store-get-by-uid: Private generic functions
Generic Function, store-get-flags: Private generic functions
Generic Function, store-get-labels: Private generic functions
Generic Function, store-get-last-uid: Private generic functions
Generic Function, store-get-metadata: Private generic functions
Generic Function, store-insert-message: Private generic functions
Generic Function, store-path: Private generic functions
Generic Function, store-save-mailbox: Private generic functions
Generic Function, store-save-messages: Private generic functions
Generic Function, store-set-flags: Private generic functions
Generic Function, store-set-labels: Private generic functions
Generic Function, store-set-metadata: Private generic functions
Generic Function, store-update-for-changes: Private generic functions
Generic Function, store-upgrade-db: Private generic functions
get-header: Private ordinary functions

I
imap-bin-stream: Private generic functions
imap-bin-stream: Private generic functions
imap-capability: Private generic functions
imap-capability: Private generic functions
imap-close: Private generic functions
imap-close: Private generic functions
imap-cmdqueue: Private generic functions
imap-cmdqueue: Private generic functions
imap-cmdseq: Private generic functions
imap-cmdseq: Private generic functions
imap-command: Private generic functions
imap-command: Private generic functions
imap-command: Private generic functions
imap-command: Private generic functions
imap-command: Private generic functions
imap-command: Private generic functions
imap-command-sync: Private generic functions
imap-command-sync: Private generic functions
imap-connect: Private generic functions
imap-connect: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-handle: Private generic functions
imap-has-capability: Private generic functions
imap-has-capability: Private generic functions
imap-host: Private generic functions
imap-host: Private generic functions
imap-idling: Private generic functions
imap-idling: Private generic functions
imap-last-command-time: Private generic functions
imap-last-command-time: Private generic functions
imap-maybe-reconnect: Private generic functions
imap-maybe-reconnect: Private generic functions
imap-new-request-id: Private ordinary functions
imap-on-connect: Private generic functions
imap-on-connect: Private generic functions
imap-on-connect: Private generic functions
imap-parse: Private generic functions
imap-parse: Private generic functions
imap-password: Private generic functions
imap-password: Private generic functions
imap-poll-time: Private generic functions
imap-poll-time: Private generic functions
imap-port: Private generic functions
imap-port: Private generic functions
imap-read-loop: Private generic functions
imap-read-loop: Private generic functions
imap-reconnect: Private generic functions
imap-reconnect: Private generic functions
imap-running: Private generic functions
imap-running: Private generic functions
imap-sock: Private generic functions
imap-sock: Private generic functions
imap-sock-lock: Private generic functions
imap-sock-lock: Private generic functions
imap-start-idle: Private generic functions
imap-start-idle: Private generic functions
imap-start-read-loop: Private generic functions
imap-start-read-loop: Private generic functions
imap-stop-idle: Private generic functions
imap-stop-idle: Private generic functions
imap-text-stream: Private generic functions
imap-text-stream: Private generic functions
imap-thread: Private generic functions
imap-thread: Private generic functions
imap-use-ssl: Private generic functions
imap-use-ssl: Private generic functions
imap-user: Private generic functions
imap-user: Private generic functions
imap-utf-7: Private generic functions
imap-utf-7: Private generic functions
imap-write: Private generic functions
imap-write: Private generic functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Macro, for-maildir-files: Private macros
Macro, when-ok: Private macros
Macro, with-idle-resume: Private macros
Macro, with-local-store: Private macros
Macro, with-sock-lock: Private macros
Macro, with-socket-conditions: Private macros
mailbox-exists: Private generic functions
mailbox-exists: Private generic functions
mailbox-fetch: Private generic functions
mailbox-fetch: Private generic functions
mailbox-fetch-changedsince: Private generic functions
mailbox-fetch-changedsince: Private generic functions
mailbox-fetch-new: Private generic functions
mailbox-fetch-new: Private generic functions
mailbox-fetch-remote-changes: Private generic functions
mailbox-flags: Private generic functions
mailbox-flags: Private generic functions
mailbox-gmail: Private generic functions
mailbox-gmail: Private generic functions
mailbox-highestmodseq: Private generic functions
mailbox-highestmodseq: Private generic functions
mailbox-local-store: Private generic functions
mailbox-local-store: Private generic functions
mailbox-local-store-directory: Private generic functions
mailbox-local-store-directory: Private generic functions
mailbox-name: Private generic functions
mailbox-name: Private generic functions
mailbox-permanent-flags: Private generic functions
mailbox-permanent-flags: Private generic functions
mailbox-push-local-changes: Private generic functions
mailbox-push-local-changes: Private generic functions
mailbox-recent: Private generic functions
mailbox-recent: Private generic functions
mailbox-uidnext: Private generic functions
mailbox-uidnext: Private generic functions
mailbox-uidvalidity: Private generic functions
mailbox-uidvalidity: Private generic functions
mailbox-unseen: Private generic functions
mailbox-unseen: Private generic functions
mailbox-valid: Private generic functions
mailbox-valid: Private generic functions
maildir-file-suffix-from-flags: Private ordinary functions
maildir-find-message-file: Private ordinary functions
maildir-flags-from-file-suffix: Private ordinary functions
maildir-import-offlineimap: Private ordinary functions
maildir-make-filename: Private generic functions
maildir-make-filename: Private generic functions
make-maildir-filename: Private ordinary functions
Method, (setf imap-bin-stream): Private generic functions
Method, (setf imap-capability): Private generic functions
Method, (setf imap-cmdqueue): Private generic functions
Method, (setf imap-cmdseq): Private generic functions
Method, (setf imap-host): Private generic functions
Method, (setf imap-idling): Private generic functions
Method, (setf imap-last-command-time): Private generic functions
Method, (setf imap-password): Private generic functions
Method, (setf imap-poll-time): Private generic functions
Method, (setf imap-port): Private generic functions
Method, (setf imap-reconnect): Private generic functions
Method, (setf imap-running): Private generic functions
Method, (setf imap-sock): Private generic functions
Method, (setf imap-sock-lock): Private generic functions
Method, (setf imap-text-stream): Private generic functions
Method, (setf imap-thread): Private generic functions
Method, (setf imap-use-ssl): Private generic functions
Method, (setf imap-user): Private generic functions
Method, (setf mailbox-exists): Private generic functions
Method, (setf mailbox-flags): Private generic functions
Method, (setf mailbox-gmail): Private generic functions
Method, (setf mailbox-highestmodseq): Private generic functions
Method, (setf mailbox-local-store): Private generic functions
Method, (setf mailbox-name): Private generic functions
Method, (setf mailbox-permanent-flags): Private generic functions
Method, (setf mailbox-recent): Private generic functions
Method, (setf mailbox-uidnext): Private generic functions
Method, (setf mailbox-uidvalidity): Private generic functions
Method, (setf mailbox-unseen): Private generic functions
Method, (setf mailbox-valid): Private generic functions
Method, (setf q-add-flags): Private generic functions
Method, (setf q-add-labels): Private generic functions
Method, (setf q-del-flags): Private generic functions
Method, (setf q-del-labels): Private generic functions
Method, (setf q-del-message): Private generic functions
Method, (setf q-get-flags): Private generic functions
Method, (setf q-get-labels): Private generic functions
Method, (setf q-get-metadata): Private generic functions
Method, (setf q-insert-message): Private generic functions
Method, (setf q-set-encountered): Private generic functions
Method, (setf q-set-metadata): Private generic functions
Method, (setf store-db): Private generic functions
Method, (setf store-path): Private generic functions
Method, imap-bin-stream: Private generic functions
Method, imap-capability: Private generic functions
Method, imap-close: Private generic functions
Method, imap-cmdqueue: Private generic functions
Method, imap-cmdseq: Private generic functions
Method, imap-command: Private generic functions
Method, imap-command: Private generic functions
Method, imap-command: Private generic functions
Method, imap-command: Private generic functions
Method, imap-command: Private generic functions
Method, imap-command-sync: Private generic functions
Method, imap-connect: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-handle: Private generic functions
Method, imap-has-capability: Private generic functions
Method, imap-host: Private generic functions
Method, imap-idling: Private generic functions
Method, imap-last-command-time: Private generic functions
Method, imap-maybe-reconnect: Private generic functions
Method, imap-on-connect: Private generic functions
Method, imap-on-connect: Private generic functions
Method, imap-parse: Private generic functions
Method, imap-password: Private generic functions
Method, imap-poll-time: Private generic functions
Method, imap-port: Private generic functions
Method, imap-read-loop: Private generic functions
Method, imap-reconnect: Private generic functions
Method, imap-running: Private generic functions
Method, imap-sock: Private generic functions
Method, imap-sock-lock: Private generic functions
Method, imap-start-idle: Private generic functions
Method, imap-start-read-loop: Private generic functions
Method, imap-stop-idle: Private generic functions
Method, imap-text-stream: Private generic functions
Method, imap-thread: Private generic functions
Method, imap-use-ssl: Private generic functions
Method, imap-user: Private generic functions
Method, imap-utf-7: Private generic functions
Method, imap-write: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, mailbox-exists: Private generic functions
Method, mailbox-fetch: Private generic functions
Method, mailbox-fetch-changedsince: Private generic functions
Method, mailbox-fetch-new: Private generic functions
Method, mailbox-flags: Private generic functions
Method, mailbox-gmail: Private generic functions
Method, mailbox-highestmodseq: Private generic functions
Method, mailbox-local-store: Private generic functions
Method, mailbox-local-store-directory: Private generic functions
Method, mailbox-name: Private generic functions
Method, mailbox-permanent-flags: Private generic functions
Method, mailbox-push-local-changes: Private generic functions
Method, mailbox-recent: Private generic functions
Method, mailbox-uidnext: Private generic functions
Method, mailbox-uidvalidity: Private generic functions
Method, mailbox-unseen: Private generic functions
Method, mailbox-valid: Private generic functions
Method, maildir-make-filename: Private generic functions
Method, q-add-flags: Private generic functions
Method, q-add-labels: Private generic functions
Method, q-del-flags: Private generic functions
Method, q-del-labels: Private generic functions
Method, q-del-message: Private generic functions
Method, q-get-flags: Private generic functions
Method, q-get-labels: Private generic functions
Method, q-get-metadata: Private generic functions
Method, q-insert-message: Private generic functions
Method, q-set-encountered: Private generic functions
Method, q-set-metadata: Private generic functions
Method, store-db: Private generic functions
Method, store-find-local-changes: Private generic functions
Method, store-get-by-path: Private generic functions
Method, store-get-by-uid: Private generic functions
Method, store-get-flags: Private generic functions
Method, store-get-labels: Private generic functions
Method, store-get-last-uid: Private generic functions
Method, store-get-metadata: Private generic functions
Method, store-get-metadata: Private generic functions
Method, store-insert-message: Private generic functions
Method, store-path: Private generic functions
Method, store-save-mailbox: Private generic functions
Method, store-save-messages: Private generic functions
Method, store-set-flags: Private generic functions
Method, store-set-labels: Private generic functions
Method, store-set-metadata: Private generic functions
Method, store-set-metadata: Private generic functions
Method, store-update-for-changes: Private generic functions
Method, store-upgrade-db: Private generic functions
Method, store-upgrade-db: Private generic functions
Method, store-upgrade-db: Private generic functions
mutf-7-to-string: Private ordinary functions

P
parse-imap-cmdline: Private ordinary functions
parse-internaldate: Private ordinary functions
parse-rfc822-headers: Private ordinary functions

Q
q-add-flags: Private generic functions
q-add-flags: Private generic functions
q-add-labels: Private generic functions
q-add-labels: Private generic functions
q-del-flags: Private generic functions
q-del-flags: Private generic functions
q-del-labels: Private generic functions
q-del-labels: Private generic functions
q-del-message: Private generic functions
q-del-message: Private generic functions
q-get-flags: Private generic functions
q-get-flags: Private generic functions
q-get-labels: Private generic functions
q-get-labels: Private generic functions
q-get-metadata: Private generic functions
q-get-metadata: Private generic functions
q-insert-message: Private generic functions
q-insert-message: Private generic functions
q-set-encountered: Private generic functions
q-set-encountered: Private generic functions
q-set-metadata: Private generic functions
q-set-metadata: Private generic functions

S
sql-do-all: Private ordinary functions
sql-row: Private ordinary functions
sql-single: Private ordinary functions
sql-table-exists: Private ordinary functions
store-db: Private generic functions
store-db: Private generic functions
store-db-filename: Private ordinary functions
store-file: Private ordinary functions
store-find-local-changes: Private generic functions
store-find-local-changes: Private generic functions
store-folder: Private ordinary functions
store-get-by-path: Private generic functions
store-get-by-path: Private generic functions
store-get-by-uid: Private generic functions
store-get-by-uid: Private generic functions
store-get-flags: Private generic functions
store-get-flags: Private generic functions
store-get-labels: Private generic functions
store-get-labels: Private generic functions
store-get-last-uid: Private generic functions
store-get-last-uid: Private generic functions
store-get-metadata: Private generic functions
store-get-metadata: Private generic functions
store-get-metadata: Private generic functions
store-insert-message: Private generic functions
store-insert-message: Private generic functions
store-path: Private generic functions
store-path: Private generic functions
store-save-mailbox: Private generic functions
store-save-mailbox: Private generic functions
store-save-messages: Private generic functions
store-save-messages: Private generic functions
store-set-flags: Private generic functions
store-set-flags: Private generic functions
store-set-labels: Private generic functions
store-set-labels: Private generic functions
store-set-metadata: Private generic functions
store-set-metadata: Private generic functions
store-set-metadata: Private generic functions
store-update-for-changes: Private generic functions
store-update-for-changes: Private generic functions
store-upgrade-db: Private generic functions
store-upgrade-db: Private generic functions
store-upgrade-db: Private generic functions
store-upgrade-db: Private generic functions
string-to-mutf-7: Private ordinary functions

W
when-ok: Private macros
with-idle-resume: Private macros
with-local-store: Private macros
with-sock-lock: Private macros
with-socket-conditions: Private macros
write-rfc822-headers: Private ordinary functions


A.3 Variables

Jump to:   *   +  
B   C   D   E   F   G   H   I   L   M   P   Q   R   S   T   U   V  
Index Entry  Section

*
*mod-b64-chars*: Private special variables
*mod-b64-chars-reverse*: Private special variables
*preserve-case-readtable*: Private special variables

+
+atoms-package+: Private constants

B
bin-stream: Private classes

C
capability: Private classes
cmdqueue: Private classes
cmdseq: Private classes
Constant, +atoms-package+: Private constants

D
db: Private classes

E
exists: Private classes

F
flags: Private classes

G
gmail: Private classes

H
highestmodseq: Private classes
host: Private classes

I
idling: Private classes

L
last-command-time: Private classes
local-store: Private classes

M
mailbox-name: Private classes

P
password: Private classes
path: Private classes
permanent-flags: Private classes
poll-time: Private classes
port: Private classes

Q
q-add-flags: Private classes
q-add-labels: Private classes
q-del-flags: Private classes
q-del-labels: Private classes
q-del-message: Private classes
q-get-flags: Private classes
q-get-labels: Private classes
q-get-metadata: Private classes
q-insert-message: Private classes
q-set-encountered: Private classes
q-set-metadata: Private classes

R
recent: Private classes
reconnect: Private classes
running: Private classes

S
Slot, bin-stream: Private classes
Slot, capability: Private classes
Slot, cmdqueue: Private classes
Slot, cmdseq: Private classes
Slot, db: Private classes
Slot, exists: Private classes
Slot, flags: Private classes
Slot, gmail: Private classes
Slot, highestmodseq: Private classes
Slot, host: Private classes
Slot, idling: Private classes
Slot, last-command-time: Private classes
Slot, local-store: Private classes
Slot, mailbox-name: Private classes
Slot, password: Private classes
Slot, path: Private classes
Slot, permanent-flags: Private classes
Slot, poll-time: Private classes
Slot, port: Private classes
Slot, q-add-flags: Private classes
Slot, q-add-labels: Private classes
Slot, q-del-flags: Private classes
Slot, q-del-labels: Private classes
Slot, q-del-message: Private classes
Slot, q-get-flags: Private classes
Slot, q-get-labels: Private classes
Slot, q-get-metadata: Private classes
Slot, q-insert-message: Private classes
Slot, q-set-encountered: Private classes
Slot, q-set-metadata: Private classes
Slot, recent: Private classes
Slot, reconnect: Private classes
Slot, running: Private classes
Slot, sock: Private classes
Slot, sock-lock: Private classes
Slot, text-stream: Private classes
Slot, thread: Private classes
Slot, uidnext: Private classes
Slot, uidvalidity: Private classes
Slot, unseen: Private classes
Slot, use-ssl: Private classes
Slot, user: Private classes
Slot, utf-7: Private classes
Slot, valid: Private classes
sock: Private classes
sock-lock: Private classes
Special Variable, *mod-b64-chars*: Private special variables
Special Variable, *mod-b64-chars-reverse*: Private special variables
Special Variable, *preserve-case-readtable*: Private special variables

T
text-stream: Private classes
thread: Private classes

U
uidnext: Private classes
uidvalidity: Private classes
unseen: Private classes
use-ssl: Private classes
user: Private classes
utf-7: Private classes

V
valid: Private classes