info bigloo

20.5.1 Mailboxes

Bigloo Mail class: mailbox

(abstract-class mailbox
  (label::bstring (default "")))

The abstract class mailbox is the common ancestors to all the mailbox implementations. It allows the definitions of various generic functions that deal with mail messages and mail folders.

Bigloo Mail class: &mailbox-error

(abstract-class &mailbox-error::&error)

The &mailbox-error is the super class of all the errors that can be raised when accessing mail servers, except the parsing errors that inherit from the &parse-error super class.

Bigloo Mail procedure: mailbox-close mailbox

Close the mailbox connection.

Example:

(let ((mbox (if (network-up?)
                (instantiate::imap (socket ...))
                (instantiate::maildir (path my-local-cache)))))
   (mailbox-close mbox))

Bigloo Mail procedure: mailbox-separator mailbox: Returns a string denoting the separator (commonly " or .) used by the mailbox.

Bigloo Mail procedure: mailbox-prefix mailbox: Returns the prefix of the mailbox, a string or #f.

Bigloo Mail procedure: mailbox-hostname mailbox: Returns the hostname of the mailbox, a string or #f.

Bigloo Mail procedure: mailbox-folders mailbox: Returns a list of strings denoting the folder names of the mailbox.

Bigloo Mail procedure: mailbox-folder-select! mailbox string: Selects one folder of the mailbox. This function is central to mailboxes because all messages are referenced relatively to the folder selection. All the functions that operates on uid implicitly access the current folder selection.

Bigloo Mail procedure: mailbox-folder-unselect! mailbox: Unselects the mailbox current selected folder.

Bigloo Mail procedure: mailbox-folder-create! mailbox folder

Creates a new folder denotes by a fully qualified name.

Example

(mailbox-create! mbox "INBOX.scheme.bigloo")

Bigloo Mail procedure: mailbox-folder-delete! mailbox folder: Deletes an empty folder.

Bigloo Mail procedure: mailbox-folder-rename! mailbox old new: Renames a folder.

Bigloo Mail procedure: mailbox-folder-move! mailbox folder dest: Moves the folder into the destination folder dest.

Bigloo Mail procedure: mailbox-subscribe! mailbox folder
Bigloo Mail procedure: mailbox-unsubscribe! mailbox folder: Subscribe/unsubscribe to a folder. This allows imap servers not to present the entire list of folders. Only subscribed folders are returned by mailbox-folders. These functions have no effect on maildir servers.

Bigloo Mail procedure: mailbox-folder-exists? mailbox folder: Returns #t if and only if folder exists in mailbox. Returns #f otherwise.

Bigloo Mail procedure: mailbox-folder-status mailbox folder: Returns the status of the folder. A status is an alist made of the number of unseen mail, the uid validity information, the uid next value, the number of recent messages, and the overall number of messages.

Bigloo Mail procedure: mailbox-folder-uids mailbox: Returns the list of UIDs (a list of integers) of the messages contained in the currently selected folder.

Bigloo Mail procedure: mailbox-folder-dates mailbox: Returns the list of dates of the messages contained in the currently selected folder.

Bigloo Mail procedure: mailbox-folder-delete-messages! mailbox: Deletes the messages marked as deleted of the currently selected folder.

Bigloo Mail procedure: mailbox-folder-header-fields mailbox field: Returns the list of headers fields of the message of the current folder.

Bigloo Mail procedure: mailbox-message mailbox uid: Returns the message uid in the current folder.

Bigloo Mail procedure: mailbox-message-path mailbox uid: Returns the full path name of the message uid.

Bigloo Mail procedure: mailbox-message-body mailbox uid [len]: Returns the body of the message uid. If len is provided, only returns the first len characters of the body.

Bigloo Mail procedure: mailbox-message-header mailbox uid: Returns the header as a string of the message uid.

Bigloo Mail procedure: mailbox-message-header-list mailbox uid: Returns the header as an alist of the message uid.

Bigloo Mail procedure: mailbox-message-header-field mailbox uid field: Extracts one field from the message header.

Bigloo Mail procedure: mailbox-message-size mailbox uid: Returns the size of the message.

Bigloo Mail procedure: mailbox-message-info mailbox uid: Returns the information relative to the message uid. This a list containing the message identifier, its uid, the message date, the message size, and the message flags.

Bigloo Mail procedure: mailbox-message-flags mailbox uid

Bigloo Mail procedure: mailbox-message-flags-set! mailbox uid lst

Sets/Gets the flags of the message uid. This is a list of strings. Typical flags are:

\Flagged
\Answered
\Deleted
\Seen

Bigloo Mail procedure: mailbox-message-delete! mailbox uid: Deletes the message uid.

Bigloo Mail procedure: mailbox-message-move! mailbox uid folder: Moves the message uid into the new folder (denoted by a string).

Bigloo Mail procedure: mailbox-message-create! mailbox folder content: Creates a new message in the folder whose content is given the string content.

This document was generated on March 31, 2014 using texi2html 5.0.