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, Kmail, Gmail and Fox
19 eud2gc.py Convert Eudora address book to Gnomecard
20 kmail2claws-mail.pl Import a Kmail address book (KDE2)
21 kmail2claws-mail_v2.pl Import a Kmail address book (KDE3)
22 mew2claws-mail.pl Import a Mew address book
23 outlook2claws-mail.pl Import an Outlook generated contact list
24 tb2claws-mail Import The Bat! address books
25 vcard2xml.py Import an Evolution vCard
28 calypso_convert.pl Import mbox files with attachments from Calypso
29 convert_mbox.pl Import mbox files
30 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
31 tbird2claws.py Integrate a Thunderbird folder tree into Claws
34 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
35 claws-mail-compose-insert-files.pl
36 Insert files into a new Compose window
37 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
38 filter_conv.pl Convert old-style Sylpheed filters to filtering
39 fix-date.sh Replace/Add a message's Date field
40 mairix.sh A wrapper to mairix, to enable global searches in
42 nautilus2claws-mail.sh Send files from Nautilus
43 OOo2claws-mail.pl Send documents from OpenOffice.org
44 popfile-link.sh Open messages in POPFile control center to edit
46 sylprint.pl Printing engine, explained in README.sylprint
47 textviewer.pl Display various attachments as text
48 thunderbird-filters-convertor.pl
49 Convert Thunderbird filtering rules
52 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
53 update-po Update the .po files named on the command line.
55 --------------------------------------------------------------------------------
56 Detailed Descriptions:
57 --------------------------------------------------------------------------------
64 COMMAND: |freshmeat_search.pl
65 Search freshmeat.net for selected text using the default Claws Mail browser
69 COMMAND: |google_msgid.pl
70 Lookup selected message-id in google using mozilla. Edit the script to use
75 COMMAND: |google_search.pl
76 Search google.com for selected text using the default Claws Mail browser
80 see further down for details
83 WORKS ON: current message part
84 COMMAND: textviewer.sh %p |
85 Attempt to view an attachment as plain text
88 WORKS ON: current message (or part of multipart message)
90 Decode and display uuencoded images using uudecode.
93 WORKS ON: current message (or part of multipart message)
94 COMMAND: uuooffice %f&
95 Decode uuencoded attachments and open them with OpenOffice
97 * More action examples can be found at the Claws Mail FAQ
98 http://www.claws-mail.org/faq/index.php/Actions
100 ** multiwebsearch.pl **
103 This is an Actions script that allows you to search
104 websites for the selected text. It uses the default
105 Claws Mail browser as configured through Claws Mail's
106 GUI and specified in ~/.claws-mail/clawsrc, and a
107 configuration file called multiwebsearch.conf.
110 The configuration file takes the following format:
112 ALIAS|URL PART|URL PART
114 ALIAS is a user-defined name; the first URL PART is the
115 url before the search term; the second URL PART is
116 optional and contains the remaining part of the url which
117 comes after the search term. A sample configuration file
121 Copy 'multiwebsearch.conf' to ~/.claws-mail/
124 a) pre-configured website
125 Command: multiwebsearch.pl --where="google" --what="%s"
127 Command: multiwebsearch.pl --where="%u" --what="%s"
129 In type a) "google" refers to one of the configured aliases,
130 this Action will always search the website referred to by
133 In type b) you will be presented with a dialog box into
134 which you type one of your configured aliases
137 Contact: Paul Mangan <paul@claws-mail.org>
138 --------------------------------------------------------------------------------
140 Address book conversion
141 -----------------------
146 This perl script will import a Becky, Thunderbird, Kmail, Gmail and
147 Fox Mail address book.
150 (You must run claws-mail at least once before running this script.)
154 In Becky you need to do a CSV full export with titles of your
157 Run the script with the following options:
159 perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
161 Addtionally you can use the option '--name="My address book"', if
162 you don't use this option the new Claws address book will be
163 called 'Becky address book'.
166 Thunderbird >= 2.0.0.6
167 ----------------------
168 In Thunderbird you need to export your address book as 'comma
171 Run the script with the following options:
173 perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
175 Addtionally you can use the option '--name="My address book"', if
176 you don't use this option the new Claws address book will be
177 called 'Thunderbird address book'.
179 Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
180 --------------------------------------
181 In Kaddressbook you need to export your address book as 'CSV List'.
183 Run the script with the following options:
185 perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
187 Addtionally you can use the option '--name="My address book"', if
188 you don't use this option the new Claws address book will be
189 called 'Kmail address book'.
191 WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
192 formatted CSV if the values are quoted.
196 In the Gmail web interface you need to export your address book
197 as Outlook CSV format.
199 Run the script with the following options:
201 perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
203 Addtionally you can use the option '--name="My address book"', if
204 you don't use this option the new Claws address book will be
205 called 'gmail address book'.
209 Export your Fox Mail address book as CSV with all possible headers.
211 Run the script with the following options:
213 perl csv2addressbook.pl --type=foxmail --csv=/full/path/to/file.csv
215 Addtionally you can use the option '--name="My address book"', if
216 you don't use this option the new Claws address book will be
217 called 'foxmail address book'.
219 You can also run the script with '--help' to get a brief usage message.
221 Contact: Paul Mangan <paul@claws-mail.org>
226 This python-script is a quick hack to convert an Eudora (v.3?)
227 addressbook to vCard (GnomeCard) format.
230 You may do whatever you want with it! (Also regarding copying)
231 However, the script is intended to use like this:
233 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
235 Be careful not to overwrite your original GnomeCard.gcrd!
236 (But of course you might want to add the converted stuff to it)
238 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
240 * kmail2claws-mail.pl
243 This perl script will convert an exported Kmail addressbook into a
244 Claws Mail addressbook. If your version of Kmail is 1.37 or
245 greater and/or your version of KAddressBook is 3.1beta1 or greater,
246 or this script mixes up your definitions and their related data, use
247 'kmail2claws-mail_v2.pl' instead.
250 (You must run claws-mail at least once before running this script.)
252 In Kmail's Address book choose '/File/Export List'. This will export
253 your Kmail address book data to a *.csv file.
255 If Claws Mail is running, close it.
257 From the command line, execute the following:
259 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
261 Your Kmail address book data will now be contained in Claws Mail'
262 address book, under the name 'Kmail Address Book'.
264 Contact: Paul Mangan <paul@claws-mail.org>
267 * kmail2claws-mail_v2.pl
269 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
272 This perl script will convert a Kmail address book that has been
273 exported in csv format into a Claws Mail address book.
276 (You must run claws-mail at least once before running this script.)
278 Open Kmail's Addressbook, /File/Address Book
279 In Kmail's Addressbook choose '/File/Export/Export List...'. This
280 will allow you to export your Kmail addressbook data to a *.csv file.
282 If Claws Mail is running, close it.
284 From the command line, execute the following:
286 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
288 You can also use --help to see usage instructions.
290 Your Kmail addressbook data will now be contained in Claws Mail'
291 addressbook, under the name 'Kmail address book'.
293 Contact: Paul Mangan <paul@claws-mail.org>
298 This perl script will convert a Mew address book into a Claws Mail
302 (You must run claws-mail at least once before running this script.)
304 If Claws Mail is running, close it.
306 From the command line, execute the following:
308 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
310 You can also use --help to see usage instructions.
312 Your Mew addressbook data will now be contained in Claws Mail's
313 addressbook, under the name 'Mew Address Book'.
315 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
317 * outlook2claws-mail.pl
320 This perl script converts an Outlook generated contact list into a
321 Claws Mail XML address book.
326 You must export Outlook Express contact list as TXT file, choosing
327 only "Name" and "Address" fields to export.
329 You must exit Claws Mail before converting the contact list.
331 From the command line, execute the following:
333 outlook2claws-mail.pl fullpathname
337 You must export Outlook contact list as CSV file, choosing ALL the
338 fields available for exporting.
340 You must exit Claws Mail before converting the contact list.
342 From the command line, execute the following:
344 outlook2claws-mail.pl --csv fullpathname
347 For text files only works with fields described above. If you have
348 more complex examples send them to me, and I'll try to enhance the
351 For csv files you must export all fields (but only non empty fields
352 are added to the created Claws Mail address book) and the number
353 of fields expected is harcoded. Look for the $nboffields variable in
354 the script and change its value if you are sure you exported all
355 fields and script gives the 'unknown csv file format' error.
357 Contact: Ricardo Mones <ricardo@mones.org>
363 This perl script will convert an address book exported from The Bat!
364 into a Claws Mail address book.
367 (You must run claws-mail at least once before running this script.)
369 If Claws Mail is running, close it.
371 Export The Bat! Address Book to CSV file format with all fields
372 selected to YES and then start:
374 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
376 The Bat! addressbook data will now be contained in Claws Mail'
377 addressbook, under the name 'The Bat! Address Book'.
379 Contact: Urke MMI <urke@gmx.net>
385 This python script will convert an Evolution vCard into a Claws Mail
389 (You must run claws-mail at least once before running this script.)
391 If Claws Mail is running, close it.
392 From the command line, execute the following:
394 vcard2xml.py source_file [destination_file]
396 When only <source_file> is specified it will overwrite (and
397 create a backup of) the existing addressbook.
398 When both arguments are suplied it will create a new additional
399 addressbook named as <destination_file>.
400 If the script encounters an error it will attempt to roll back
401 the changes and restore the original files.
403 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
405 --------------------------------------------------------------------------------
413 This perl script imports mbox files that are exported by Calypso.
414 It recreates the folder structure by scanning the "X-CalypsoFolder"
415 header and reincludes the attachments referenced in the
416 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
419 Export the Calypso mailbox by selecting "Save to archive" and check
420 the "Save attachments" box.
422 Edit the script to set following variables (at the top of the file):
423 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
424 $mboxfile : name of exported mbox, e.g. 'mail.txt'
425 $outdir : name of the MH folder to create, e.g. 'Calypso'
429 perl calypso_convert.pl
431 Finally, import that folder by either selecting "New mailbox" or
432 moving it into your existing directory and recreate the folder
433 structure manually (contentmenu from folderview).
435 Contact: Thorsten Maerz <torte@netztorte.de>
440 This perl script converts an mbox directory's contents into
441 Claws Mail' MH format.
445 Run the script using:
447 perl convert_mbox.pl MBOX MH_DIR
449 Move the outputted MH_DIR and its contents into your Claws Mail
450 Mail folder; in Claws Mail right-click the top-level folder and
451 choose 'Rebuild folder tree' from the popup menu.
453 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
455 * kmail-mailbox2claws-mail.pl
458 This perl script converts a kmail mailbox into Claws Mail' mailbox.
462 Exit Claws Mail if running.
464 Run the script using:
466 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
468 Start Claws Mail and right-click the toplevel mailbox, i.e
469 "Mailbox (MH)", and select 'Rebuild folder tree'.
470 You may also need to run '/File/Folder/Check for new messages
475 --dry-run test mode, nothing is actually written
476 --help brief usage info
478 Contact: Paul Mangan <paul@claws-mail.org>
483 This python script integrates a Thunderbird folder tree into
488 The script receives two parameters from command-line:
489 <Thunderbird folder path> <Claws Mail folder path>
491 The best way to use it is to go to inside your Thunderbird
492 root mailfolder directory and invoke it as:
494 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
496 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
498 --------------------------------------------------------------------------------
503 * acroread2claws-mail.pl
506 This perl script enables Adobe Reader 7 to send documents to
507 Claws Mail as attachments.
510 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
511 Start up Adobe Reader 7 (acroread)
512 Go to /Edit/Preferences/SendMail
513 Select any email client except 'System Mail (mail)'
514 Enter the path to this script in the alternate location box
516 You can then use 'File/Email' or the Email toolbar button to launch
517 claws-mail (if not already launched) and open a new compose window
518 with the PDF attached.
520 Contact: Paul Mangan <paul@claws-mail.org>
522 * claws-mail-compose-insert-files.pl
525 This script enables inserting files into the message body of a new
526 Claws Mail Compose window from the command line. Additionally To,
527 Cc, Bcc, Subject and files to attach to the message can be specified.
530 claws-mail-compose-insert-files.pl [options]
533 --to "Person One <mail@address.net>"
534 --cc "Person One <mail@address.net>"
535 --bcc "Person One <mail@address.net>"
536 --subject "My subject"
540 For multiple recipients separate the addresses with ','
541 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
542 --attach and --insert can be used multiple times
544 Contact: Paul Mangan <paul@claws-mail.org>
549 This perl script provides easy conversion of your filtering rules from
550 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
552 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
553 writes '~/[CLAWS CONFIG DIR]/matcherrc'
556 Issue the following command from the 'tools' directory:
558 perl filter_conv_new.pl
560 That's it, the claws' filtering system is now implemented with your
561 previous rules applied.
566 Contact: Paul Mangan <paul@claws-mail.org>
572 This perl script provides easy conversion of your filtering rules
573 from sylpheed's old filter system (< 0.9.99) to the filtering system
575 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
578 Issue the following command from the 'tools' directory:
582 That's it, the new filtering system is now implemented with your
583 previous rules applied.
585 Contact: Paul Mangan <paul@claws-mail.org>
591 Add a 'Date:' header to the selected email(s) when such header is
592 missing. The correct date is guessed from other headers that contain
593 timestamp information (preferred: Fetchinfo header if found) or from
594 the file or system date as a fallback. The order or preference for the
595 date valuereplacement can be changed by editing the script.
596 This script can be used to fix messages that show non RFC-compliant
597 Date headers as well.
598 X-Original-Date is always added too if not already existing (if so,
599 it's left untouched), to keep track of the original value if any.
600 An existing Date: header is not overwritten unless you use the --force
602 Non RFC-compliant dates can be overwritten using the --rfc switch. Use
603 --strict to use strict RFC matching patterns for date values in other
609 Contact: wwp <wwp@claws-mail.org>
615 It's a wrapper to mairix, a tool that makes indexed searches
616 and shows search results in a virtual folder. Maildir, MH and
617 mbox formats are supported, see:
618 http://www.rpcurnow.force9.co.uk/mairix/
622 mairix.sh <mairix rcfile> [<mairix options>..]
625 mairix.sh ~/.mairixrc s:word1,word2
627 Contact: wwp <wwp@claws-mail.org>
630 * nautilus2claws-mail.sh
633 This script will recursively attach a number of selected
634 files/directories from Nautilus to a new blank e-mail.
637 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
638 and restart nautilus (killall -9 nautilus). You will now have
639 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
641 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
647 This perl script enables OpenOffice.org to send documents to
648 Claws Mail as attachments.
651 OpenOffice.org Version 2.0
652 ----------------------------
653 This script is not needed for OOo version 2, which can work
654 directly with Claws Mail.
655 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
658 OpenOffice.org Version 1.1.0
659 ----------------------------
660 Start up OpenOffice.org.
661 Go to 'Tools/Options/OpenOffice.org/External Programs'
662 Select either ''Mozilla 1.x (Option 1)', or
663 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
664 Enter the path to OOo2claws-mail.pl in the 'Path' box
665 or select it by clicking on the '...' button.
667 You can then use 'File/Send/Document as email' to launch
668 claws-mail (if not already launched) and open a new compose
669 window with the document attached.
671 OpenOffice.org Version 1.0
672 --------------------------
673 Start up OpenOffice.org.
674 Go to 'Tools/Options/OpenOffice.org/External Programs'
675 Enter the path to OOo2claws-mail.pl in the 'Program' box
676 or select it by clicking on the '...' button.
679 Contact: Paul Mangan <paul@claws-mail.org>
685 Open selected messages in POPFile control center to edit their
686 status. Requires that POPFile is running and that the messages
687 have been processed by it (X-POPFile-Link: header is expected).
688 POPFile control center opens with the web browser set in
692 popfile-link.sh <filename> [<filename>..]
695 Contact: wwp <wwp@claws-mail.org>
701 This script tries to recognise an attachment by using the 'file'
702 command and/or the file extension and then uses the available
703 utilities to make an effort to display it as text. For example
708 .html txt2htm or text2html
709 .xls, .sxc, .csv xlscat -L
713 .pl, .pm perltidy -st -se or cat
714 .bz2 bzip2 -d < %f | strings
717 Go to /Configuration/Message View/External Programs and enter the
718 path to the script in the "Command for 'Display as text'" box.
719 Now when you right-click an attachment and choose 'Display as text'
720 this script will be invoked.
723 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
726 * thunderbird-filters-convertor.pl
729 This perl script converts Thunderbird filtering rules into Claws Mail
730 filtering rules. It can be run several times, once for each filter
731 configuration file in Thunderbird.
734 The script takes 3 arguments:
736 --tbird-file=PATH TO FILE The full path to the file to be converted
737 --mailbox-name=NAME The name of the Claws Mail mailbox
738 --account-name=NAME The name of the account to be used (optional)
740 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
741 that you want to convert, it must contain the full path to the file.
742 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
743 if the top-level folder is 'Mailbox (MH)' then this option should be
745 --account-name is optional, only needed if you are creating account-specific
746 rules. This is the name of your account in Claws Mail, which should
747 correspond to an account that you had in Thunderbird, e.g. the acount whose
748 rules you are converting.
750 This script presumes that your folder hierarchy in Claws Mail matches the
751 one that you had in Thunderbird. If you used the tbird2claws.py script to
752 convert your Thunderbird mailbox, then the folder hierarchy should match.
754 If the Claws Mail filtering configuration file (matcherrc) does not exist,
755 the script will create it; if it does exist, the newly converted rules will
762 Contact: Paul Mangan <paul@claws-mail.org>
764 --------------------------------------------------------------------------------
772 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
773 into an X-Face graphic suitable for inclusion into custom headers of
774 Claws Mail. An X-Face allows to quickly identify (or be identified
775 as) the sender of a mail message in a xface-capable MUA (like Claws
779 After obtaining the desired image for your X-Face you should:
780 * scale it to 48x48 pixels (Image->Scale image on Gimp)
781 * down color depth to b/w (Image->Mode->Indexed selecting "Use
782 Black/White palette" and the desired dithering options (prior to
783 indexing doing Image->Colors->Threshold allows you to select the
784 b/w level if you don't want a dithered (dotty) image))
785 * save file as non-interlaced GIF
788 ./gif2xface < filename.gif > filename.xface
790 In filename.xface will be the X-Face header ready to use.
791 You can add a custom header in Claws Mail through Configuration->
792 Preferences per account, "Send" tab, check "Add user-defined header"
793 then "Edit..." if you want to add it via the Claws Mail interface, or do
795 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
797 if you want to create the custom headers file yourself (Warning: this
798 method is valid only if you don't have any other custom header set or
801 Contact: Ricardo Mones <ricardo@mones.org>
807 This script is a message catalog translator's tool, it updates the .po
808 files named on the command line.
811 This script needs to be copied to and run from the 'po' directory.
813 ./update-po lang.po lang2.po ...
815 to update one or more <yourlang>.po files from the sourcecode files
816 named in POTFILES.in. The old .po file is save in a .po.old file.
818 For example, when you want to update fr.po, run ./update-po fr.po,
819 then edit fr.po to update your translation.
821 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
823 --------------------------------------------------------------------------------
824 This file is Copyright 1999-2014 by the Claws Mail team.
825 See accompanying COPYING file for license details.
826 See each included script for copyright and license details.