Under Development
stars

Notmuch Options#

$nm_config_file#

Description:

Configuration file for notmuch. Use auto to detect configuration.

Type:

Path (String)

Notes:

File only

Default:
set nm_config_file = "auto"

Configuration file for notmuch. Use β€˜auto’ to detect configuration.


$nm_config_profile#

Description:

Configuration profile for notmuch.

Type:

String

Default:

(empty)

set nm_config_profile = ""

Configuration profile for notmuch.


$nm_db_limit#

Description:

Default limit for Notmuch queries

Type:

Number

Notes:

Not Negative

Default:
set nm_db_limit = 0

Specify the default limit used in notmuch queries.


$nm_default_url#

Description:

Path to the Notmuch database

Type:

String

Default:

(empty)

set nm_default_url = ""

Specify the default Notmuch database in format notmuch://<absolute path>


$nm_exclude_tags#

Description:

Exclude messages with these tags

Type:

String

Default:

(empty)

set nm_exclude_tags = ""

The messages tagged with these tags are excluded and not loaded from notmuch DB to NeoMutt unless specified explicitly.


$nm_flagged_tag#

Description:

Tag to use for flagged messages

Type:

String

Notes:

Case Sensitive

Default:
set nm_flagged_tag = "flagged"

Specify the notmuch tag used for flagged messages. The option is used to count flagged messages in DB and set the flagged flag when modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.


$nm_open_timeout#

Description:

Database timeout

Type:

Number

Notes:

Not Negative

Default:
set nm_open_timeout = 5

Specify the timeout for opening the database, in seconds.


$nm_query_type#

Description:

Default query type: threads or messages

Type:

Enumeration

Notes:

Case Sensitive

Default:
set nm_query_type = messages

Default query type used in notmuch queries.

Value

Description

messages

Only return matching messages

threads

Return entire thread of every matching message


$nm_query_window_current_position#

Description:

Position of current search window

Type:

Number

Default:
set nm_query_window_current_position = 0

Contain the position of the current search for window based vfolder.


$nm_query_window_duration#

Description:

Time duration of the current search window

Type:

Number

Notes:

Not Negative

Default:
set nm_query_window_duration = 0

Set the time duration of a windowed notmuch query. Accepted values all non negative integers. A value of 0 disables the feature.


$nm_query_window_enable#

Description:

Enable query windows

Type:

Boolean

Default:
set nm_query_window_enable = no

Enable windowed notmuch queries even if window duration is 0.


$nm_query_window_or_terms#

Description:

Additional notmuch search terms for messages to be shown regardless of date

Type:

String

Default:

(empty)

set nm_query_window_or_terms = ""

Contain additional notmuch search terms for messages to be shown regardless of date.

Example:

Using notmuch://?query=tag:inbox as the mailbox and tag:flagged and tag:unread as the or terms, NeoMutt will produce a query window such as: notmuch://?query=tag:inbox and (date:... or (tag:flagged and tag:unread))


$nm_query_window_timebase#

Description:

Units for the time duration

Type:

Enumeration

Notes:

Case Sensitive

Default:
set nm_query_window_timebase = week

Set the time base of a windowed notmuch query.

Accepted Values

hour

day

week

month

year


$nm_record_tags#

Description:

Tags to apply to the $record mailbox (sent mail)

Type:

String

Default:

(empty)

set nm_record_tags = ""

Specify the notmuch tag modifications (addition, removal, toggling) applied to messages added to the NeoMutt record when $nm_record is true.

See also

<modify-labels> function for the syntax


$nm_replied_tag#

Description:

Tag to use for replied messages

Type:

String

Notes:

Case Sensitive

Default:
set nm_replied_tag = "replied"

Specify the notmuch tag used for replied messages. The option is used to set the replied flag when modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.


$nm_unread_tag#

Description:

Tag to use for unread messages

Type:

String

Notes:

Case Sensitive

Default:
set nm_unread_tag = "unread"

Specify the notmuch tag used for unread messages. The option is used to count unread messages in DB and set the unread flag when modifying tags. All other NeoMutt commands use standard (e.g. maildir) flags.


$virtual_spool_file#

Description:

Use the first virtual mailbox as a spool file

Type:

Boolean

Default:
set virtual_spool_file = no

When set, NeoMutt will use the first Notmuch virtual mailbox as a spool file.