imap_capabilities

The `imap_capabilities` directive configures the capabilities of the IMAP server in NGINX Mail module.

Syntaximap_capabilities capability1 [capability2 ...];
Defaultnone
Contextmail, mail server
Arguments1+

Description

The imap_capabilities directive is used within the mail context to specify a list of capabilities that the IMAP server can offer to mail clients. This list is crucial as it informs clients about the features supported by the IMAP server, such as IMAP4rev1, UIDPLUS, or IDLE, allowing them to make informed decisions about how they interact with the server.

Each capability is defined as a string argument and can be specified multiple times, with each subsequent entry appending to the capabilities advertised by the server. This ensures that clients performing capability negotiation during the connection process can recognize and utilize the features that your IMAP server provides. As such, careful consideration must be given to populating this directive with accurate capabilities to ensure proper client-server communication and functionality.

When using imap_capabilities, it is advisable to incorporate common IMAP features, which enhances compatibility with a broader range of email clients. Additionally, any malformed entries could lead to issues during the handshake process, so maintaining a strict adherence to the IMAP standards is key.

Config Example

mail {
    imap_capabilities IMAP4rev1 UIDPLUS IDLE;
}

Ensure capabilities are properly spelled and conform to IMAP standards to avoid handshake failures with clients.

Defining conflicting capabilities can lead to unexpected behavior or negate specific features.

Remember that not all clients may support all advertised capabilities, so include only those that are critical for your use case.

← Back to all directives