Home

Sup

Sup is an email client written in Ruby, originally by William Morgan, but now maintained and developed by the Sup community.

Installation

See below for platform specific instructions. Or you can refer to the general installation process.

Note that installing sup via both your native package manager and using instructions from this wiki will probably cause problems.

Migration and release specific instructions

• Migration-0.13-to-0.14 (or later)
• Using Sup with other clients (when upgrading to 0.15: optional maildir flag/state synchronization)
• Sup does not work (as of today 19. February 2017) with the current ruby 2.4.0 release, due to an incompatibility between the underlying xapian search enging and ruby 2.4.0. Until this incompatibility is fixed, use ruby 2.3 to run sup

Platform specific instructions

• Debian / Ubuntu
• Fedora
• Archlinux
• Mac OSX
• FreeBSD
• OpenBSD
• Windows: Not supported.

Note: We would like to encourage users of sup to contribute to and edit this wiki. If you discover erroneous information or if you use or configured sup in a way that may be valuable to others, please edit or add the information.

Basic Configuration and Getting Started

• New User Guide
• Complete gmail configuration - recommended if you haven't heard of Maildir before.
• Adding Sources
• Keyboard Reference
• Configuration Options
• Searching your mail
• Secure usage of Sup
• Using Sup with other clients (Maildir flag/state synchronization)

Configuring the way email leaves

• msmtp
• putmail
• sendEmail

Configuring the way email is retrieved

• OfflineIMAP
• mbsync/isync
• Fetchmail

Advanced Usage

• Adding Multiple Sources On The Same Server
• Multiple Accounts And Reply
• Hooks
• Reading HTML emails
• Indexing HTML emails
• Triggering Mail Collection
• Auto Add Labels To New Messages
• Notification Of New Messages
• Composing Hooks
• Viewing Attachments
• Clicking On Links
• Customizing Sup UI
• Customizing Keys
• Vim Integration
• Emacs Integration
• Customizing Colors
• Lbdb Integration
• Printing an email
• GPG
• File Formats
• Removing A Source
• Thunderbird Import
• Backing up the index
• Tune Ruby's GC params for a faster sup

Troubleshooting and Known Issues

• UTF-8 issues
• CtrlY
• YAML error while starting sup
• ncurses dependency update from 5 to 6

Sup development

• Development
• Contributing
• Running from git
• Heliotrope and Turnsole

Elsewhere

• Sup homepage
• supmua mailinglist General, development and announcements for sup. Subscribe through archive or send an email to: [email protected] (our old lists were closed with the shut down of Rubyforge - partly restored archives)
• IRC, #sup @ freenode.net

Meta

• The original Sup wiki was lost, more infomation: OriginalWiki
• Why sup ? A philosophical statement by the original creator, William Morgan on why sup was born.