IMAP

The module enables IMAP mail protocol support, allowing the server to interact with mail storage systems. It establishes connections to IMAP servers, processes common commands like listing mailboxes and retrieving messages, and provides secure authentication while managing message statuses.

Directives

imap_auth

Syntax	imap_auth method ...;
Default	imap_auth plain;
Context	mail, server

Sets permitted methods of authentication for IMAP clients. Supported methods are:

plain	LOGIN, AUTH=PLAIN
login	AUTH=LOGIN
cram-md5	AUTH=CRAM-MD5. In order for this method to work, the password must be stored unencrypted.
external	AUTH=EXTERNAL

Plain text authentication methods (the LOGIN command, AUTH=PLAIN, and AUTH=LOGIN) are always enabled, though if the plain and login methods are not specified, AUTH=PLAIN and AUTH=LOGIN will not be automatically included in imap_capabilities.

imap_capabilities

Syntax	imap_capabilities extension ...;
Default	imap_capabilities IMAP4 IMAP4rev1 UIDPLUS;
Context	mail, server

Sets the IMAP protocol extensions list that is passed to the client in response to the CAPABILITY command. The authentication methods specified in the imap_auth directive and STARTTLS are automatically added to this list depending on the starttls directive value.

It makes sense to specify the extensions supported by the IMAP backends to which the clients are proxied (if these extensions are related to commands used after the authentication, when Angie transparently proxies a client connection to the backend).

imap_client_buffer

Syntax	imap_client_buffer size;
Default	imap_client_buffer 4k|8k;
Context	mail, server

Sets the size of the buffer used for reading IMAP commands. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform.