Sylpheed-Claws - a GTK+ based, lightweight, and fast e-mail client --------------------------------------------------------------------- Copyright(C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws Team This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. For more details see the file COPYING. --------------------------------------------------------------------- Summary: 1. What is Sylpheed-Claws? 2. Plugins 3. Actions 4. Icon Themes 5. Spell Checking 6. Quick Search 7. Custom toolbar 8. Partial downloading of POP3 mails 9. Hidden Options 10. Tools 11. How to contribute 12. How to request features 13. Installing Claws from CVS 14. Release History 15. Useful Links 1. What is Sylpheed-Claws? -------------------------- Sylpheed-Claws is the extended version of Sylpheed, a lightweight and highly configurable email client and news reader based on the GTK+ GUI toolkit, it runs on the X Window System. Sylpheed-Claws is free software distributed under the GNU GPL. To run Sylpheed-Claws use 'sylpheed-claws' on the command line. When sylpheed-claws is executed for the first time a configuration 'Wizard' will appear prompting you for the minimum information necesary to create a new account. 2. Plugins ---------- Sylpheed-Claws' capabilities are extended by plugins. It comes with the following plugins included, all of which, except SpamAssassin, are built automatically if the required libraries are present. Plugins are installed in $PREFIX/lib/sylpheed-claws/plugins/ and have a suffix of '.so' To load a plugin go to '/Configuration/Plugins' and click the 'Load Plugin' button. Select the plugin that you want and click 'OK' o Clam AntiVirus Enables the scanning of message attachments in mail received from a POP, IMAP or LOCAL account using Clam AntiVirus. It can optionally delete the mail or save it to a designated folder. Preferences can be found in '/Configuration/PreferencesPlugins/Clam AntiVirus'. Clam AntiVirus is available from http://clamav.sourceforge.net/ o Dillo HTML Viewer Enables the viewing of html messages using the Dillo web browser, version 0.7.0 or newer. It uses Dillo's --local option by default for safe browsing. Preferences can be found in '/Configuration/Preferences/Plugins/Dillo Browser'. Dillo is available from http://www.dillo.org/ o PGP/Core Handles core PGP functions and is required by the PGP/Inline and PGP/MIME plugins. Uses GnuPG/GPGME, o PGP/inline Handles inline PGP signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME, o PGP/MIME Handles PGP/MIME signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME, o SpamAssassin Enables the scanning of incoming mail received from a POP, IMAP or LOCAL account using SpamAssassin. It can optionally delete mail identified as spam or save it to a designated folder. Preferences can be found in '/Configuration/ Preferences/Plugins/SpamAssassin'. SpamAssassin is available from http://spamassassin.apache.org/. o Trayicon Places an icon in the system tray that indicates whether you have any new mail. A tooltip also shows the current new, unread and total number of messages Additonal plugins can be found here: http://www.sylpheed-claws.net/plugins.php 3. Actions ---------- The "actions" feature is a convenient way for the user to launch external commands to process a complete message file including headers and body or just one of its parts. It allows also the use of an external command to filter the whole text or just a selected part in the message window or in the compose window. This is a generic tool that allows to do any uncommon actions on the messages, and thus extends the possibilities of Sylpheed-Claws. For example, Sylpheed-Claws does not include the rot13 cyphering algorithm popular in some newsgroups. It does not support uuencoded messages. As all these features can be handled by external programs, the actions provide a convenient way to use them from the menu bar. a. Usage -------- To create a new action, go to Configuration -> Actions.... The "Action Creation" dialog offers to enter the Menu name that will trigger the command. The created menu will be found in the Tools -> Actions submenu. By inserting a slash / in the menu name, you create a submenu. The command is entered in the Command line entry. Note that Sylpheed-Claws stores every single email in a separate file. This allows to use the following syntax for the command: * %f denotes the file name of the selected message. If you selected more than one, then the command will be launched for each message with the appropriate file name * %F denotes the list of the file names of the selected message. If only one message is selected, this amounts to %f, but if more messages are selected, then the command will be launched only once with the list of the file names. (You can use both %f and %F in one command: then the command will be launched for each selected message with the name of this message and with the list of all selected messages. I did not find a practical example for this.) * %p denotes the current selected message part of a multipart message. The part is decoded accordingly. If the message is not a multipart message, it denotes the message body. * Prepending >: this will allow you to send to the command's standard input a text that you will enter in a dialog window. * Prepending *: this will allow you to send to the command's standard input a text that you will enter in a dialog window. But in contrast to prepending >, the entered text is hidden (useful when entering passwords). * Appending an ampersand &: this will run the command asynchronously. That means "fire and forget". Sylpheed-Claws won't wait for the command to finish, nor will it catch its output or its error messages. * Prepending the vertical bar | (pipe-in): this will send the current displayed text or the current selected text from the message view or the compose window to the command standard input. The command will silently fail if more than one message is selected. * Appending the vertical bar | (pipe-out): this will replace the current displayed text or the current selected text from the message window or the compose window by the command standard output. The command will silently fail if more than one message is selected. Note: It is not possible to use actions containing %f, %F or %p from the compose window. When a command is run, and unless it is run asynchronously, Sylpheed will be insensitive to any interaction and it will wait for the command to finish. If the command takes too long (5 seconds), it will popup a dialog window allowing to stop it. This dialog will also be displayed as soon as the command has some output: error messages or even its standard output when the command is not a "pipe-out" command. When multiple commands are being run, they are run in parallel and each command output is separated from the outputs of the others. a. Examples ----------- Here are some examples that are listed in the same syntax as used for storing the actions list. You can copy and past the definition in your ~/.sylpheed-claws/actionsrc file (exit Sylpheed-Claws before). The syntax is very simple: one line per action, each action contains the menu name and the command line separated by a colon and a space ": " Purpose: rot13 cyphering Definition: Rot13: |tr a-zA-Z n-za-mN-ZA-M| Details: This will apply the rot13 cyphering algorithm to the (selected) text in the message/compose view. Purpose: Decoding uuencoded messages Definition: UUdeview: xdeview %F& Details: xdeview comes with uudeview. If an encoded file is split in multiple messages, just select them all and run the command. Purpose: Display uuencoded image Definition: Display uuencoded: uudec %f& Details: Displays uuencoded files. The uudec[1] script can be found in the 'tools' directory of the distribution package. Purpose: Alter messages Definition: Edit message: gvim -f %F Details: Allows editing of any received message. Can be used to remove unneeded message parts, etc. Purpose: Pretty format Definition: Par: |par 72Tbgjqw74bEe B=._A_a 72bg| Details: par is a utility that can pretty format any text. It does a very good job in indenting quoted messages, and justifying text. Used when composing a message Purpose: Browse Definition: Part/Dillo: dillo %p& Details: Browse the selected message part in Dillo. Purpose: Clear Sign Definition: GnuPG/Clear Sign: |gpg-sign-syl| Details: Clear sign a message. The gpg-sign-syl[2] script is responsible for asking the passphrase and for running gnupg. Purpose: Verify Clear Signed Definition: GnuPG/Verify: |gpg --no-tty --verify Details: Verify clear signed messages. The result is displayed in the actions output dialog. Purpose: Decrypt ASCII Armored Definition: GnuPG/Decrypt: *gpg --no-tty --command-fd 0 --passphrase-fd 0 --decrypt %f| Details: Decrypt ASCII armored messages. The passphrase is entered into the opened action's input dialog. [1] The uudec script can be found in the 'tools' directory of the distribution package. It needs uudecode and ImageMagick's display. The latter can be replaced by any image viewer that can get input from standard input. The script could also be modified to use temporary files instead of standard input. [2] The gpg-sign-syl script can be found in the 'tools' directory of the distribution package. 4. Icon Themes -------------- Claws has support for different icon sets. Several icon sets can be downloaded from http://www.sylpheed-claws.net/themes.php You will need to create a directory called 'themes' in your config directory, unpack them into this directory, and then use the interface to select them, /Configuration/Preferences/Display/Themes This interface can also be used to install new themes. 5. Spell Checking ----------------- a. Requirements b. Configuration and installation c. Usage d. Known problems a. Requirements --------------- The spell checker in Sylpheed-Claws requires the GNU/aspell library (http://www.gnu.org/software/aspell), version 0.50 or newer. You also need the dictionaries. Check GNU/aspell home page for how to download and install them. NB: The old dictionaries used by the old aspell will not work. b. Configuring Claws -------------------- Spell checking is enabled automatically if the aspell executable is found. If it is in unusual places, use '--with-aspell-prefix' to state the path to the aspell executable. E.g., if aspell's full path is /foo/bar/bin/aspell, then use: ./configure --with-aspell-prefix=/foo/bar The '--with-aspell-prefix=PREFIX' option will let the configure script search for includes and libraries in PREFIX/include and PREFIX/lib. You can also manually specify the includes and libraries path by using either following options: --with-aspell-includes=/foo/bar/include and/or --with-aspell-libs=/rab/oof/lib as appropriate. The configure script summarizes the options compiled in. Check that it lists 'GNU/aspell = yes'. Then proceed as usual, with 'make' and 'make install'. c. Usage -------- After successful compiling, you need to tell Sylpheed-Claws where your dictionaries reside. The configure script should have found it, but in case it did not, run 'aspell config dict-dir' on the shell to get the path to the dictionaries. Then run Sylpheed and go to /Configuration/Preferences/Compose/Spell Checking. Check the box 'Enable spell checker' and use the directory selector to select the path where the dictionaries reside. Within the file selector, go to that directory and select *any* file in the file lists. Click OK. Then, you should be able to select your default dictionary. When composing, misspelled words are highlighted. Click on any highlighted word with the right mouse button to get a list of suggestions. The first entry of the menu just displays the unknown word. Selecting 'Accept in this session' (or hitting MOD1-Space, where MOD1 is usually the ALT key) will ignore this word and accept it in this message. Selecting the next entry, "Add to dictionary", which is bound to MOD1-Enter combination, will add the unknown word to your personal dictionary to learn it. The next entries are the suggested words. The first 15 suggestions can be accessed by typing one of the first letters of Latin alphabet (if this does not suit your language, please send a mail to melvin.hadasht@free.fr). Aspell has a 'learn from mistake' function that can be used by pressing the MOD1 key and selecting the suggestion (with the keyboard or with the mouse). See GNU/aspell manual §6.3 for an explanation of this feature (also called 'replacement storing'). If you click with the right mouse button everywhere else, or if you shift-right-click even on a misspelled word, you get the configuration menu. 'Check all' highlights all misspelled words. With this menu, you can also change the dictionary while editing. Finally, you can change the suggestion mode, and the learn from misktakes feature. Spell checking can also be done using keyboard shortcuts. In the 'Edit' menu of the compose window, there are two menus 'Check backwards misspelled word' and 'Forward to next misspelled word'. Add to them appropriate keyboard shortcuts. 'Check backwards misspelled word' checks backwards from cursor position for the first misspelled word. If it finds one, it displays the suggestions lists which can be handled with the keyboard as described before. When the suggestion menu is closed, the cursor returns to its original position to be able to continue editing. The 'Forward to next misspelled word' do the same thing in the other direction but moves the cursor at the end of the misspelled word. This way, you can spell check easily a whole message starting from its beginning and using the 'Forward to next misspelled word' keyboard short cut. 6. Quick Search with extended search ------------------------------------ Quick Search, with its powerful Extended search function, enables searching through folder's messages. Extended Search allows one to define criteria that messages must have in order to match and be displayed in the summary view pane. Search types titled From, Subject and To are self explanatory. Search type extended allows one to use Sylpheed's powerful filtering engine to select messages. Examples: from regexpcase "foo" subject regexp "Bug" & to regexp "sylpheed-claws" Additionally, it is possible to use simpler yet equally powerfull patterns for message selections. Mutt users will immediately recognise most of the available patterns: Pattern Parameter Selects ---------------------------------------------------- a all messages ag # messages whose age is greater than # al # messages whose age is lower than # b S messages which contain S in the message body B S messages which contain S in the whole message c S messages carbon-copied to S C S message is either to: or cc: to S D deleted messages e S messages which contain S in the Sender field E S true if execute "S" succeeds f S messages originating from user S F forwarded messages h S messages which contain header S i S messages which contain S in Message-Id header I S messages which contain S in inreplyto header L locked messages n S messages which are in newsgroup S N new messages O old messages r messages which have been replied to R read messages s S messages which contain S in subject se # messages whose score is equal to # sg # messages whose score is greater than # sl # messages whose score is lower than # Se # messages whose size is equal to # Sg # messages whose size is greater than # Ss # messages whose size is smaller than # t S messages which have been sent to S T marked messages U unread messages x S messages which contain S in References header y S messages which contain S in X-Label header # means number S means regexp string It is possible to use logical operators AND (&), OR (|) and NOT (! or ~). Case sensitive search is achieved with %. Examples: T marked messages U unread messages f "john beavis" messages from john beavis %f "John Beavis" messages from John Beavis (case sensitive) ~s foo messages which do not have foo in the subject f foo & ~s bar messages from foo that do not have bar in thesubject 7. Custom toolbar ----------------- /Configuration/Preferences/Customize Toolbars lets you define the toolbar you want. The configuration dialog enables you to set an icon, an appropriate text, and map an action to it. Actions to choose from are predefined. You can also have your "Sylpheed-Claws Actions" (refer to "Actions" above) on your toolbar. Example: * Configuration->Actions - add an entry "Dillo: dillo %p&" * Configuration->Custom toolbar - select Sylpheed Actions Feature - select "Dillo: dillo %p&" from drop down list - choose an icon and click ok 8. Partial downloading of POP3 mails ------------------------------------ Messages over the configured size limit, (/[Account preferences]/ Receive/Message size limit), will be partially retrieved. These messages will have a Notice View displayed (above the Message View), informing of the partially retrieved state and the total size of the message. The Notice View will also contain two buttons, 'Mark for download' and 'Mark for deletion'. If the user clicks 'Mark for download', the message will be downloaded in full at the next message retrieval, (and the partial one deleted); if the user checks 'Mark for deletion' it will be removed from the server after the normal delay as specified in the POP3 account's 'Receive' preferences. If a user moves a partially retrieved message to the Trash folder it will be deleted on the server at the next retrieval after the Trash folder has been emptied. 9. Hidden options ----------------- allow_jisx0201_kana (default: 0) allow JIS X 0201 Kana (half-width kana) on sending. 0: off 1: on bold_unread (default: 1) show unread messages using bold font in summary view 0: off 1: on cache_max_mem_usage (default: 4096) the maximum kB of memory sylpheed should use. It will try to keep the memory usage below this value, but it will always use the assigned amount of memory for speed gain. cache_min_keep_time (default: 15) the minimum time in minutes sylpheed will keep the folder cache in memory. If a cache is more recent than this time it will not be freed even if the memory usage is above the maximum. You should probably set this value higher than your mail check interval. Otherwise the cache will always be freed between checks even if the folder is accessed on every check, which will cause much disk IO. compose_no_markup (default: 0) prevent italic and bold text in the Compose dialog account selector 0: normal (markup) 1: no markup enable_hscrollbar (default: 1) enable horizontal scroll bar in summary view 0: off 1: on enable_rules_hint (default: 1) enable alternate coloring of items in GtkTreeView 0: off 1: on enable_swap_from (default: 0) display sender's email address in To column in Sent folder instead of recipient's 0: off 1: on folderview_vscrollbar_policy (default: 0) specify the policy of vertical scroll bar of folder view 0: always 1: automatic 2: never hover_timeout (default: 500) time in milliseconds that will cause a folder tree to expand during drag n drop when the mouse cover is held over it statusbar_update_step (default: 10) update stepping in progress bars textview_cursor_visible (default: 0) display the cursor in the message view 0: off 1: on thread_by_subject_max_age (default: 10) number of days to include a message in a thread when using 'Thread using subject in addition to standard headers' toolbar_detachable (default: 0) hide handles in the toolbar 0: off 1: on utf8_instead_of_locale_for_broken_mail (default: 0) use UTF-8 encoding for broken mails instead of current locale 0: off 1: on warn_dnd (default: 1) display a confirmation dialog on drag n drop of folders 0: off 1: on 10. Tools --------- You will find all of these tools in the 'tools' directory: acroread2sylpheed.pl send PDFs from Adobe Reader 7 calypso_convert.pl import mbox files exported by calypso convert_mbox.pl convert mbox format to MH format eud2gc.py convert a Eudora (v.3?) addressbook to vCard (GnomeCard) format filter_conv.pl convert sylpheed main's filter rules, (< 0.9.99), into Claws' filtering format filter_conv_new.pl convert sylpheed main's filter rules, (>= 0.9.99), into Claws' filtering format freshmeat_search.pl Actions script to lookup the selected text on Freshmeat www.freshmeat.net using the configured browser gif2xface.pl convert a gif file to an xface google_msgid.pl Actions script to lookup selected message-id on google using mozilla. google_search.pl Actions script to lookup up the selected text on google using the configured browser gpg-sign-syl GnuPG cleartext-signing script for use with Actions kdeservicemenu/* Service Menus for Konqueror to allow attaching files and compressing/attaching files/directories to a new Compose window kmail2sylpheed.pl convert a Kmail addressbook to a Sylpheed addressbook kmail2sylpheed_v2.pl new version of the address book conversion script for newer versions of Kmail/Kaddressbook maildir2sylpheed.pl convert a maildir format mailbox into MH format multiwebsearch.pl search any searchable website for the selected text nautilus2sylpheed.sh enables sending files from the Nautilus file manager to Sylpheed OOo2sylpheed.pl enable OpenOffice to send documents through sylpheed outlook2sylpheed.pl convert an Outlook contacts list to a Sylpheed addressbook sylprint.pl process a Sylpheed mail and print it using enscript if available or lpr if not tb2sylpheed convert an addressbook exported from The Bat! into a Sylpheed addressbook tbird2syl.py integrate a Thunderbird folder tree into Claws textviewer.sh attempt to view an attachment as plain text update-po translators' tool that eases the creation of *.po files uudec decode UUencoded mails, for use with Actions vcard2xml import an Evolution vCard 11. How to contribute --------------------- You are encourged to send patches via the Sylpheed-Claws sourceforge project's Patch Tracker. http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse If that's too troublesome, either contact Paul Mangan or consider posting to the Sylpheed-Claws-users mailing list. http://www.sylpheed-claws.net/MLs.php Bugs can be reported with Claws' bugzilla at: http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi Of course, you can also post to the Sylpheed-Claws-users mailing list. Also, we really try to incorporate good contributions, but sometimes we don't have enough time. If the contribution is really big, or requires a long time to stabilise, send a mail to Paul Mangan . We can probably arrange access to the Sylpheed-Claws CVS tree. 12. How to request features --------------------------- Ask around in Sylpheed-Claws-users ML. Note that some developers may have already thought about your feature, may,perhaps, be implementing it, or the feature was already discussed and rejected for whatever reason. You might want to go ahead and hack a patch for it. (That would be very cool!) Another possibility is to use the Feature Request Tracker at the sourceforge project. http://sourceforge.net/tracker/?group_id=25528&atid=384601 13. Installing Sylpheed-Claws from CVS -------------------------------------- a. Downloading -------------- To download the latest cvs cd to the directory where you wish to download to and type the following information: cvs -z3 -d:pserver:cvs@sunsite.dk:/pack/anoncvs login The password is cvs After logging in: cvs -z3 -d:pserver:cvs@sunsite.dk:/pack/anoncvs co -r gtk2 sylpheedclaws/sylpheed-claws b. Installing ------------- To compile and install use the following commands: ./autogen.sh [add configure options as required] make make install [as root] You will need a full set of development tools installed to be able to run autogen.sh. See also ac/README. 14. Release History ------------------- GTK 2 Version ------------- 2006-10-11 2.5.4 2006-10-04 2.5.3 2006-09-26 2.5.2 2006-09-26 2.5.1 2006-09-25 2.5.0 2006-07-31 2.4.0 2006-06-20 2.3.1 2006-06-12 2.3.0 2006-06-08 2.2.3 2006-06-06 2.2.2 2006-06-05 2.2.1 2006-05-08 2.2.0 2006-04-17 2.1.1 2006-04-05 2.1.0 2006-01-30 2.0.0 2005-11-08 1.9.100 2005-10-31 1.9.99 2005-10-03 1.9.15 2005-09-05 1.9.14 2005-07-22 1.9.13 2005-06-27 1.9.12 2005-05-19 1.9.11 2005-05-09 1.9.9 2005-03-18 1.9.6 GTK 1 Version ------------- 2005-06-27 1.0.5 2005-05-09 1.0.4a 2005-03-24 1.0.4 2005-03-10 1.0.3 2005-02-08 1.0.1 2005-01-17 1.0.0 2004-12-06 0.9.13 2004-09-27 0.9.12b 2004-08-23 0.9.12a 2004-06-28 0.9.12 2004-05-31 0.9.11claws 2004-03-08 0.9.10claws 2004-02-06 0.9.9claws 2003-12-19 0.9.8claws 2003-11-26 0.9.7claws 2003-10-02 0.9.6claws 2003-09-10 0.9.5claws 2003-08-04 0.9.4claws 2003-07-12 0.9.3claws 2003-05-24 0.9.0claws 2003-03-12 0.8.11claws 2003-02-12 0.8.10claws 2003-01-24 0.8.9claws 2002-12-26 0.8.8claws 2002-12-23 0.8.7claws 2002-11-25 0.8.6claws 2002-10-07 0.8.5claws 2002-09-22 0.8.3claws 2002-08-28 0.8.2claws 2002-07-30 0.8.1claws 2002-07-23 0.8.0claws 2002-06-15 0.7.8claws 2002-05-18 0.7.6claws 2002-04-28 0.7.5claws 2002-03-11 0.7.4claws 2002-02-19 0.7.2claws 2002-02-14 0.7.1claws 2002-01-14 0.7.0claws 2001-12-16 0.6.6claws 2001-10-16 0.6.5claws8 2001-09-30 0.6.2claws 2001-08-14 0.6.1claws 2001-07-13 0.5.1claws 2001-07-01 0.5.0claws3 2001-06-16 0.4.99claws 2001-05-29 0.4.99claws3 2001-05-11 0.4.67claws1 15. Useful links ---------------- Homepage http://www.sylpheed-claws.net/ User Contributed FAQ http://www.sylpheed-claws.net/faq/ Project page http://sourceforge.net/projects/sylpheed-claws/ Downloads http://sourceforge.net/project/showfiles.php?group_id=25528&package_id=147457 Extra Plugins http://www.sylpheed-claws.net/plugins.php Icon Themes http://www.sylpheed-claws.net/themes.php CVS webview http://cvs.sunsite.dk/viewcvs.cgi/sylpheedclaws/sylpheed-claws/?only_with_tag=gtk2 Mailing Lists http://www.sylpheed-claws.net/MLs.php Users Mailing List archive http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/28 Commits Announcement List archive http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/27 Bug Tracker http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi Feature Request Tracker http://sourceforge.net/tracker/?group_id=25528&atid=384601 Patch Tracker http://sourceforge.net/tracker/?group_id=25528&atid=384600 Internationalisation Status http://www.sylpheed-claws.net/i18n.php Donations http://www.sylpheed-claws.net/sponsors.php Planet Sylpheed http://planet.sylpheed-claws.net/ Sylpheed-Claws for Windows homepage http://www.sylpheed-claws.net/win32/