Under Development
stars

Index Options

Index Options#

$beep_new#

Type:

Boolean

Default:
set beep_new = no

When this option is set, NeoMutt will beep whenever it prints a message notifying you of new mail. This is independent of the setting of the $beep option.

$change_folder_next#

Type:

Boolean

Default:
set change_folder_next = no

When this option is set, the <change-folder> function mailbox suggestion will start at the next folder in your :mailboxes list, instead of starting at the first folder in the list.

$collapse_all#

Type:

Boolean

Default:
set collapse_all = no

When set, NeoMutt will collapse all threads when entering a folder.

$crypt_chars#

Type:

Character String

Default:
set crypt_chars = "SPsK "

Controls the characters used in cryptography flags.

Character

Default

Description

1

S

The mail is signed, and the signature is successfully verified

2

P

The mail is PGP encrypted

3

s

The mail is signed

4

K

The mail contains a PGP public key

5

(space)

The mail has no crypto info

$flag_chars#

Type:

Character String

Default:
set flag_chars = "*!DdrONon- "

Controls the characters used in several flags.

Character

Default

Description

1

*

Mail is tagged

2

!

Mail is flagged as important

3

D

Mail is marked for deletion

4

d

Mail has attachments marked for deletion

5

r

Mail has been replied to

6

O

Mail is Old (Unread but seen)

7

N

Mail is New (Unread but not seen)

8

o

Mail thread is Old (Unread but seen)

9

n

Mail thread is New (Unread but not seen)

10

-

Mail is read - %S expando

11

(space)

Mail is read - %Z expando

$from_chars#

Type:

Character String

Default:

(empty)

set from_chars = ""

Controls the character used to prefix the %F and %L fields in the index.

Character

Description

1

Mail is written by you and has a To: address, or has a known mailing list in the To: address.

2

Mail is written by you and has a Cc: address, or has a known mailing list in the Cc: address.

3

Mail is written by you and has a Bcc: address.

4

All remaining cases.

If this is empty or unset (default), the traditional long To , Cc and Bcc prefixes are used. If set but too short to include a character for a particular case, a single space will be prepended to the field. To prevent any prefix at all from being added in a particular case, use the special value CR (aka ^M) for the corresponding character.

This slightly odd interface is necessitated by NeoMutt’s handling of string variables; one can’t tell a variable that is unset from one that is set to the empty string.

$index_format#

Type:

Expando

Notes:

Not Empty, Pipe Support

Default:
set index_format = "%4C %Z %{%b %d} %-15.15L (%<l?%4l&%4c>) %s"
Alternative:
set index_format = "%4{number} %{combined-flags} %{%b %d} %-15.15{from-list} (%<l?%4{lines}&%4{size}>) %{subject}"

Specify the format of the data displayed in the Index Dialog.

Format Sequences

Short

Long Name

Description

%A

%{reply-to}

Reply-to address (if present; otherwise: address of author)

%a

%{from}

Address of the author

%B

%{list-address}

List to which the email was sent (if any; otherwise: Mailbox name)

%b

%{mailbox-name}

Filename of the original message folder (think mailbox)

%C

%{number}

Current message number

%c

%{body-characters}

Number of characters (bytes) in the body of the message (see Bytes Size Display)

%cr

%{size}

Number of characters (bytes) in the raw message, including the header (see Bytes Size Display)

%D

%{date-format-local}

Date and time of message using $date_format and local timezone.

It is recommended to use %[fmt] instead, where fmt is the value of $date_format.

%d

%{date-format}

Date and time of message using $date_format and sender’s timezone.

It is recommended to use %{fmt} instead, where fmt is the value of $date_format.

%E

%{thread-count}

Number of messages in current thread

%e

%{thread-number}

Current message number in thread

%F

%{sender}

Author name, or recipient name if the message is from you

%Fp

%{sender-plain}

Like %F, but plain. No contextual formatting is applied to recipient name

%f

%{from-full}

Sender (address + real name), either From: or Return-Path:

%Gx

%{tags-transformed}

Individual message tag (e.g. Notmuch tags/imap flags)

%g

%{tags}

Message tags (e.g. Notmuch tags/imap flags)

%H

%{spam}

Spam attribute(s) of this message

%I

%{initials}

Initials of author

%i

%{message-id}

Message-ID of the current message

%J

%{thread-tags}

Message tags (if present, tree unfolded, and != parent’s tags)

%K

%{list-empty}

List to which the email was sent (if any; otherwise: empty)

%L

%{from-list}

If an address in the To: or Cc: header field matches an address

defined by the user’s $subscribe command, this displays.

%l

%{lines}

Number of lines in the unprocessed message (may not work with maildir, mh, and IMAP folders)

%M

%{thread-hidden-count}

Number of hidden messages if the thread is collapsed

%m

%{message-count}

Total number of message in the mailbox

%N

%{score}

Message score

%n

%{name}

