2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
7 freshmeat_search.pl Search freshmeat.net for selected text
8 google_msgid.pl Search groups.google.com for selected message-id
9 google_search.pl Search google.com for selected text
10 multiwebsearch.pl Search any search engine for the selected text
11 textviewer.sh Attempt to view an attachment as plain text
12 uudec Decode and display uuencoded images
13 uuooffice Decode uuencoded attachments and open them with
16 Addressbook conversion:
17 csv2addressbook.pl Import Becky, Thunderbird or Kmail address books
18 eud2gc.py Convert Eudora address book to Gnomecard
19 kmail2claws-mail.pl Import a Kmail address book (KDE2)
20 kmail2claws-mail_v2.pl Import a Kmail address book (KDE3)
21 mew2claws-mail.pl Import a Mew address book
22 outlook2claws-mail.pl Import an Outlook generated contact list
23 tb2claws-mail Import The Bat! address books
24 vcard2xml.py Import an Evolution vCard
27 calypso_convert.pl Import mbox files with attachments from Calypso
28 convert_mbox.pl Import mbox files
29 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
30 tbird2claws.py Integrate a Thunderbird folder tree into Claws
33 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
34 claws-mail-compose-insert-files.pl
35 Insert files into a new Compose window
36 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
37 filter_conv.pl Convert old-style Sylpheed filters to filtering
38 fix-date.sh Replace/Add a message's Date field
39 mairix.sh A wrapper to mairix, to enable global searches in
41 nautilus2claws-mail.sh Send files from Nautilus
42 OOo2claws-mail.pl Send documents from OpenOffice.org
43 popfile-link.sh Open messages in POPFile control center to edit
45 sylprint.pl Printing engine, explained in README.sylprint
46 textviewer.pl Display various attachments as text
47 thunderbird-filters-convertor.pl
48 Convert Thunderbird filtering rules
51 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
52 update-po Update the .po files named on the command line.
54 --------------------------------------------------------------------------------
55 Detailed Descriptions:
56 --------------------------------------------------------------------------------
63 COMMAND: |freshmeat_search.pl
64 Search freshmeat.net for selected text using the default Claws Mail browser
68 COMMAND: |google_msgid.pl
69 Lookup selected message-id in google using mozilla. Edit the script to use
74 COMMAND: |google_search.pl
75 Search google.com for selected text using the default Claws Mail browser
79 see further down for details
82 WORKS ON: current message part
83 COMMAND: textviewer.sh %p |
84 Attempt to view an attachment as plain text
87 WORKS ON: current message (or part of multipart message)
89 Decode and display uuencoded images using uudecode.
92 WORKS ON: current message (or part of multipart message)
93 COMMAND: uuooffice %f&
94 Decode uuencoded attachments and open them with OpenOffice
96 * More action examples can be found at the Claws Mail FAQ
97 http://www.claws-mail.org/faq/index.php/Actions
99 ** multiwebsearch.pl **
102 This is an Actions script that allows you to search
103 websites for the selected text. It uses the default
104 Claws Mail browser as configured through Claws Mail's
105 GUI and specified in ~/.claws-mail/clawsrc, and a
106 configuration file called multiwebsearch.conf.
109 The configuration file takes the following format:
111 ALIAS|URL PART|URL PART
113 ALIAS is a user-defined name; the first URL PART is the
114 url before the search term; the second URL PART is
115 optional and contains the remaining part of the url which
116 comes after the search term. A sample configuration file
120 Copy 'multiwebsearch.conf' to ~/.claws-mail/
123 a) pre-configured website
124 Command: multiwebsearch.pl --where="google" --what="%s"
126 Command: multiwebsearch.pl --where="%u" --what="%s"
128 In type a) "google" refers to one of the configured aliases,
129 this Action will always search the website referred to by
132 In type b) you will be presented with a dialog box into
133 which you type one of your configured aliases
136 Contact: Paul Mangan <paul@claws-mail.org>
137 --------------------------------------------------------------------------------
139 Address book conversion
140 -----------------------
145 This perl script will import a Becky, Thunderbird and Kmail address
149 (You must run claws-mail at least once before running this script.)
153 In Becky you need to do a CSV full export with titles of your
156 Run the script with the following options:
158 perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
160 Addtionally you can use the option '--name="My address book"', if
161 you don't use this option the new Claws address book will be
162 called 'Becky address book'.
165 Thunderbird >= 2.0.0.6
166 ----------------------
167 In Thunderbird you need to export your address book as 'comma
170 Run the script with the following options:
172 perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
174 Addtionally you can use the option '--name="My address book"', if
175 you don't use this option the new Claws address book will be
176 called 'Thunderbird address book'.
178 Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
179 --------------------------------------
180 In Kaddressbook you need to export your address book as 'CSV List'.
182 Run the script with the following options:
184 perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
186 Addtionally you can use the option '--name="My address book"', if
187 you don't use this option the new Claws address book will be
188 called 'Kmail address book'.
190 WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
191 formatted CSV if the values are quoted.
193 You can also run the script with '--help' to get a brief usage message.
195 Contact: Paul Mangan <paul@claws-mail.org>
200 This python-script is a quick hack to convert an Eudora (v.3?)
201 addressbook to vCard (GnomeCard) format.
204 You may do whatever you want with it! (Also regarding copying)
205 However, the script is intended to use like this:
207 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
209 Be careful not to overwrite your original GnomeCard.gcrd!
210 (But of course you might want to add the converted stuff to it)
212 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
214 * kmail2claws-mail.pl
217 This perl script will convert an exported Kmail addressbook into a
218 Claws Mail addressbook. If your version of Kmail is 1.37 or
219 greater and/or your version of KAddressBook is 3.1beta1 or greater,
220 or this script mixes up your definitions and their related data, use
221 'kmail2claws-mail_v2.pl' instead.
224 (You must run claws-mail at least once before running this script.)
226 In Kmail's Address book choose '/File/Export List'. This will export
227 your Kmail address book data to a *.csv file.
229 If Claws Mail is running, close it.
231 From the command line, execute the following:
233 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
235 Your Kmail address book data will now be contained in Claws Mail'
236 address book, under the name 'Kmail Address Book'.
238 Contact: Paul Mangan <paul@claws-mail.org>
241 * kmail2claws-mail_v2.pl
243 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
246 This perl script will convert a Kmail address book that has been
247 exported in csv format into a Claws Mail address book.
250 (You must run claws-mail at least once before running this script.)
252 Open Kmail's Addressbook, /File/Address Book
253 In Kmail's Addressbook choose '/File/Export/Export List...'. This
254 will allow you to export your Kmail addressbook data to a *.csv file.
256 If Claws Mail is running, close it.
258 From the command line, execute the following:
260 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
262 You can also use --help to see usage instructions.
264 Your Kmail addressbook data will now be contained in Claws Mail'
265 addressbook, under the name 'Kmail address book'.
267 Contact: Paul Mangan <paul@claws-mail.org>
272 This perl script will convert a Mew address book into a Claws Mail
276 (You must run claws-mail at least once before running this script.)
278 If Claws Mail is running, close it.
280 From the command line, execute the following:
282 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
284 You can also use --help to see usage instructions.
286 Your Mew addressbook data will now be contained in Claws Mail's
287 addressbook, under the name 'Mew Address Book'.
289 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
291 * outlook2claws-mail.pl
294 This perl script converts an Outlook generated contact list into a
295 Claws Mail XML address book.
300 You must export Outlook Express contact list as TXT file, choosing
301 only "Name" and "Address" fields to export.
303 You must exit Claws Mail before converting the contact list.
305 From the command line, execute the following:
307 outlook2claws-mail.pl fullpathname
311 You must export Outlook contact list as CSV file, choosing ALL the
312 fields available for exporting.
314 You must exit Claws Mail before converting the contact list.
316 From the command line, execute the following:
318 outlook2claws-mail.pl --csv fullpathname
321 For text files only works with fields described above. If you have
322 more complex examples send them to me, and I'll try to enhance the
325 For csv files you must export all fields (but only non empty fields
326 are added to the created Claws Mail address book) and the number
327 of fields expected is harcoded. Look for the $nboffields variable in
328 the script and change its value if you are sure you exported all
329 fields and script gives the 'unknown csv file format' error.
331 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
337 This perl script will convert an address book exported from The Bat!
338 into a Claws Mail address book.
341 (You must run claws-mail at least once before running this script.)
343 If Claws Mail is running, close it.
345 Export The Bat! Address Book to CSV file format with all fields
346 selected to YES and then start:
348 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
350 The Bat! addressbook data will now be contained in Claws Mail'
351 addressbook, under the name 'The Bat! Address Book'.
353 Contact: Urke MMI <urke@gmx.net>
359 This python script will convert an Evolution vCard into a Claws Mail
363 (You must run claws-mail at least once before running this script.)
365 If Claws Mail is running, close it.
366 From the command line, execute the following:
368 vcard2xml.py source_file [destination_file]
370 When only <source_file> is specified it will overwrite (and
371 create a backup of) the existing addressbook.
372 When both arguments are suplied it will create a new additional
373 addressbook named as <destination_file>.
374 If the script encounters an error it will attempt to roll back
375 the changes and restore the original files.
377 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
379 --------------------------------------------------------------------------------
387 This perl script imports mbox files that are exported by Calypso.
388 It recreates the folder structure by scanning the "X-CalypsoFolder"
389 header and reincludes the attachments referenced in the
390 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
393 Export the Calypso mailbox by selecting "Save to archive" and check
394 the "Save attachments" box.
396 Edit the script to set following variables (at the top of the file):
397 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
398 $mboxfile : name of exported mbox, e.g. 'mail.txt'
399 $outdir : name of the MH folder to create, e.g. 'Calypso'
403 perl calypso_convert.pl
405 Finally, import that folder by either selecting "New mailbox" or
406 moving it into your existing directory and recreate the folder
407 structure manually (contentmenu from folderview).
409 Contact: Thorsten Maerz <torte@netztorte.de>
414 This perl script converts an mbox directory's contents into
415 Claws Mail' MH format.
419 Run the script using:
421 perl convert_mbox.pl MBOX MH_DIR
423 Move the outputted MH_DIR and its contents into your Claws Mail
424 Mail folder; in Claws Mail right-click the top-level folder and
425 choose 'Rebuild folder tree' from the popup menu.
427 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
429 * kmail-mailbox2claws-mail.pl
432 This perl script converts a kmail mailbox into Claws Mail' mailbox.
436 Exit Claws Mail if running.
438 Run the script using:
440 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
442 Start Claws Mail and right-click the toplevel mailbox, i.e
443 "Mailbox (MH)", and select 'Rebuild folder tree'.
444 You may also need to run '/File/Folder/Check for new messages
449 --dry-run test mode, nothing is actually written
450 --help brief usage info
452 Contact: Paul Mangan <paul@claws-mail.org>
457 This python script integrates a Thunderbird folder tree into
462 The script receives two parameters from command-line:
463 <Thunderbird folder path> <Claws Mail folder path>
465 The best way to use it is to go to inside your Thunderbird
466 root mailfolder directory and invoke it as:
468 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
470 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
472 --------------------------------------------------------------------------------
477 * acroread2claws-mail.pl
480 This perl script enables Adobe Reader 7 to send documents to
481 Claws Mail as attachments.
484 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
485 Start up Adobe Reader 7 (acroread)
486 Go to /Edit/Preferences/SendMail
487 Select any email client except 'System Mail (mail)'
488 Enter the path to this script in the alternate location box
490 You can then use 'File/Email' or the Email toolbar button to launch
491 claws-mail (if not already launched) and open a new compose window
492 with the PDF attached.
494 Contact: Paul Mangan <paul@claws-mail.org>
496 * claws-mail-compose-insert-files.pl
499 This script enables inserting files into the message body of a new
500 Claws Mail Compose window from the command line. Additionally To,
501 Cc, Bcc, Subject and files to attach to the message can be specified.
504 claws-mail-compose-insert-files.pl [options]
507 --to "Person One <mail@address.net>"
508 --cc "Person One <mail@address.net>"
509 --bcc "Person One <mail@address.net>"
510 --subject "My subject"
514 For multiple recipients separate the addresses with ','
515 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
516 --attach and --insert can be used multiple times
518 Contact: Paul Mangan <paul@claws-mail.org>
523 This perl script provides easy conversion of your filtering rules from
524 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
526 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
527 writes '~/[CLAWS CONFIG DIR]/matcherrc'
530 Issue the following command from the 'tools' directory:
532 perl filter_conv_new.pl
534 That's it, the claws' filtering system is now implemented with your
535 previous rules applied.
540 Contact: Paul Mangan <paul@claws-mail.org>
546 This perl script provides easy conversion of your filtering rules
547 from sylpheed's old filter system (< 0.9.99) to the filtering system
549 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
552 Issue the following command from the 'tools' directory:
556 That's it, the new filtering system is now implemented with your
557 previous rules applied.
559 Contact: Paul Mangan <paul@claws-mail.org>
565 It will replace the Date: value w/ the one picked up from
566 more recent Received: field if this field resides in one
567 line. Otherwise, it will take the file modification time
568 (using a RFC 2822-compliant form). If no X-Original-Date already
569 exist, the former Date value will be set in such field.
572 fix_date.sh <filename> [<filename>..]
574 Contact: wwp <wwp@claws-mail.org>
580 It's a wrapper to mairix, a tool that makes indexed searches
581 and shows search results in a virtual folder. Maildir, MH and
582 mbox formats are supported, see:
583 http://www.rpcurnow.force9.co.uk/mairix/
587 mairix.sh <mairix rcfile> [<mairix options>..]
590 mairix.sh ~/.mairixrc s:word1,word2
592 Contact: wwp <wwp@claws-mail.org>
595 * nautilus2claws-mail.sh
598 This script will recursively attach a number of selected
599 files/directories from Nautilus to a new blank e-mail.
602 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
603 and restart nautilus (killall -9 nautilus). You will now have
604 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
606 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
612 This perl script enables OpenOffice.org to send documents to
613 Claws Mail as attachments.
616 OpenOffice.org Version 2.0
617 ----------------------------
618 This script is not needed for OOo version 2, which can work
619 directly with Claws Mail.
620 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
623 OpenOffice.org Version 1.1.0
624 ----------------------------
625 Start up OpenOffice.org.
626 Go to 'Tools/Options/OpenOffice.org/External Programs'
627 Select either ''Mozilla 1.x (Option 1)', or
628 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
629 Enter the path to OOo2claws-mail.pl in the 'Path' box
630 or select it by clicking on the '...' button.
632 You can then use 'File/Send/Document as email' to launch
633 claws-mail (if not already launched) and open a new compose
634 window with the document attached.
636 OpenOffice.org Version 1.0
637 --------------------------
638 Start up OpenOffice.org.
639 Go to 'Tools/Options/OpenOffice.org/External Programs'
640 Enter the path to OOo2claws-mail.pl in the 'Program' box
641 or select it by clicking on the '...' button.
644 Contact: Paul Mangan <paul@claws-mail.org>
650 Open selected messages in POPFile control center to edit their
651 status. Requires that POPFile is running and that the messages
652 have been processed by it (X-POPFile-Link: header is expected).
653 POPFile control center opens with the web browser set in
657 popfile-link.sh <filename> [<filename>..]
660 Contact: wwp <wwp@claws-mail.org>
666 This script tries to recognise an attachment by using the 'file'
667 command and/or the file extension and then uses the available Linux
668 utilities to make an effort to display it as text. For example
673 .html txt2htm or text2html
674 .xls, .sxc, .csv xlscat -L
678 .pl, .pm perltidy -st -se or cat
679 .bz2 bzip2 -d < %f | strings
682 Go to /Configuration/Message View/External Programs and enter the
683 path to the script in the "Command for 'Display as text'" box.
684 Now when you right-click an attachment and choose 'Display as text'
685 this script will be invoked.
688 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
691 * thunderbird-filters-convertor.pl
694 This perl script converts Thunderbird filtering rules into Claws Mail
695 filtering rules. It can be run several times, once for each filter
696 configuration file in Thunderbird.
699 The script takes 3 arguments:
701 --tbird-file=PATH TO FILE The full path to the file to be converted
702 --mailbox-name=NAME The name of the Claws Mail mailbox
703 --account-name=NAME The name of the account to be used (optional)
705 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
706 that you want to convert, it must contain the full path to the file.
707 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
708 if the top-level folder is 'Mailbox (MH)' then this option should be
710 --account-name is optional, only needed if you are creating account-specific
711 rules. This is the name of your account in Claws Mail, which should
712 correspond to an account that you had in Thunderbird, e.g. the acount whose
713 rules you are converting.
715 This script presumes that your folder hierarchy in Claws Mail matches the
716 one that you had in Thunderbird. If you used the tbird2claws.py script to
717 convert your Thunderbird mailbox, then the folder hierarchy should match.
719 If the Claws Mail filtering configuration file (matcherrc) does not exist,
720 the script will create it; if it does exist, the newly converted rules will
727 Contact: Paul Mangan <paul@claws-mail.org>
729 --------------------------------------------------------------------------------
737 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
738 into an X-Face graphic suitable for inclusion into custom headers of
739 Claws Mail. An X-Face allows to quickly identify (or be identified
740 as) the sender of a mail message in a xface-capable MUA (like Claws
744 After obtaining the desired image for your X-Face you should:
745 * scale it to 48x48 pixels (Image->Scale image on Gimp)
746 * down color depth to b/w (Image->Mode->Indexed selecting "Use
747 Black/White palette" and the desired dithering options (prior to
748 indexing doing Image->Colors->Threshold allows you to select the
749 b/w level if you don't want a dithered (dotty) image))
750 * save file as non-interlaced GIF
753 ./gif2xface < filename.gif > filename.xface
755 In filename.xface will be the X-Face header ready to use.
756 You can add a custom header in Claws Mail through Configuration->
757 Preferences per account, "Send" tab, check "Add user-defined header"
758 then "Edit..." if you want to add it via the Claws Mail interface, or do
760 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
762 if you want to create the custom headers file yourself (Warning: this
763 method is valid only if you don't have any other custom header set or
766 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
772 This script is a message catalog translator's tool, it updates the .po
773 files named on the command line.
776 This script needs to be copied to and run from the 'po' directory.
778 ./update-po lang.po lang2.po ...
780 to update one or more <yourlang>.po files from the sourcecode files
781 named in POTFILES.in. The old .po file is save in a .po.old file.
783 For example, when you want to update fr.po, run ./update-po fr.po,
784 then edit fr.po to update your translation.
786 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
788 --------------------------------------------------------------------------------