# Sup

> “Finally a mail client that does what we want, how we want it.”

> “Every other client we've tried is intolerable.”

> “It's just what I wanted, but I hadn't realized what I wanted until I saw it.”

> “Sup is almost to the point where I could jump ship from mutt.”

> “I was previously intrigued by a gmail-styled mutt-killer written in Ruby, but having actually spent a few hours reading the docs, and trying out all the keys, and reading the docs again, and trying the keys out again, and then actually engaging in a bunch of practice usage runs, I now officially can't fucking wait for the future of this thing; it has my full attention.”

Sup is a console-based email client for people with a lot of email. It supports tagging, very fast full-text search, automatic contact- list management, custom code insertion via a hook system, and more. If you're the type of person who treats email as an extension of your long-term memory, Sup is for you.

Sup makes it easy to:

- Handle massive amounts of email.
- Mix email from different sources: mbox files and maildirs. For remote sources (IMAP, IMAPS, ssh+file), use another tool (offlineimap, fetchmail, rsync) to grab local copies.
- Instantaneously search over your entire email collection. Search over body text, or use a query language to combine search predicates in any way.
- Handle multiple accounts. Replying to email sent to a particular account will use the correct SMTP server, signature, and from address.
- Add custom code to handle certain types of messages or to handle certain types of text within messages.
- Organize email with user-defined labels, automatically track recent contacts, and much more!

The goal of Sup is to become the email client of choice for nerds everywhere.

## Screenshots

## Documentation

Please read the README, the FAQ, the new user guide and the philosophical statement.

Please also read and contribute to the Sup wiki.

## Status

The current version of Sup is 0.12.1, released 2011-01-23. This is a beta release. It supports mbox and Maildir mailstores.

To be notified by email of Sup releases, subscribe to the sup-announce mailing list. One email per release.

Sup news can often be see on William's blog.

## Bug reports

Find a problem with Sup? Or have a feature you'd like to see? Submit it to the official Sup issue tracker.

## Getting it

You can download Sup releases from the Sup RubyForge page. If you have RubyGems installed, simply command your computer to "gem install sup".

If you're interested in development, you can clone the git repository like so: `git clone git://gitorious.org/sup/mainline.git`. You can also browse the Sup Gitorious repository. You may consider subscribing to the sup-devel list (below).

## Make some new friends

If you'd like to meet hot single Sup users in your area, try the sup-talk mailing list (archives).

If you'd like to meet some grumpy old programmers to talk about Sup internals with, try the sup-devel mailing list (archives).

## Credit

Sup is brought to you by William Morgan and the following honorable contributors:

- William Morgan
- Rich Lane
- Ismo Puustinen
- Nicolas Pouillard
- Eric Sherman
- Michael Stapelberg
- Ben Walton
- Mike Stipicevic
- Marcus Williams
- Lionel Ott
- Tero Tilus
- Ingmar Vanhassel
- Mark Alexander
- Gaute Hope
- Christopher Warrington
- W. Trevor King
- Gaudenz Steinlin
- Richard Brown
- Marc Hartstein
- Sascha Silbe
- Israel Herraiz
- Anthony Martinez
- Hamish Downer
- Bo Borgerson
- William Erik Baxter
- Michael Hamann
- Grant Hollingworth
- Adeodato Simó
- Daniel Schoepe
- Jason Petsod
- Steve Goldman
- Edward Z. Yang
- Decklin Foster
- Cameron Matheson
- Carl Worth
- Jeff Balogh
- Andrew Pimlott
- Alex Vandiver
- Peter Harkins
- Kornilios Kourtis
- Giorgio Lando
- Damien Leone
- Benoît PIERRE
- Alvaro Herrera
- Jonah
- Adam Lloyd
- Todd Eisenberger
- ian
- Steven Walter
- ian
- Jon M. Dugan
- Gregor Hoffleit
- Stefan Lundström
- Kirill Smelkov

Sup is made possible by the Xapian search engine, and by Matt Armstrong and his tragically abandoned RubyMail package.