Author’s real name (or address if missing)

%O

%{save-folder}

Original save folder where NeoMutt would formerly have Stashed the message:

list name or recipient name if not sent to a list

%P

%{percentage}

Progress indicator for the built-in pager (how much of the file has been displayed)

%q

%{newsgroup}

Newsgroup name (if compiled with NNTP support)

%R

%{cc-all}

Comma separated list of Cc: recipients

%r

%{to-all}

Comma separated list of To: recipients

%S

%{flag-chars}

Single character status of the message (N/O/D/d/!/r/*)

%s

%{subject}

Subject of the message

%T

%{to-chars}

Appropriate character from the $to_chars string

%t

%{to}

To: field (recipients)

%u

%{username}

User (login) name of the author

%v

%{first-name}

First name of the author, or the recipient if the message is from you

%W

%{organization}

Name of organization of author (Organization: field)

%X

%{attachment-count}

Number of MIME attachments (see Configure MIME Handling for possible speed effects)

%x

%{x-comment-to}

X-Comment-To: field (if present)

%Y

%{thread-x-label}

X-Label: field, if present, and

1. not at part of a thread tree

2. at the top of a thread, or

3. X-Label: is different from Preceding message’s X-Label:

%y

%{x-label}

X-Label: field, if present

%Z

%{combined-flags}

A three character set of message status flags.

The first character is new/read/replied flags (n/o/r/O/N).

The second is deleted or encryption flags (D/d/S/P/s/K).

The third is either tagged/flagged (*/!), or one of the characters.

Listed in $to_chars.

%zc

%{crypto-flags}

Message crypto flags

%zs

%{status-flags}

Message status flags

%zt

%{message-flags}

Message tag flags

%@name@

Insert and evaluate format-string from the matching index-format-hook command

%{fmt}

Date and time of the message is converted to sender’s time zone, and fmt is expanded by the library function strftime(3);

if the first character inside the braces is a bang (!), the date is formatted ignoring any locale settings.

Note that the sender’s time zone might only be available as a numerical offset, so %Z behaves like %z.

%{fmt} behaves like %[fmt] on systems where struct tm doesn’t have a tm_gmtoff member.

%[fmt]

Date and time of the message is converted to the local time zone, and fmt is expanded by the library function strftime(3);

if the first character inside the brackets is a bang (!), the date is formatted ignoring any locale settings.

%(fmt)

Local date and time when the message was received, and fmt is expanded by the library function strftime(3);

if the first character inside the parentheses is a bang (!), the date is formatted ignoring any locale settings.

%*X

%{padding-soft:X}

Soft-fill with character X as padding

%>X

%{padding-hard:X}

Right justify the rest of the string and pad with character X

%|X

%{padding-eol:X}

Pad to the end of the line with character X

Date format expressions can be constructed based on relative dates. Using the date formatting operators along with nested conditionals, the date format can be modified based on how old a message is.

Note

For mbox/mmdf, %l applies to the unprocessed message, and for maildir/mh, the value comes from the Lines: header field when present (the meaning is normally the same). Thus the value depends on the encodings used in the different parts of the message and has little meaning in practice.

Note

These expandos are supported in :save-hook, :fcc-hook and :fcc-save-hook, too.

See also

Expandos: Tutorial Conditional, Howto Conditional, Formatting, Reference

$mark_macro_prefix#

Type:

String

Default:
set mark_macro_prefix = "'"

Prefix for macros created using mark-message. A new macro automatically generated with <mark-message>a will be composed from this prefix and the letter a.

$new_mail_command#

Type:

Expando (Command String)

Notes:

Pipe Support

Default:

(empty)

set new_mail_command = ""

If set, NeoMutt will call this command after a new message is received.

See also

$quit#

Type:

Quad-Option

Default:
set quit = yes

Control whether “quit” and “exit” actually quit from NeoMutt. If this option is set, they do quit, if it is unset, they have no effect, and if it is set to ask-yes or ask-no, you are prompted for confirmation when you try to quit.

In order to quit from NeoMutt if this option is unset, you must send the signal SIGINT to NeoMutt. This can usually be achieved by pressing Ctrl-C in the terminal.

$read_only#

Type:

Boolean

Default:
set read_only = no

If set, all folders are opened in read-only mode.

$status_chars#

Type:

Character String

Default:
set status_chars = "-*%A"

Controls the characters used by the %r indicator in $status_format.

Character

Default

Description

1

-

Mailbox is unchanged

2

*

Mailbox has been changed and needs to be resynchronized

3

%

Mailbox is read-only, or will not be written when exiting.

You can toggle whether to write changes to a mailbox with the <toggle-write> operation, bound by default to %

4

A

Folder opened in attach-message mode.

Certain operations like composing a new mail, replying, forwarding, etc. are not permitted in this mode

$status_format#

Type:

Expando

Notes:

Localised String, Pipe Support

