From ArchWiki
Revision as of 23:23, 7 March 2010 by Trey (talk | contribs) (Added list of keybindings.)
Jump to: navigation, search

Template:Article summary start Template:Article summary text Template:Article summary end

Sup is a powerful new mail client developed for people who manage lots of mail. It can be viewed as a cross between Mutt and Gmail, with very fast operation and search, tagging, automatic contact management, support for a wide variety of accounts at once, and more.

Installing Sup

To install Sup, download it from the AUR here. For more information, see the AUR_User_Guidelines. Alternatively, users that have yaourt installed may run:

$ yaourt -S sup

This will automatically install gdbm, ruby-ncurses, and xapian-ruby-bindings. Otherwise, ensure these (as well as their dependencies, such as ruby) are installed to make installing sup as painless as possible.

Configuring Sup

Sup comes with an easy to use configuration tool called Template:Codeline. To use it, start it in the console and walk through the steps, which are as follows:

  1. Enter your full name.
  2. Enter your primary e-mail address, as well as any alternate e-mail addresses.
  3. Enter the path to your signature file, if you have one.
  4. Enter the editor that should be used to compose new mail, as well as any arguments that should be passed to it.
  5. Add sources for your mail, including:
    1. mbox files
    2. maildir directories
    3. remote mbox files over SSH
    4. IMAP servers

After this is done, Template:Codeline will execute the Template:Codeline command to import mail into your mailbox.

If you use POP3 or another mail service (not IMAP) and you don't have any external programs installed to handle mail retrieval, use a guide such as the one on the Mutt#POP3 wiki page, then select the mbox or maildir delivery option when configuring Sup. Sup is for the most part only an MUA (mail user agent) and, with the exception of IMAP, cannot handle downloading mail on its own.

Using Sup

Execute the Template:Codeline or Template:Codeline command to start the Sup mail client. The program should show the messages imported by Template:Codeline.

The most important key for new users to remember is the "?" key. This will display a full list of keyboard commands at any point, reminding new users how to navigate the program.

To navigate between threads, use the arrow keys or the "j" and "k" keys ("J" and "K" work like the Page Up and Page Down keys). To jump between threads with new messages, press the Tab key. Sup doesn't load all threads by default; press "M" to load more (more messages will automatically load to fill the window).

To view a thread, select it and press the Enter key. To expand or collapse an individual message while viewing a thread, select the message and press the Enter key. Press "N" to expand only new messages (the default view) or "E" to toggle the state of all messages. Press "o" to show or hide hidden parts of a message (such as signatures).

To navigate between messages in a thread, press the "n" and "p" keys. To display the headers on a message, press the "h" key.

To cycle through buffers, press the "b" key, or press the ";" key to view a list of all of the open buffers. To kill a buffer, press the "x" key.

To archive a thread, press the "a" key. This will hide it from the inbox until someone replies to it, at which point it will reappear. To kill a thread, press the "&" key. This is equivalent to Gmail's "mute" function, which hides a message even if people reply to it. It will never re-appear in the inbox, but it will still show up in search results.

To star a thread, press the "*" key. To mark a thread as spam, press the "S" key. Sup doesn't have any built-in spam filter; for that, consider a program such as SpamAssassin.

To tag a thread, press the "t" key. To label the messages in a thread, press the "l" key. To search labels, press the "L" key. Enter a label for which to search or press the Enter key to call up a list of labels. To perform a full text search, press the "\" key.

Backing-up and Restoring Sup

Backing-up e-mail is very important. To ensure that you don't lose anything, first back up the sources, such as mbox files and maildir directories, then run:

$ sup-dump > filename

This will back-up all message states in a text file. To restore your message states from this text file, simply run:

$ sup-sync [<source>+] --restored --restore filename

Just remember that the commands above only back-up and restore message states. The messages themselves will need to be backed-up separately.

List of Keybindings

Keybindings from inbox-mode

a : Archive thread (remove from inbox)
A : Archive thread (remove from inbox) and mark read

