https://github.com/mkcms/mu4e-overview

Show overview of maildir
https://github.com/mkcms/mu4e-overview

emacs list maildirs mu4e overview

Last synced: about 1 month ago
JSON representation

Show overview of maildir

• Host: GitHub
• URL: https://github.com/mkcms/mu4e-overview
• Owner: mkcms
• License: gpl-3.0
• Created: 2019-03-24T17:01:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-03T12:03:05.000Z (2 months ago)
• Last Synced: 2024-11-24T23:33:55.637Z (about 1 month ago)
• Topics: emacs, list, maildirs, mu4e, overview
• Language: Emacs Lisp
• Homepage:
• Size: 79.1 KB
• Stars: 16
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: LICENSE

Awesome Lists containing this project

README

        
# mu4e-overview.el - Show overview of maildir #

This Emacs package lets you see a hierarchy of maildirs in a separate buffer:

```

[email protected]

 [Gmail]

  .Trash [0/25]

  .Starred [0/0]

  .Spam [0/3]

  .Sent Mail [0/4]

  .Important [0/21]

  .Drafts [0/0]

  .All Mail [0/56]

 Trash [0/0]

 Inbox [2/45]

```

## Usage ##

`M-x mu4e-overview` displays a buffer with a list of all maildirs.  The root

maildir can be set via the variable `mu4e-maildir`.

The number of unread and total number of emails is displayed next to each

maildir in this format: `[UNREAD-COUNT/TOTAL-COUNT]`.  If UNREAD-COUNT is not

zero, that maildir is highlighted.

Use n and p keys to go to next/previous maildir (or alternatively,

tab/backtab).  Use [ and ] keys to go to previous/next *unread* maildir.

When you click on a maildir or type RET when point is on it, mu4e headers view

is displayed, which shows messages only in that maildir.  Type `C-u RET` to

show only unread messages.

## API ##

The package also provides the function `mu4e-overview-gather` which returns the

folder hierarchy and asynchronously counts the number of total and unread

counts for each folder.  This can be used to build a custom view of the folder

hierarchy.  See it's documentation for details.

## License ##

```

Copyright (C) 2019-2024 Michał Krzywkowski

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .

```