Default:
set status_format = "-%r-NeoMutt: %D [Msgs:%<M?%M/>%m%<n? New:%n>%<o? Old:%o> %<d? Del:%d>%<F? Flag:%F> %<t? Tag:%t>%<p? Post:%p>%<b? Inc:%b> %<l? %l>]---(%<T?%T/>%s/%S)-%>-(%P)---"
Alternative:
set status_format = "-%{readonly}-NeoMutt: %{description} [Msgs:%<M?%{limit-count}/>%{message-count}%<n? New:%{new-count}>%<o? Old:%{old-count}>%<d? Del:%{deleted-count}>%<F? Flag:%{flagged-count}>%<t? Tag:%{tagged-count}>%<p? Post:%{postponed-count}>%<n? Inc:%{unread-mailboxes}>%<l? %{mailbox-size}>]---(%<T?%{use-threads}/>%{sort}/%{sort-aux})-%{padding-hard:-}(%{percentage})---"

Specify the format of the data displayed in the Index Dialog’s status bar.

Format Sequences

Short

Long Name

Description

%b

%{unread-mailboxes}

Number of mailboxes with new mail

%D

%{description}

Description of the mailbox

%d

%{deleted-count}

Number of deleted messages

%f

%{flagged-count}

Number of flagged messages

%F

%{mailbox-path}

Full pathname of the current mailbox

%h

%{hostname}

Local hostname

%l

%{limit-size}

Size (in bytes) of the limited messages shown (see Bytes Size Display)

%L

%{mailbox-size}

Size (in bytes) of the current mailbox (see Bytes Size Display)

%m

%{limit-count}

Number of messages shown (i.e., which match the current limit)

%M

%{message-count}

Number of messages in the mailbox

%n

%{new-count}

Number of new messages in the mailbox (unread, unseen)

%o

%{old-count}

Number of old messages in the mailbox (unread, seen)

%p

%{postponed-count}

Number of postponed messages

%P

%{percentage}

Percentage of the way through the index

%r

%{read-count}

Number of read messages in the mailbox (read, seen)

%R

%{readonly}

Modified/read-only/won’t-write/attach-message indicator, according to $status_chars

%s

%{sort}

Current sorting mode ($sort)

%S

%{sort-aux}

Current aux sorting method ($sort_aux)

%t

%{tagged-count}

Number of tagged messages in the mailbox

%T

%{use-threads}

Current threading mode ($use_threads)

%u

%{unread-count}

Number of unread messages in the mailbox (seen or unseen)

%v

%{limit-pattern}

Currently active limit pattern, if any

%V

%{version}

NeoMutt version string

%*X

%{padding-soft:X}

Soft-fill with character X as padding

%>X

%{padding-hard:X}

Right justify the rest of the string and pad with character X

%|X

%{padding-eol:X}

Pad to the end of the line with character X

See also

Expandos: Tutorial Conditional, Howto Conditional, Formatting, Reference

$to_chars#

Type:

Character String

Default:
set to_chars = " +TCFLR"

Controls the character used to indicate mail addressed to you.

Character

Default

Description

1

(space)

The mail is not addressed to your address

2

+

You are the only recipient of the message

3

T

Your address appears in the To: header field, but you are not the only recipient of the message

4

C

Your address is specified in the Cc: header field, but you are not the only recipient

5

F

Indicates the mail that was sent by you

6

L

Indicates the mail was sent to a mailing-list you subscribe to

7

R

Your address appears in the Reply-To: header field but none of the above applies

$ts_enabled#

Type:

Boolean

Default:
set ts_enabled = no

Controls whether NeoMutt tries to set the terminal status line and icon name. Most terminal emulators emulate the status line in the window title.

$ts_icon_format#

Type:

Expando

Notes:

Localised String, Pipe Support

Default:
set ts_icon_format = "M%<n?AIL&ail>"
Alternative:
set ts_icon_format = "M%<{new-count}?AIL&ail>"

Controls the format of the icon title, as long as $ts_enabled is set.

See also

$ts_status_format#

Type:

Expando

Notes:

Localised String, Pipe Support

Default:
set ts_status_format = "NeoMutt with %<m?%m messages&no messages>%<n? [%n NEW]>"
Alternative:
set ts_status_format = "NeoMutt with %<m?%{message-count} messages&no messages>%<n? [%{new-count} NEW]>"

Controls the format of the terminal status line (or window title), provided that $ts_enabled has been set.

See also

$uncollapse_jump#

Type:

Boolean

Default:
set uncollapse_jump = no

When set, NeoMutt will jump to the next unread message, if any, when the current thread is _un_collapsed.

$uncollapse_new#

Type:

Boolean

Default:
set uncollapse_new = yes

When set, NeoMutt will automatically uncollapse any collapsed thread that receives a newly delivered message. When unset, collapsed threads will remain collapsed. The presence of the newly delivered message will still affect index sorting, though.