IMAP Options

Default:

set imap_check_subscribed = no

When set, NeoMutt will fetch the set of subscribed folders from your server whenever a mailbox is selected, and add them to the set of mailboxes it polls for new mail just as if you had issued individual :mailboxes commands.

`$imap_condstore`#

Description:

Enable the CONDSTORE extension

Type:

Default:

set imap_condstore = no

When set, NeoMutt will use the CONDSTORE extension (RFC7162) if advertised by the server. NeoMutt’s current implementation is basic, used only for initial message fetching and flag updates.

For some IMAP servers, enabling this will slightly speed up downloading initial messages. Unfortunately, Gmail is not one those, and displays worse performance when enabled. Your mileage may vary.

`$imap_deflate`#

Description:

Compress network traffic

Type:

Default:

set imap_deflate = yes

When set, NeoMutt will use the COMPRESS=DEFLATE extension (RFC4978) if advertised by the server.

In general a good compression efficiency can be achieved, which speeds up reading large mailboxes also on fairly good connections.

`$imap_delim_chars`#

Description:

Characters that denote separators in IMAP folders

Type:

Notes:

Case Sensitive

Default:

set imap_delim_chars = "/."

This contains the list of characters that NeoMutt will use as folder separators for IMAP paths, when no separator is provided on the IMAP connection.

`$imap_fetch_chunk_size`#

Description:

Download headers in blocks of this size

Type:

Number (Long)

Notes:

Default:

set imap_fetch_chunk_size = 0

When set to a value greater than 0, new headers will be downloaded in groups of this many headers per request. If you have a very large mailbox, this might prevent a timeout and disconnect when opening the mailbox, by sending a FETCH per set of this many headers, instead of a single FETCH for all new headers.

`$imap_headers`#

Description:

Additional email headers to download when getting index

Type:

Default:

(empty)

set imap_headers = ""

Below is a list of default headers that NeoMutt requests from IMAP servers before displaying the index menu. You may want to add more headers for spam detection.

Header
`Date:`
`From:`
`Sender:`
`Subject:`
`To:`
`Cc:`
`Message-ID:`
`References:`
`Content-Type:`
`Content-Description:`
`In-Reply-To:`
`Reply-To:`
`Lines:`
`List-Post:`
`X-Label:`

Note

This is a space separated list, items should be uppercase and not contain the colon, e.g. X-BOGOSITY X-SPAM-STATUS for the X-Bogosity: and X-Spam-Status: header fields.

`$imap_idle`#

Description:

Use the IMAP IDLE extension to check for new mail

Type:

Default:

set imap_idle = no

When set, NeoMutt will attempt to use the IMAP IDLE extension to check for new mail in the current mailbox. Some servers (dovecot was the inspiration for this option) react badly to NeoMutt’s implementation. If your connection seems to freeze up periodically, try unsetting this.

`$imap_keep_alive`#

Description:

Time to wait before polling an open IMAP connection

Type:

Number

Notes:

Default:

set imap_keep_alive = 300

Specify the maximum time in seconds NeoMutt waits before polling open IMAP connections, to prevent the server from closing them before NeoMutt has finished with them. The default is well within the RFC-specified minimum amount of time (30 minutes) before a server is allowed to do this, but in practice the RFC does get violated every now and then. Reduce this number if you find yourself getting disconnected from your IMAP server due to inactivity.

`$imap_list_subscribed`#

Description:

When browsing a mailbox, only display subscribed folders

Type:

Default:

set imap_list_subscribed = no

Configure whether IMAP folder browsing shows only subscribed folders or all folders. This can be toggled in the IMAP browser with the <toggle-subscribed> function.

`$imap_oauth_refresh_command`#

Description:

External command to generate OAUTH refresh token

Type:

Command (String)

Notes:

Sensitive

Default:

(empty)

set imap_oauth_refresh_command = ""

The command to run to generate an OAUTH refresh token for authorizing your connection to your IMAP server. This command will be run on every connection attempt that uses the OAUTHBEARER or XOAUTH2 authentication mechanisms.

`$imap_pass`#

Description:

Password for the IMAP server

Type:

Notes:

Sensitive

Default:

(empty)

set imap_pass = ""

Specifies the password for your IMAP account. If unset, NeoMutt will prompt you for your password when you invoke the <imap-fetch-mail> function or try to open an IMAP folder.

Warning

You should only use this option when you are on a fairly secure machine, because the superuser can read your neomuttrc even if you are the only one who can read the file.

`$imap_passive`#

Description:

Reuse an existing IMAP connection to check for new mail

Type:

Default:

set imap_passive = yes

When set, NeoMutt will not open new IMAP connections to check for new mail. NeoMutt will only check for new mail over existing IMAP connections. This is useful if you don’t want to be prompted for user/password pairs on NeoMutt invocation, or if opening the connection is slow.

`$imap_peek`#

Description:

Don’t mark messages as read when fetching them from the server

Type:

Default:

set imap_peek = yes

When set, NeoMutt will avoid implicitly marking your mail as read whenever you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. Exists to appease speed freaks.

`$imap_pipeline_depth`#

Description:

Number of IMAP commands that may be queued up

Type:

Number

Notes:

Default:

set imap_pipeline_depth = 15

Controls the number of IMAP commands that may be queued up before they are sent to the server. A deeper pipeline reduces the amount of time NeoMutt must wait for the server, and can make IMAP servers feel much more responsive. But not all servers correctly handle pipelined commands, so if you have problems you might want to try setting this option to 0.

Note

Changes to this option have no effect on open connections.

`$imap_poll_timeout`#

Description:

Maximum time to wait for a server response

Type:

Number

Notes:

Default:

set imap_poll_timeout = 15

Specify the maximum time in seconds NeoMutt waits for a response when polling IMAP connections for new mail, before timing out and closing the connection. Set to 0 to disable timing out.

`$imap_qresync`#

Description:

Enable the QRESYNC extension

Type:

Default:

set imap_qresync = no

When set, NeoMutt will use the QRESYNC extension (RFC7162) if advertised by the server. NeoMutt’s current implementation is basic, used only for initial message fetching and flag updates.

Note

this feature is currently experimental. If you experience strange behavior, such as duplicate or missing messages please file a bug report to let us know.

`$imap_rfc5161`#

Description:

Use the IMAP ENABLE extension to select capabilities

Type:

Default:

set imap_rfc5161 = yes

When set, NeoMutt will use the IMAP ENABLE extension (RFC5161) to select CAPABILITIES. Some servers (notably Coremail System IMap Server) do not properly respond to ENABLE commands, which might cause NeoMutt to hang. If your connection seems to freeze at login, try unsetting this.

`$imap_send_id`#

Description:

Send ID command when logging in

Type:

Default:

set imap_send_id = no

When set, NeoMutt will send an IMAP ID command (RFC2971) to the server when logging in if advertised by the server. This command provides information about the IMAP client, such as “NeoMutt” and the current version.

`$imap_server_noise`#

Description:

Display server warnings as error messages

Type:

Default:

set imap_server_noise = yes

When set, NeoMutt will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users’ hands, you may wish to suppress them at some point.

`$imap_user`#

Description:

Username for the IMAP server

Type: