RSSyl: Copy RFolderItem private data properly.
[claws.git] / README
1 Claws Mail - a GTK+ based, lightweight, and fast e-mail client
2
3 ---------------------------------------------------------------------
4
5    Copyright(C) 1999-2014 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
6    Claws Mail Team
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3, or (at your option)
11    any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
21    MA 02110-1301, USA.
22
23    For more details see the file COPYING.
24
25 ---------------------------------------------------------------------
26
27 Summary:
28
29  1. What is Claws Mail?
30  2. Plugins
31  3. Actions
32  4. Icon Themes
33  5. Quick Search
34  6. Custom toolbar
35  7. Partial downloading of POP3 mails
36  8. Hidden Options
37  9. Tools
38 10. How to contribute
39 11. How to request features
40 12. Installing Claws from Git
41 13. Release History
42 14. Useful Links
43
44
45 1. What is Claws Mail?
46 --------------------------
47
48 Claws Mail (previously known as Sylpheed-Claws) is a lightweight and
49 highly configurable email client and news reader based on the GTK+
50 GUI toolkit, it runs on the X Window System.
51
52 Claws Mail is free software distributed under the GNU GPL.
53
54 To run Claws Mail use 'claws-mail' on the command line.
55
56 When claws-mail is executed for the first time a configuration
57 'Wizard' will appear prompting you for the minimum information
58 necessary to create a new account.
59
60
61 2. Plugins
62 ----------
63
64 Claws Mail' capabilities are extended by plugins. It comes with
65 the following plugins included, all of which are built automatically
66 if the required libraries are present.
67
68 Plugins are installed in $PREFIX/lib/claws-mail/plugins/
69 and have a suffix of '.so'
70 To load a plugin go to '/Configuration/Plugins' and click
71 the 'Load Plugin' button.
72 Select the plugin that you want and click 'OK'
73
74 All plugin preferences can be found under
75 '/Configuration/Preferences/Plugins/'.
76
77   o ACPI Notifier
78     Notifies of new mail via the mail LED available on some laptops. The 
79     LED can be set to blinking or on states when new mail is received. 
80     Appropriate kernel modules have to be loaded first for this plugin to 
81     work. Laptops supported are from ACER (acerhk and acer_acpi modules), 
82     ASUS (asus_laptop and asus_acpi), IBM (ibm_acpi), Lenovo (tm_smapi) 
83     and Fujitsu (apanel) manufacturers.
84
85   o Address Keeper
86     Saves mail addresses typed in the 'To', 'Cc' or 'Bcc' fields of 
87     outgoing messages to a designated folder in the address book. 
88     Addresses are saved only if not already present in the address book.
89
90   o Archiver
91     Archives mail folders using libarchive library. Folders can be archived 
92     with or without compression (ZIP, GZIP or BZIP2) and also in several 
93     formats (TAR, SHAR, PAX or CPIO).
94     Libarchive is available from http://www.libarchive.org/.
95
96   o Attachment Remover
97     Selectively removes attachments from messages. Messages are permanently 
98     modified by using this feature, so be careful!
99
100   o Attachment Warning
101     Warns the user of possibly forgotten attachments when some keywords 
102     are found in the outgoing messages. False positives (being warned when 
103     no attachment is realy needed) exist, but some configuration options 
104     can help to reduce their probability.
105
106   o Bogofilter
107     Enables the scanning of incoming mail received from a POP,
108     IMAP, or LOCAL account using Bogofilter. It can optionally
109     delete mail identified as spam or save it to a designated folder.
110     Bogofilter is a pure Bayesian filter, therefore it has better
111     speed performance than SpamAssassin but might catch less spam.
112     Bogofilter is available from http://bogofilter.sourceforge.net/.
113  
114   o BSFilter
115     Checks all messages received from IMAP, POP or local accounts using 
116     BSFilter, a bayesian spam filter program, which has to be installed 
117     locally. Messages identified as spam can be deleted or saved to a 
118     designated folder. 
119     Bsfilter is available from http://sourceforge.jp/projects/bsfilter/.
120
121   o Clamd
122     Uses the Clam AntiVirus in daemon mode to scan received messages from 
123     IMAP, POP or local accounts. Scanning is done through a socket to the 
124     daemon, so it has to be previously configured to allow this. 
125     Clam AntiVirus is available from http://www.clamav.net/.
126
127   o Fetchinfo
128     Modifies downloaded messages and inserts special headers containing 
129     some download information: UIDL, Claws Mail account name, POP server, 
130     user ID and retrieval time. These headers can be used later for more 
131     elaborate filtering or processing rules.
132
133   o Fancy
134     Renders HTML mails and HTML parts of multipart messages using the GTK+ 
135     port of the WebKit library. External content is blocked by default 
136     (including images) to avoid remote tracking, but can be enabled either 
137     globally or just on the displayed message.
138     GTK+ WebKit is available from http://trac.webkit.org/wiki/WebKitGTK/.
139
140   o GData
141     Includes your Gmail account contacts in the list generated for 
142     Tab-address completion on compose window, using the GData library.
143     Gdata library is available from https://live.gnome.org/libgdata/.
144
145   o MailMbox
146     Handles mailboxes in Mbox format using the libEtPan! library. Mbox 
147     files can be added to the folder tree and used like regular mailboxes.
148     LibEtPan! is available from http://www.etpan.org/.
149
150   o Newmail
151     Writes a header summary to a log file for each mail received after 
152     sorting. The file for the summary is ~/Mail/NewLog.
153
154   o Notification
155     Provides various ways of notifying the user of new and unread email. 
156     Current methods include: a banner, a popup window, a user command, 
157     a message to a LCD daemon, a system tray icon and an indicator icon.
158     Sound notifications are also possible through libcanberra. Each method 
159     can be customized in detail through the plugin preferences.
160     Indicator library is available from https://launchpad.net/libindicator/
161     and libcanberra from http://0pointer.de/lennart/projects/libcanberra/.
162
163   o Perl
164     Extends the filtering possibilities of Claws Mail. Provides a Perl 5 
165     interface to Claws Mail's filtering mechanism, allowing the use of full 
166     Perl power in email filters. A conversion script is provided to 
167     translate user rules into perl rules suitable for this plugin. 
168     Perl is available from http://www.perl.org/.
169
170   o PDF Viewer
171     Displays Portable Document Format (PDF) and PostScript attachments 
172     within the message view using Poppler. PostScript attachments are 
173     converted to PDF on the fly by the 'gs' tool, which has to be installed 
174     first. The 'gs' tool is available from http://pages.cs.wisc.edu/~ghost/.
175     The Poppler library is available from http://poppler.freedesktop.org/.
176         
177   o PGP/Core
178     Handles core PGP functions and is required by the PGP/Inline
179     and PGP/MIME plugins.
180     Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
181
182   o PGP/inline
183     Handles inline PGP signed and/or encrypted mails. You can
184     decrypt mails, verify signatures or sign and encrypt your
185     own mails. Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
186
187   o PGP/MIME
188     Handles PGP/MIME signed and/or encrypted mails. You can
189     decrypt mails, verify signatures or sign and encrypt your
190     own mails. Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
191
192   o Python
193     Provides Python scripting access to Claws Mail functions. A testing 
194     console is also featured. Scripts can be saved to specific folders 
195     for automatic loading on startup or being available as new menu items 
196     under the '/Tools/Python scripts' menu. 
197     Python is available from http://python.org/.
198
199   o RSSyl
200     Creates mailboxes where newsfeeds in RSS 1.0, RSS 2.0 or Atom format 
201     can be added. Each newsfeed will create a folder with the appropriate 
202     entries, fetched from the web. You can read them, and delete or keep 
203     old entries.
204
205   o S/MIME
206     Handles S/MIME signed and/or encrypted mails. You can decrypt mails, 
207     verify signatures or sign and encrypt your own mails.
208
209   o SpamAssassin
210     Scans incoming mail received from a POP, IMAP or LOCAL account using 
211     SpamAssassin. It can optionally delete mail identified as spam or save 
212     it to a designated folder. 
213     SpamAssassin is available from http://spamassassin.apache.org/.
214
215   o Spam Report
216     Reports spam messages to online spam harvesting sites. Sites suported 
217     are http://www.signal-spam.fr/ and http://www.spamcop.net/. The Debian 
218     mailing list spam nomination system is also supported.
219
220   o TNEF Parser
221     Decodes attachments with 'application/ms-tnef' MIME type (also known 
222     as "winmail.dat" files) in Claws Mail, using the ytnef library. 
223     Decoded parts can be saved to files.
224     The ytnef library is available from http://ytnef.sourceforge.net/.
225
226   o VCalendar
227     Displays vCalendar messages. Only the meeting subset of the vCalendar 
228     format is currently supported, which includes planning, sendding and 
229     receiving invitations and answering them. Public calendar (WebCal) 
230     subscriptions, free/busy information export/import and reminding of 
231     events is also supported.
232     
233
234 Additonal plugins can be found here:
235 http://www.claws-mail.org/plugins.php
236
237
238 3. Actions
239 ----------
240   The "actions" feature is a convenient way for the user to launch external 
241   commands to process a complete message file including headers and body or 
242   just one of its parts. It allows also the use of an external command to 
243   filter the whole text or just a selected part in the message window or in 
244   the compose window. This is a generic tool that allows to do any uncommon 
245   actions on the messages, and thus extends the possibilities of Claws Mail. 
246   For example, Claws Mail does not include the rot13 cyphering algorithm 
247   popular in some newsgroups. It does not support uuencoded messages. As 
248   all these features can be handled by external programs, the actions 
249   provide a convenient way to use them from the menu bar.
250
251   a. Usage
252   --------
253
254   To create a new action, go to Configuration -> Actions.... The "Action
255   Creation" dialog offers to enter the Menu name that will trigger the 
256   command. The created menu will be found in the Tools -> Actions submenu. 
257   By inserting a slash / in the menu name, you create a submenu.
258
259   The command is entered in the Command line entry. Note that Claws Mail
260   stores every single email in a separate file. This allows to use the 
261   following syntax for the command:
262
263     * %f denotes the file name of the selected message. If you selected more
264          than one, then the command will be launched for each message with 
265          the appropriate file name
266     * %F denotes the list of the file names of the selected message. If only
267          one message is selected, this amounts to %f, but if more messages 
268          are selected, then the command will be launched only once with the 
269          list of the file names. (You can use both %f and %F in one command: 
270          then the command will be launched for each selected message with 
271          the name of this message and with the list of all selected 
272          messages. I did not find a practical example for this.)
273     * %p denotes the current selected message part of a multipart message. 
274          The part is decoded accordingly. If the message is not a multipart 
275          message, it denotes the message body.
276     * Prepending >: this will allow you to send to the command's standard 
277          input a text that you will enter in a dialog window.
278     * Prepending *: this will allow you to send to the command's standard 
279          input a text that you will enter in a dialog window. But in 
280          contrast to prepending >, the entered text is hidden (useful when 
281          entering passwords).
282     * Appending an ampersand &: this will run the command asynchronously. 
283          That means "fire and forget". Claws Mail won't wait for the
284          command to finish, nor will it catch its output or its error
285          messages.
286     * Prepending the vertical bar | (pipe-in): this will send the current 
287          displayed text or the current selected text from the message view 
288          or the compose window to the command standard input. The command 
289          will silently fail if more than one message is selected.
290     * Appending the vertical bar | (pipe-out): this will replace the current 
291          displayed text or the current selected text from the message window
292          or the compose window by the command standard output. The command
293          will silently fail if more than one message is selected.
294
295   Note: It is not possible to use actions containing %f, %F or %p from the
296   compose window. 
297
298   When a command is run, and unless it is run asynchronously, Claws Mail
299   will be insensitive to any interaction and it will wait for the command to 
300   finish. If the command takes too long (5 seconds), it will popup a dialog 
301   window allowing to stop it. This dialog will also be displayed as soon as
302   the command has some output: error messages or even its standard output 
303   when the command is not a "pipe-out" command. When multiple commands are 
304   being run, they are run in parallel and each command output is separated 
305   from the outputs of the others.
306
307   a. Examples
308   -----------
309
310   Here are some examples that are listed in the same syntax as used for 
311   storing the actions list. You can copy and past the definition in your 
312   ~/.claws-mail/actionsrc file (exit Claws Mail before). The syntax
313   is very simple: one line per action, each action contains the menu name
314   and the command line separated by a colon and a space ": "
315
316   Purpose:      rot13 cyphering
317   Definition:   Rot13: |tr a-zA-Z n-za-mN-ZA-M|
318   Details:      This will apply the rot13 cyphering algorithm to the 
319                 (selected) text in the message/compose view.
320
321   Purpose:      Decoding uuencoded messages
322   Definition:   UUdeview: xdeview %F&
323   Details:      xdeview comes with uudeview. If an encoded file is split in 
324                 multiple messages, just select them all and run the command.
325
326   Purpose:      Display uuencoded image
327   Definition:   Display uuencoded: uudec %f&
328   Details:      Displays uuencoded files. The uudec[1] script can be found in 
329                 the 'tools' directory of the distribution package.
330  
331   Purpose:      Alter messages
332   Definition:   Edit message: gvim -f %F
333   Details:      Allows editing of any received message. Can be used to remove 
334                 unneeded message parts, etc.
335
336   Purpose:      Pretty format
337   Definition:   Par: |par 72Tbgjqw74bEe B=._A_a 72bg|
338   Details:      par is a utility that can pretty format any text. It does a 
339                 very good job in indenting quoted messages, and justifying 
340                 text. Used when composing a message
341
342   Purpose:      Browse
343   Definition:   Part/Dillo: dillo %p&
344   Details:      Browse the selected message part in Dillo.
345
346
347   [1] The uudec script can be found in the 'tools' directory of the 
348   distribution package. It needs uudecode and ImageMagick's display. The 
349   latter can be replaced by any image viewer that can get input from 
350   standard input. The script could also be modified to use temporary files 
351   instead of standard input. 
352
353
354 4. Icon Themes
355 --------------
356   Claws has support for different icon sets. Several icon sets can be
357   downloaded from http://www.claws-mail.org/themes.php
358   You will need to create a directory called 'themes' in your config
359   directory, unpack them into this directory, and then use the interface
360   to select them, /Configuration/Preferences/Display/Themes
361
362   This interface can also be used to install new themes.
363   
364
365 5. Quick Search with extended search
366 ------------------------------------
367     Quick Search, with its powerful Extended search function,
368     enables searching through folder's messages.
369
370     Extended Search allows one to define criteria that messages must
371     have in order to match and be displayed in the summary view pane.
372     Search types titled From, Subject and To are self explanatory.
373     Search type extended allows one to use Claws Mail's powerful
374     filtering engine to select messages. Examples:
375     from regexpcase "foo"
376     subject regexp "Bug" & to regexp "claws-mail"
377
378     Additionally, it is possible to use simpler yet equally
379     powerfull patterns for message selections. Mutt users will
380     immediately recognise most of the available patterns:
381
382     Pattern  Parameter  Selects
383     ----------------------------------------------------
384     a                   all messages
385     ag       #          messages whose age is greater than #
386     al       #          messages whose age is lower than #
387     b        S          messages which contain S in the message body
388     B        S          messages which contain S in the whole message
389     c        S          messages carbon-copied to S
390     C        S          message is either to: or cc: to S
391     D                   deleted messages
392     e        S          messages which contain S in the Sender field
393     E        S          true if execute "S" succeeds
394     f        S          messages originating from user S
395     F                   forwarded messages
396     h        S          messages which contain S in any header name or value
397     H        S          messages which contain S in the value of any header
398     i        S          messages which contain S in Message-Id header
399     I        S          messages which contain S in inreplyto header
400     k        #          messages which are marked with color #
401     L                   locked messages
402     n        S          messages which are in newsgroup S
403     N                   new messages
404     O                   old messages
405     r                   messages which have been replied to
406     R                   read messages
407     s        S          messages which contain S in subject
408     se       #          messages whose score is equal to #
409     sg       #          messages whose score is greater than #
410     sl       #          messages whose score is lower than #
411     Se       #          messages whose size is equal to #
412     Sg       #          messages whose size is greater than #
413     Ss       #          messages whose size is smaller than #
414     t        S          messages which have been sent to S
415     tg       S          messages with tags containing S
416     tagged              messages which are tagged
417     T                   marked messages
418     U                   unread messages
419     x        S          messages which contain S in References header
420     x        "cmd args" messages returning 0 when passed to command
421                         - %F is message file
422     y        S          messages which contain S in X-Label header
423
424     &        logical AND operator
425     |        logical OR operator
426     ! or ~   logical NOT operator
427     %        case sensitive search
428
429     all filtering expressions are allowed
430
431     # means number
432     S means regexp string
433
434     It is possible to use logical operators AND (&), OR (|) and
435     NOT (! or ~). Case sensitive search is achieved with %.
436     Examples:
437     T                  marked messages
438     U                  unread messages
439     f "john beavis"    messages from john beavis
440     %f "John Beavis"   messages from John Beavis (case sensitive)
441     ~s foo             messages which do not have foo in the subject
442     f foo & ~s bar     messages from foo that do not have bar in thesubject
443
444
445 6. Custom toolbar
446 -----------------
447
448    /Configuration/Preferences/Customize Toolbars lets you define the
449    toolbar you want. The configuration dialog enables you to set an icon,
450    an appropriate text, and map an action to it. Actions to choose
451    from are predefined. You can also have your "Claws Mail Actions"
452    (refer to "Actions" above) on your toolbar.
453
454    Example: 
455         * Configuration->Actions 
456                 - add an entry "Dillo: dillo %p&"
457         * Configuration->Custom toolbar    
458                 - select Claws Mail Actions Feature
459                 - select "Dillo: dillo %p&" from drop down list
460                 - choose an icon and click ok
461
462
463     
464 7. Partial downloading of POP3 mails
465 ------------------------------------
466   Messages over the configured size limit, (/[Account preferences]/
467   Receive/Message size limit), will be partially retrieved. These
468   messages will have a Notice View displayed (above the Message View),
469   informing of the partially retrieved state and the total size of the
470   message. The Notice View will also contain two buttons, 'Mark for
471   download' and 'Mark for deletion'. If the user clicks 'Mark for
472   download', the message will be downloaded in full at the next message
473   retrieval, (and the partial one deleted); if the user checks 'Mark for
474   deletion' it will be removed from the server after the normal delay
475   as specified in the POP3 account's 'Receive' preferences.
476   If a user moves a partially retrieved message to the Trash folder 
477   it will be deleted on the server at the next retrieval after the 
478   Trash folder has been emptied.
479
480
481 8. Hidden options
482 -----------------
483
484     It is recommended that you use Clawsker to edit these options,
485     http://www.claws-mail.org/clawsker.php
486
487     addressbook_use_editaddress_dialog  (default: 1)
488         Use a separate dialogue to edit a person's details. '0'
489         will use a form embedded in the addressbook's main window.
490         0: off  1: on
491
492     bold_unread                 (default: 1)
493         show unread messages using bold font in summary view
494         0: off  1: on
495
496     cache_max_mem_usage         (default: 4096)
497         the maximum kB of memory Claws Mail should use. It will try
498         to keep the memory usage below this value, but it will always
499         use the assigned amount of memory for speed gain.
500
501     cache_min_keep_time         (default: 15)
502         the minimum time in minutes Claws Mail will keep the folder
503         cache in memory. If a cache is more recent than this time it
504         will not be freed even if the memory usage is above the
505         maximum. You should probably set this value higher than your
506         mail check interval. Otherwise the cache will always be freed
507         between checks even if the folder is accessed on every check,
508         which will cause much disk IO.
509
510     compose_no_markup           (default: 0)
511         prevent italic and bold text in the Compose dialog account
512         selector
513         0: normal (markup) 1: no markup
514
515     diff_added_color            (default: #008b8b)
516     diff_deleted_color          (default: #6a5acd)
517     diff_hunk_color             (default: #a52a2a)
518         Colors to use when displaying attachments in unified diff 
519         format.
520
521     emphasis_color              (default: #0000CF)
522         The colour used for the X-Mailer line when its value is
523         Claws Mail.
524
525     enable_hscrollbar           (default: 1)
526         enable horizontal scroll bar in summary view
527         0: off  1: on
528
529     enable_swap_from            (default: 0)
530         display sender's email address in To column in Sent folder
531         instead of recipient's
532         0: off  1: on
533
534     folderview_vscrollbar_policy         (default: 0)
535         specify the policy of vertical scroll bar of folder view
536         0: always  1: automatic  2: never
537
538     hover_timeout                       (default: 500)
539         time in milliseconds that will cause a folder tree to expand
540         during drag n drop when the mouse cover is held over it
541
542     live_dangerously                    (default: 0)
543         Don't ask for confirmation before definitive deletion of
544         emails.
545         0: off  1: on
546
547     log_error_color                     (default: #af0000)
548     log_in_color                        (default: #000000)
549     log_msg_color                       (default: #00af00)
550     log_out_color                       (default: #0000ef)
551     log_warn_color                      (default: #af0000)
552     log_status_ok_color                 (default: #00af00)
553     log_status_nok_color                (default: #0000af)
554     log_status_skip_color               (default: #aa00aa)
555         The colours used in the Network Log window.
556
557     msgview_date_format                 (default: 0)
558         Use the same user-defined date format in the Message View as
559         is used in the Message List.
560         0: off  1: on
561
562     outgoing_fallback_to_ascii          (default: 1)
563         The outgoing encoding of a message will use 7bit US-ASCII
564         whenever it is suitable for the message content, ignoring
565         the "Outgoing encoding" option unless it is necessary.
566         Turning this option off forces the user-defined encoding to
567         be used, regardless of message content.
568         0: off  1: on
569
570     primary_paste_unselects             (default: 0)
571         Causes the primary buffer to be cleared and the insertion
572         point to be repositioned when the middle mouse button is used
573         for pasting text.
574         0: off  1: on   
575
576     respect_flowed_format               (default: 0)
577         Respect format=flowed on text/plain message parts. This will
578         cause some mails to have long lines, but will fix some URLs
579         that would otherwise be wrapped.
580         0: off  1: on
581  
582     save_parts_readwrite                (default: 0)
583         Saves temporary files when opening attachment with write bit
584         set.
585         0: off  1: on
586
587     show_compose_margin                 (default: 0)
588         Adds margins to the message text area in the Compose window.
589         0: off  1: on
590
591     show_inline_attachments             (default: 1)
592         Show inline attachments in MimeView.
593         0: off  1: on
594
595     skip_ssl_cert_check                 (default: 0)
596         Disables the verification of SSL certificates.
597         0: off  1: on
598
599     statusbar_update_step               (default: 10)
600         Update stepping in progress bars.
601
602     stripes_color_offset                (default: 4000)
603         Specify the value to use when creating alternately coloured
604         lines in GtkTreeView components. The smaller the value, the
605         less visible the difference in the alternating colours of the
606         lines. 
607
608     textview_cursor_visible             (default: 0)
609         display the cursor in the message view.
610         0: off  1: on
611
612     thread_by_subject_max_age           (default: 10)
613         number of days to include a message in a thread when using
614         'Thread using subject in addition to standard headers'.
615
616     toolbar_detachable                  (default: 0)
617         hide handles in the toolbar.
618         0: off  1: on
619
620     two_line_vertical                   (default: 1)
621         Spread message list information over two lines when using the
622         three column layout.
623         0: off  1: on
624
625     unsafe_ssl_certs                    (default: 0)
626         Allows Claws to remember multiple SSL certificates for a
627         given server/port.
628         0: off  1: on
629
630     use_networkmanager                  (default: 1)
631         Use NetworkManager to switch offline automatically.
632         0: off  1: on
633
634     use_stripes_everywhere              (default: 1)
635         Enable alternately coloured lines in GtkTreeView components.
636         0: off  1: on
637
638     use_stripes_in_summaries            (default: 1)
639         Enable alternately coloured lines in the main window
640         GtkTreeView components, (Folder List and Message List). The
641         only useful way to use this option is to set it to 0 when
642         use_stripes_everywhere is set to 1.
643         0: off  1: on
644
645     utf8_instead_of_locale_for_broken_mail      (default: 0)
646         Use UTF-8 encoding for broken mails instead of current
647         locale.
648         0: off  1: on
649
650     warn_dnd                    (default: 1)
651         Display a confirmation dialog on drag'n'drop of folders.
652         0: off  1: on
653
654     zero_replacement_char       (default: 0)
655         Character to show in Folder List counter columns when a 
656         folder doesn't contain messages.
657
658 9. Tools
659 --------- 
660   You will find all of these tools in the 'tools' directory:
661
662   acroread2claws-mail.pl 
663         send PDFs from Adobe Reader 7
664   calypso_convert.pl 
665         import mbox files exported by calypso
666   claws-mail-compose-insert-files.pl
667         insert files into a new Compose window
668   convert_mbox.pl
669         convert mbox format to MH format
670   csv2addressbook.pl
671         import Becky, Thunderbird, Kmail, Gmail and Fox Mail
672         address books
673   eud2gc.py
674         convert a Eudora (v.3?) addressbook to vCard 
675         (GnomeCard) format
676   filter_conv.pl
677         convert sylpheed main's filter rules, (< 0.9.99),
678         into Claws' filtering format
679   filter_conv_new.pl
680         convert sylpheed main's filter rules, (>= 0.9.99),
681         into Claws' filtering format
682   fix-date.sh
683         Replace/Add a message's Date field
684   freshmeat_search.pl
685         Actions script to lookup the selected text on
686         Freshmeat www.freshmeat.net using the configured
687         browser
688   gif2xface.pl
689         convert a gif file to an xface
690   google_msgid.pl
691         Actions script to lookup selected message-id on 
692         google using mozilla.
693   google_search.pl
694         Actions script to lookup up the selected text on
695         google using the configured browser
696   kdeservicemenu/*
697         Service Menus for Konqueror to allow sending
698         files to Claws Mail
699   kmail2claws-mail.pl
700         convert a Kmail addressbook to a Claws Mail
701         addressbook
702   kmail2claws-mail_v2.pl
703         new version of the address book conversion script
704         for newer versions of Kmail/Kaddressbook
705   kmail-mailbox2claws-mail.pl
706         convert a Kmail mailbox into a Claws mail mailbox
707   mairix.sh
708         a wrapper to mairix, to enable global searches in mail
709         folders
710   mew2claws-mail.pl
711         import a Mew address book
712   multiwebsearch.pl
713         search any searchable website for the selected text
714   nautilus2claws-mail.sh
715         enables sending files from the Nautilus file manager
716         to Claws Mail
717   OOo2claws-mail.pl
718         enable OpenOffice to send documents through
719         Claws Mail
720   outlook2claws-mail.pl
721         convert an Outlook contacts list to a Claws Mail
722         addressbook
723   popfile-link.sh
724         open messages in POPFile control center to edit their status
725   sylprint.pl
726         process a Claws Mail message and print it using enscript
727         if available or lpr if not
728   tb2claws-mail
729         convert an addressbook exported from The Bat! into 
730         a Claws Mail addressbook
731   tbird2claws.py
732         integrate a Thunderbird folder tree into Claws Mail
733   textviewer.pl
734         Display various attachments as text
735   textviewer.sh
736         attempt to view an attachment as plain text
737   thunderbird-filters-convertor.pl
738         convert Thunderbird filtering rules
739   update-po 
740         translators' tool that eases the creation of 
741         *.po files
742   uudec
743         decode UUencoded mails, for use with Actions
744   uuooffice
745         Decode uuencoded attachments and open them with OpenOffice
746   vcard2xml.py
747         import an Evolution vCard
748
749
750 10. How to contribute
751 ---------------------
752
753 You are encourged to send patches via the Claws Mail bugzilla at
754 http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
755 But please first read the patch guidelines here:
756 http://www.claws-mail.org/devel.php
757
758 If that's too troublesome, either contact Paul Mangan
759 <paul@claws-mail.org> or consider posting to the
760 Claws Mail-users mailing list.
761 http://www.claws-mail.org/MLs.php
762
763 Bugs can be reported with Claws' bugzilla at:
764 http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
765
766 Of course, you can also post to the Claws Mail-users mailing list.
767
768 Also, we really try to incorporate good contributions, but sometimes we
769 don't have enough time. If the contribution is really big, or requires
770 a long time to stabilise, send a mail to Paul Mangan
771 <paul@claws-mail.org>. We can probably arrange access to the
772 Claws Mail Git repository.
773
774
775
776 11. How to request features
777 ---------------------------
778
779 Ask around in Claws Mail-users ML. Note that some developers may
780 have already thought about your feature and may, perhaps, be implementing
781 it, or the feature was already discussed and rejected for whatever reason.
782 You might want to go ahead and hack a patch for it. (That would be very
783 cool!) Another possibility is to add a request to our bugzilla, (severity:
784 'enhancement'), at
785 http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
786
787
788 12. Installing Claws Mail from Git
789 --------------------------------------
790
791   a. Downloading
792   --------------
793
794   To download the latest Git, cd to the directory where you wish to download
795   to and type the following information:
796
797   git clone http://git.claws-mail.org/readonly/claws.git 
798
799   Later, when you want to update your local repository, you'll just have to
800   go back to the 'claws' directory, and type:
801
802   git pull --all
803
804   b. Installing
805   -------------
806
807   To compile and install use the following commands:
808
809   ./autogen.sh          [add configure options as required]
810   make
811   make install          [as root]
812
813   You will need a full set of development tools installed to be able to run
814   autogen.sh. See also ac/README.
815
816
817
818 13. Release History
819 -------------------
820
821 GTK 2 Version
822 -------------
823 2014-06-09      3.10.1
824 2014-05-26      3.10.0
825 2013-12-14      3.9.3
826 2013-06-08      3.9.2
827 2013-05-06      3.9.1
828 2012-11-14      3.9.0
829 2012-06-27      3.8.1
830 2011-12-16      3.8.0
831 2011-08-27      3.7.10
832 2011-04-09      3.7.9
833 2010-12-04      3.7.8
834 2010-11-19      3.7.7
835 2010-05-01      3.7.6
836 2010-01-31      3.7.5
837 2010-01-08      3.7.4
838 2009-10-09      3.7.3
839 2009-07-03      3.7.2
840 2009-03-06      3.7.1
841 2008-12-19      3.7.0
842 2008-10-10      3.6.1
843 2008-10-03      3.6.0
844 2008-06-27      3.5.0
845 2008-04-18      3.4.0
846 2008-02-23      3.3.1
847 2008-02-08      3.3.0
848 2007-12-17      3.2.0
849 2007-11-19      3.1.0
850 2007-10-02      3.0.2
851 2007-09-17      3.0.1
852 2007-09-03      3.0.0
853 2007-07-02      2.10.0
854 2007-05-08      2.9.2
855 2007-04-19      2.9.1
856 2007-04-16      2.9.0
857 2007-03-06      2.8.1
858 2007-02-26      2.8.0
859 2007-01-26      2.7.2
860 2007-01-15      2.7.1
861 2007-01-08      2.7.0
862 2006-12-04      2.6.1 [first release as Claws Mail]
863 2006-11-06      2.6.0
864 2006-10-19      2.5.6
865 2006-10-12      2.5.5
866 2006-10-11      2.5.4
867 2006-10-04      2.5.3
868 2006-09-26      2.5.2
869 2006-09-26      2.5.1
870 2006-09-25      2.5.0
871 2006-07-31      2.4.0
872 2006-06-20      2.3.1
873 2006-06-12      2.3.0
874 2006-06-08      2.2.3
875 2006-06-06      2.2.2
876 2006-06-05      2.2.1
877 2006-05-08      2.2.0
878 2006-04-17      2.1.1
879 2006-04-05      2.1.0
880 2006-01-30      2.0.0
881 2005-11-08      1.9.100
882 2005-10-31      1.9.99
883 2005-10-03      1.9.15
884 2005-09-05      1.9.14
885 2005-07-22      1.9.13
886 2005-06-27      1.9.12
887 2005-05-19      1.9.11
888 2005-05-09      1.9.9
889 2005-03-18      1.9.6
890
891 GTK 1 Version
892 -------------
893 2005-06-27      1.0.5
894 2005-05-09      1.0.4a
895 2005-03-24      1.0.4
896 2005-03-10      1.0.3
897 2005-02-08      1.0.1
898 2005-01-17      1.0.0
899 2004-12-06      0.9.13
900 2004-09-27      0.9.12b
901 2004-08-23      0.9.12a
902 2004-06-28      0.9.12
903 2004-05-31      0.9.11claws
904 2004-03-08      0.9.10claws
905 2004-02-06      0.9.9claws
906 2003-12-19      0.9.8claws
907 2003-11-26      0.9.7claws
908 2003-10-02      0.9.6claws
909 2003-09-10      0.9.5claws
910 2003-08-04      0.9.4claws
911 2003-07-12      0.9.3claws
912 2003-05-24      0.9.0claws
913 2003-03-12      0.8.11claws
914 2003-02-12      0.8.10claws
915 2003-01-24      0.8.9claws
916 2002-12-26      0.8.8claws
917 2002-12-23      0.8.7claws
918 2002-11-25      0.8.6claws
919 2002-10-07      0.8.5claws
920 2002-09-22      0.8.3claws
921 2002-08-28      0.8.2claws
922 2002-07-30      0.8.1claws
923 2002-07-23      0.8.0claws
924 2002-06-15      0.7.8claws
925 2002-05-18      0.7.6claws
926 2002-04-28      0.7.5claws
927 2002-03-11      0.7.4claws
928 2002-02-19      0.7.2claws
929 2002-02-14      0.7.1claws
930 2002-01-14      0.7.0claws
931 2001-12-16      0.6.6claws
932 2001-10-16      0.6.5claws8
933 2001-09-30      0.6.2claws
934 2001-08-14      0.6.1claws
935 2001-07-13      0.5.1claws
936 2001-07-01      0.5.0claws3
937 2001-06-16      0.4.99claws
938 2001-05-29      0.4.99claws3
939 2001-05-11      0.4.67claws1
940
941
942
943 14. Useful links
944 ----------------
945 Homepage
946     http://www.claws-mail.org/
947 User Contributed FAQ
948     http://www.claws-mail.org/faq/
949 Project page
950     http://sourceforge.net/projects/sylpheed-claws/
951 Downloads
952     http://www.claws-mail.org/downloads.php
953 Extra Plugins
954     http://www.claws-mail.org/plugins.php
955 Icon Themes
956     http://www.claws-mail.org/themes.php
957 Mailing Lists
958     http://www.claws-mail.org/MLs.php
959 Users Mailing List archive
960     http://lists.claws-mail.org/pipermail/users/index.html
961 Commits Announcement List archive
962     http://lists.claws-mail.org/pipermail/commits/index.html
963 Bug/Patch/Feature Request Tracker
964     http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
965 Internationalisation Status
966     http://www.claws-mail.org/i18n.php
967 Donations
968     http://www.claws-mail.org/sponsors.php
969 Planet Claws Mail
970     http://planet.claws-mail.org/
971 Claws Mail for Windows homepage
972     http://www.claws-mail.org/win32/
973