Sidebar Options#
$sidebar_component_depth#
- Description:
Strip leading path components from sidebar folders
- Type:
- Default:
set sidebar_component_depth = 0
By default the sidebar will show the mailbox’s path, relative to the $folder option.
This specifies the number of parent directories to hide from display in the sidebar.
For example: If a maildir is normally displayed in the sidebar as dir1/dir2/dir3/maildir, setting set sidebar_component_depth = 2 will display it as dir3/maildir, having truncated the 2 highest directories.
See also
$sidebar_delim_chars#
- Description:
Characters that separate nested folders
- Type:
- Notes:
- Default:
set sidebar_delim_chars = "/."
This contains the list of characters which you would like to treat as folder separators for displaying paths in the sidebar.
Local mail is often arranged in directories: dir1/dir2/mailbox.
set sidebar_delim_chars = '/'
IMAP mailboxes are often named: ‘folder1.folder2.mailbox’.
set sidebar_delim_chars = '.'
$sidebar_divider_char#
- Description:
Character to draw between the sidebar and index
- Type:
- Default:
set sidebar_divider_char = "│" # Unicode: Box Drawings Light Vertical, U+2502
This specifies the characters to be drawn between the sidebar (when visible) and the other NeoMutt panels. ASCII and Unicode line-drawing characters are supported.
The divider char can be set to an empty string for some extra space.
If empty, setting the sidebar_background color may help distinguish the sidebar from other panels.
$sidebar_folder_indent#
- Description:
Indent nested folders
- Type:
- Default:
set sidebar_folder_indent = no
Set this to indent mailboxes in the sidebar.
$sidebar_format#
- Description:
Format string for the Sidebar
- Type:
- Notes:
- Default:
set sidebar_format = "%D%* %n"
- Alternative:
set sidebar_format = "%{description}%{padding-soft: } %{new-mail}"
Specify the format of the data displayed in the Sidebar Panel.
Format Sequences
Short |
Long Name |
Cur |
Description |
|---|---|---|---|
|
|
Alert: 1 if user is notified of new mail |
|
|
|
Name of the mailbox |
|
|
|
Descriptive name of the mailbox |
|
|
|
Cur |
Number of deleted messages in the mailbox |
|
|
Number of flagged messages in the mailbox |
|
|
|
Cur |
Number of messages after limiting |
|
|
Number of unread messages in the mailbox (seen or unseen) |
|
|
|
|
|
|
|
Number of old messages in the mailbox (unread, seen) |
|
|
|
Poll: 1 if Mailbox is checked for new mail |
|
|
|
Number of read messages in the mailbox (read, seen) |
|
|
|
Size of mailbox (total number of messages) |
|
|
|
Cur |
Number of tagged messages in the mailbox |
|
|
Number of new messages in the mailbox (unread, unseen) |
|
|
|
|
|
|
|
Soft-fill with character |
|
|
|
Right justify the rest of the string and pad with character |
|
|
|
Pad to the end of the line with character |
Cur = Only applicable to the current folder
In order to use %S, %N, %F, and %!, $mail_check_stats must be set.
When thus set, a suggested value for this option is %B%<F? [%F]>%* %<N?%N/>%S.
See also
Expandos: Tutorial Conditional, Howto Conditional, Formatting, Reference
$sidebar_indent_string#
- Description:
Indent nested folders using this string
- Type:
- Default:
set sidebar_indent_string = " " # Two spaces
This specifies the string that is used to indent mailboxes in the sidebar. It defaults to two spaces.
$sidebar_new_mail_only#
- Description:
Only show folders with new/flagged email
- Type:
- Default:
set sidebar_new_mail_only = no
When set, the sidebar will only display mailboxes containing new, or flagged, mail.
See also
$sidebar_next_new_wrap#
- Description:
Wrap around when searching for the next mailbox with new email
- Type:
- Default:
set sidebar_next_new_wrap = no
When set, the <sidebar-next-new> command will not stop at the end of the list of mailboxes, but wrap around to the beginning.
The <sidebar-prev-new> command is similarly affected, wrapping around to the end of the list.
$sidebar_non_empty_mailbox_only#
- Description:
Only show folders with a non-zero number of emails
- Type:
- Default:
set sidebar_non_empty_mailbox_only = no
When set, the sidebar will only display mailboxes that contain one or more mails.
See also
$sidebar_on_right#
- Description:
Display the sidebar on the right
- Type:
- Default:
set sidebar_on_right = no
When set, the sidebar will appear on the right-hand side of the screen.
$sidebar_short_path#
- Description:
Abbreviate the paths using the
$folderoption- Type:
- Default:
set sidebar_short_path = no
By default the sidebar will show the mailbox’s path, relative to the $folder option.
Setting set sidebar_shortpath = yes will shorten the names relative to the previous name.
Here’s an example:
shortpath=no |
shortpath=yes |
shortpath=yes, folderindent=yes, indentstr=“..” |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
See also
$sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string, $sidebar_component_depth
$sidebar_sort#
- Description:
Sort method for the Sidebar
- Type:
- Default:
set sidebar_sort = unsorted
Specifies how to sort mailbox entries in the sidebar.
Value |
Sort by |
|---|---|
|
Total message count |
|
Mailbox description |
|
Count of flagged messages |
|
Mailbox path (alphabetically) |
|
Count of unread messages |
|
The order the mailboxes were configured |
Deprecated Value |
Use this instead |
|---|---|
|
|
|
|
|
|
|
|
$sidebar_visible#
This specifies whether or not to show sidebar. The sidebar shows a list of all your mailboxes.
See also
$sidebar_width#
- Description:
Width of the sidebar
- Type:
- Notes:
- Default:
set sidebar_width = 30
This controls the width of the sidebar.
It is measured in screen columns.
For example: set sidebar_width = 20 could display 20 ASCII characters, or 10 Chinese characters.