README.md (3881B) - raw
1 # Sup
2
3 Sup is a console-based email client for people with a lot of email.
4
5 <img src="https://supmua.dev/images/old_screenshot_1.png" />
6
7 ## Installation
8
9 [See the wiki][Installation]
10
11 ## Features / Problems
12
13 Features:
14
15 * GMail-like thread-centered archiving, tagging and muting
16 * [Handling mail from multiple mbox and Maildir sources][sources]
17 * Blazing fast full-text search with a [rich query language][search]
18 * Multiple accounts - pick the right one when sending mail
19 * [Ruby-programmable hooks][hooks]
20 * Automatically tracking recent contacts
21
22 Current limitations:
23
24 * Sup does in general not play nicely with other mail clients, not all
25 changes can be synced back to the mail source. Refer to [Maildir Syncback][maildir-syncback]
26 in the wiki for this recently included feature. Maildir Syncback
27 allows you to sync back flag changes in messages and to write messages
28 to maildir sources.
29
30 * Unix-centrism in MIME attachment handling and in sendmail invocation.
31
32 ## Problems
33
34 Please report bugs to the [GitHub issue tracker](https://github.com/sup-heliotrope/sup/issues).
35
36 ## Links
37
38 * [Homepage](https://supmua.dev/)
39 * [Code repository](https://github.com/sup-heliotrope/sup)
40 * [Wiki](https://github.com/sup-heliotrope/sup/wiki)
41 * Mailing list: supmua@googlegroups.com
42 (subscribe: supmua+subscribe@googlegroups.com,
43 [archives](https://supmua.dev/lists/supmua/))
44
45 ## Maintenance status
46
47 Sup is a mature, production-quality mail client. The maintainers are also
48 long-term users, and mainly focus on preserving the current feature set. Pull
49 requests are very welcome, especially to fix bugs or improve compatibility,
50 however pull requests for major new features are unlikely to be merged.
51
52 ## Alternatives
53
54 If Sup is missing a feature you are interested in, it might be possible to
55 accomplish using Sup's [powerful hooks mechanism][hooks]. Otherwise, here are
56 some alternatives to consider:
57
58 * [Notmuch](https://notmuchmail.org/) was inspired by Sup. There are a wide
59 variety of [Notmuch clients](https://notmuchmail.org/frontends/) available.
60 The most similar to Sup's look-and-feel is
61 [Alot](https://github.com/pazz/alot) — also a curses-based front end.
62 Alot even ships with a
63 [built-in](https://github.com/pazz/alot/blob/master/extra/themes/sup)
64 [Sup theme](https://github.com/pazz/alot/wiki/Gallery#user-content-theme-sup)!
65
66 * [mu](https://www.djcbsoftware.nl/code/mu/) /
67 [mu4e](https://www.djcbsoftware.nl/code/mu/mu4e.html). Like Sup, a search-based
68 email back end, and also implemented using Xapian. The emacs-based front end
69 [is quite different](https://www.djcbsoftware.nl/code/mu/mu4e/Other-mail-clients.html).
70
71 ## License
72
73 ```
74 Copyright (c) 2013-- Sup developers.
75 Copyright (c) 2006--2009 William Morgan.
76
77 This program is free software; you can redistribute it and/or
78 modify it under the terms of the GNU General Public License
79 as published by the Free Software Foundation; either version 2
80 of the License, or (at your option) any later version.
81
82 This program is distributed in the hope that it will be useful,
83 but WITHOUT ANY WARRANTY; without even the implied warranty of
84 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
85 GNU General Public License for more details.
86
87 You should have received a copy of the GNU General Public License
88 along with this program; if not, write to the Free Software
89 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
90 02110-1301, USA.
91 ```
92
93 [sources]: https://github.com/sup-heliotrope/sup/wiki/Adding-sources
94 [hooks]: https://github.com/sup-heliotrope/sup/wiki/Hooks
95 [search]: https://github.com/sup-heliotrope/sup/wiki/Searching-your-mail
96 [Installation]: https://github.com/sup-heliotrope/sup/wiki#installation
97 [ruby20]: https://github.com/sup-heliotrope/sup/wiki/Development#sup-014
98 [maildir-syncback]: https://github.com/sup-heliotrope/sup/wiki/Using-sup-with-other-clients