The Sidebar shows a list of all your mailboxes. The list can be turned
on and off, it can be themed and the list style can be configured.

Beginner-friendly howto:
    https://flatcap.org/mutt/manual.html#intro-sidebar

Full Reference:
    https://github.com/neomutt/neomutt/wiki/sidebar

## Updates

This version of Sidebar started as Terry Chan's 2015-11-11 release.
In addition it now has:

 * Lots of new features
    - Mailbox sorting
    - Separation of open/highlighted mailboxes
    - Toggle visible function
    - Flexible colours
    - Options to filter display of mailboxes
    - Flexible parsing/indenting of mailbox names

 * Lots of bug fixes
    - Fixed utf-8 support
    - Handle "unmailboxes *" safely
    - Check all pointers
    - Refresh -- time overflowed short

 * Comprehensive Documentation
    - Beginners' Howto
    - Full Reference Guide

 * Code Overhaul
    - Tidied
    - Conditional compilation (configure --enable-sidebar)
    - Refactoring to reduce complexity
    - Commented functions
    - Made more robust

## Features

The Sidebar shows a list of mailboxes in a panel.
Everything about the Sidebar can be configured.

State of the Sidebar
 * Visibility
 * Width

Which mailboxes are displayed
 * Display all
 * Limit to mailboxes with new mail
 * Whitelist mailboxes to display always

The order in which mailboxes are displayed
 * Unsorted (order of mailboxes commands)
 * Sorted alphabetically
 * Sorted by number of new mails

Color
 * Sidebar indicators and divider
 * Mailboxes depending on their type
 * Mailboxes depending on their contents

Key bindings
 * Hide/Unhide the Sidebar
 * Select previous/next mailbox
 * Select previous/next mailbox with new mail
 * Page up/down through a list of mailboxes

Misc
 * Formatting string for mailbox
 * Wraparound searching
 * Flexible mailbox abbreviations
 * Support for Unicode mailbox names (utf-8)

## Bug Fixes

These bugs have been fixed since the previous Sidebar release: 2015-11-11.

 * Fix bug when starting in compose mode
 * Fix bug with empty sidebar_divider_char string
 * Fix bug with header wrapping
 * Correctly handle utf8 character sequences
 * Fix a bug in mh_buffy_update
 * Fix refresh -- time overflowed short
 * Protect against empty format strings
 * Limit Sidebar width to COLS
 * Handle unmailboxes * safely
 * Refresh Sidebar after timeout

## Config Changes

Some of the Sidebar config has been changed to make its meaning clearer.
These changes have been made since the previous Sidebar release:
2015-11-11.

| Old Name               | New Name                |
|------------------------|-------------------------|
| $sidebar_delim         | $sidebar_divider_char   |
| $sidebar_folderindent  | $sidebar_folder_indent  |
| $sidebar_indentstr     | $sidebar_indent_string  |
| $sidebar_newmail_only  | $sidebar_new_mail_only  |
| $sidebar_refresh       | $sidebar_refresh_time   |
| $sidebar_shortpath     | $sidebar_short_path     |
| $sidebar_sort          | $sidebar_sort_method    |
| <sidebar-scroll-down>  | <sidebar-page-down>     |
| <sidebar-scroll-up>    | <sidebar-page-up>       |

-- 
Rich Russon (FlatCap) <r...@flatcap.org>

Reply via email to