Emai
====

emai is a Ncurses based (IMAP only currently) Emailclient written in ruby
(http://www.ruby-lang.org/) by Andy Hauser <buggs-emai@splashground.de>
in the year 2003 after the assumed birth of Jesus, because mutt sucks too ;-p.


License:
========

see LICENSE (BSD without advertising clause)

Contact:
========



Requirements:
=============

You need at least:

 emai
      the programm itself
      http://ftp.fortunaty.net/software/emai
      or if you want the current developement tree via subversion (svn)
      svn co https://fortunaty.net/svn/emai
      
 ruby
      Verison >= 1.8.0 (better 1.8.1)
      http://www.ruby-lang.org/
 
 ncurses-ruby
      probably >= 0.7.1
      http://developer.berlios.de/project/showfiles.php?group_id=273

 ossl 
      openssl for ruby >= 1.0.1 really! it will lock up with older versions,
      the one in ruby-1.8.0 will _not_ do as it keeps locking up :-(
      http://savannah.nongnu.org/download/rubypki/

 gpg
      dunno which should work
      you don't need real PKI (with keys and stuff) you can use
      gpg -c ( which uses symmetric encryption) possibly with
      --cipher-algo option to choose a better algorithm (BLOWFISH e.g.)
      http://www.gnupg.org/

 editor
      some way to write emails and edit your ~/.emai/accounts.gpg (a vim plugin e.g.)
      I use vim + gnupg.vim plugin:
      http://vim.sourceforge.net/scripts/script.php?script_id=661
      (Seems to have problems with csh shells)



Install:
========

  Modify Makefile to your suits and just execute:
    make install
 


First Time Usage:
=================

  Short version:
  start emai -> edit $HOME/.emai/accounts.gpg -> start emai
  
  Mac OSX: set TERM to xterm-color before starting.
  On first time usage $HOME/.emai/accounts.gpg
  will be created and the programm exits so you can
  edit that file with a gpg aware editor (password: emai).

  The most important thing is:
  Your account.conf["name"] _must_ match the hash key name in accounts.
  like:
  myaccount.conf["name"]   = blafasel
  accounts[myaccount.name] = myaccount
 

Usage:
======

  You can do 90% with the Arrow keys or their vi equivalents (h,j,k,l).
  They will open and close accounts, folders, mails ...

  KEY                 explanation
  ---                 ------------
     
  Arrow keys,       -> move around, open folder etc., next email, scroll
  h, j, k, l           depending on context (if in doubt use those)

  c                 -> change frame

  <TAB>             -> next new mail (those marked N)

  e                 -> edit email
  
  L                 -> list reply, only reply to mailing list
                       (uses "List-Post:" header field)

  g                 -> group reply email (be careful, read what emai produces!)
  
  Page_PP           -> page up

  Page_NP           -> next page
  
  SPACE             -> next ~half page (about)

  G                 -> last item
  
  :[0-9]+           -> jump to message number (e.g. :122)

  :d[0-9]+-[0-9]+   -> mark range deleted (e.g. :d1-10)

  /                 -> jump to next item containing following string
                       (like /money<ENTER>)

  n                 -> next match down

  N                 -> Next match up
  
  r                 -> reply email

  f                 -> forward email

  d                 -> mark "Deleted"

  C                 -> create Subfolder

  D                 -> delete Folder
  
  u                 -> unmark "Deleted"

  v                 -> visual selection (end with "d" which marks the visual as deleted)

  $                 -> expunge (delete mails marked as deleted
                       and synchronize with IMAP server)

  q                 -> quit


Unwanted Features:
=================

  Remember it's Alpha quality.
  STDERR is redirected to ~/.emai/err send relevant parts of that file
  (remove your confidential parts!) to the mailinglist
  emai-hackers@bayern.is.guad.de to get help.
  Or join us via irc on freenode and efnet in the #emai channel


Fleas:
======
  Only mutt has fleas, emai has unwanted features.



Have a lot of fun,
buggs