Keybindings from thread-index-mode

   M : Load 20 more threads
  !! : Load all threads (may list a _lot_ of threads)
  ^G : Cancel current search
   @ : Refresh view         
   * : Star or unstar all messages in thread
   N : Toggle new/read status of all messages in thread
   l : Edit or add labels for a thread          
   e : Edit message (drafts only)     
   S : Mark/unmark thread as spam
   d : Delete/undelete thread    
   & : Kill thread (never to be seen in inbox again)
   $ : Save changes now                          
 tab : Jump to next new thread
   r : Reply to latest message in a thread
   f : Forward latest message in a thread 
   t : Tag/untag selected thread
   T : Tag/untag all threads
   g : Tag matching threads
+, = : Apply next command to all tagged threads
   # : Force tagged threads to be joined into the same thread
   u : Undo the previous action

Keybindings from thread-view-mode

      h : Toggle detailed header
      H : Show full message header
      V : Show full message (raw form)
<enter> : Expand/collapse or activate item
      E : Expand/collapse all messages
      e : Edit draft
      y : Send draft
      l : Edit or add labels for a thread
      o : Expand/collapse all quotes in a message
      n : Jump to next open message
      p : Jump to previous open message
      z : Align current message in buffer
      * : Star or unstar message
      N : Toggle unread/read status of message
      r : Reply to a message
      f : Forward a message or attachment
      i : Edit alias/nickname for a person
      D : Edit message as new
      s : Save message/attachment to disk
      S : Search for messages from particular people
      m : Compose message to person
      ( : Subscribe to/unsubscribe from mailing list
      ) : Subscribe to/unsubscribe from mailing list
      | : Pipe message or attachment to a shell command
     .a : Archive this thread and kill buffer
     .d : Delete this thread and kill buffer
     .s : Mark this thread as spam and kill buffer
     .N : Mark this thread as unread and kill buffer
     ,a : Archive this thread, kill buffer, and view next
     ,d : Delete this thread, kill buffer, and view next
     ,s : Mark this thread as spam, kill buffer, and view next
     ,N : Mark this thread as unread, kill buffer, and view next
     ,n : Kill buffer, and view next
     ]a : Archive this thread, kill buffer, and view previous
     ]d : Delete this thread, kill buffer, and view previous
     ]s : Mark this thread as spam, kill buffer, and view previous
     ]N : Mark this thread as unread, kill buffer, and view previous
     ]n : Kill buffer, and view previous

Keybindings from contact-list-mode

   M : Load 10 more contacts
   D : Drop contact list and reload
a, i : Edit alias/or name for contact
   t : Tag/untag current line
   + : Apply next command to all tagged items
   S : Search for messages from particular people

Keybindings from line-cursor-mode

<down arrow>, j : Move cursor down one line
  <up arrow>, k : Move cursor up one line
        <enter> : Select this item

Keybindings from scroll-mode

                        J, ^E : Down one line
                        K, ^Y : Up one line
              <left arrow>, h : Left one column
                <right arrow> : Right one column
     <page down>, <space>, ^F : Down one page
<page up>, p, <backspace>, ^B : Up one page
                           ^D : Down one half page
                           ^U : Up one half page
                 <home>, ^, 1 : Jump to top
                     <end>, 0 : Jump to bottom
                            [ : Jump to the left
                            / : Search in current buffer
                            n : Jump to next search occurrence in buffer

Global keybindings

   q : Quit Sup, but ask first
   Q : Quit Sup immediately
   ? : Show help
   b : Switch to next buffer
   B : Switch to previous buffer
   x : Kill the current buffer
   ; : List all buffers
   C : List contacts
  ^L : Redraw screen
\, F : Search all messages
   U : Show all unread messages
   L : List labels
   P : Poll for new messages
m, c : Compose new message
  ^G : Do nothing
   R : Edit most recent draft message

More Information

Sup has a website with a README, a new user guide, a FAQ, and a philosophical statement, as well as a wiki.