2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
7 cm-reparent.pl Fix thread parenting for two or more messages
8 freshmeat_search.pl Search freshmeat.net for selected text
9 google_msgid.pl Search groups.google.com for selected message-id
10 google_search.pl Search google.com for selected text
11 multiwebsearch.pl Search any search engine for the selected text
12 textviewer.sh Attempt to view an attachment as plain text
13 uudec Decode and display uuencoded images
14 uuooffice Decode uuencoded attachments and open them with
17 Addressbook conversion:
18 csv2addressbook.pl Import Becky, Thunderbird, Kmail, Gmail and Fox
20 eud2gc.py Convert Eudora address book to Gnomecard
21 kmail2claws-mail.pl Import a Kmail address book (KDE2)
22 kmail2claws-mail_v2.pl Import a Kmail address book (KDE3)
23 mew2claws-mail.pl Import a Mew address book
24 outlook2claws-mail.pl Import an Outlook generated contact list
25 tb2claws-mail Import The Bat! address books
26 vcard2xml.py Import an Evolution vCard
29 calypso_convert.pl Import mbox files with attachments from Calypso
30 convert_mbox.pl Import mbox files
31 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
32 tbird2claws.py Integrate a Thunderbird folder tree into Claws
35 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
36 claws-mail-compose-insert-files.pl
37 Insert files into a new Compose window
38 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
39 filter_conv.pl Convert old-style Sylpheed filters to filtering
40 fix-date.sh Replace/Add a message's Date field
41 mairix.sh A wrapper to mairix, to enable global searches in
43 nautilus2claws-mail.sh Send files from Nautilus
44 OOo2claws-mail.pl Send documents from OpenOffice.org
45 popfile-link.sh Open messages in POPFile control center to edit
47 sylprint.pl Printing engine, explained in README.sylprint
48 textviewer.pl Display various attachments as text
49 thunderbird-filters-convertor.pl
50 Convert Thunderbird filtering rules
53 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
54 update-po Update the .po files named on the command line.
56 --------------------------------------------------------------------------------
57 Detailed Descriptions:
58 --------------------------------------------------------------------------------
64 WORKS ON: selected messages (two or more)
65 COMMAND: cm-reparent.pl %F
66 Thread the selected messages based on date, old to new
70 COMMAND: |google_msgid.pl
71 Lookup selected message-id in google using mozilla. Edit the script to use
76 COMMAND: |google_search.pl
77 Search google.com for selected text using the default Claws Mail browser
81 see further down for details
84 WORKS ON: current message part
85 COMMAND: textviewer.sh %p |
86 Attempt to view an attachment as plain text
89 WORKS ON: current message (or part of multipart message)
91 Decode and display uuencoded images using uudecode.
94 WORKS ON: current message (or part of multipart message)
95 COMMAND: uuooffice %f&
96 Decode uuencoded attachments and open them with OpenOffice
98 * More action examples can be found at the Claws Mail FAQ
99 http://www.claws-mail.org/faq/index.php/Actions
101 ** multiwebsearch.pl **
104 This is an Actions script that allows you to search
105 websites for the selected text. It uses the default
106 Claws Mail browser as configured through Claws Mail's
107 GUI and specified in ~/.claws-mail/clawsrc, and a
108 configuration file called multiwebsearch.conf.
111 The configuration file takes the following format:
113 ALIAS|URL PART|URL PART
115 ALIAS is a user-defined name; the first URL PART is the
116 url before the search term; the second URL PART is
117 optional and contains the remaining part of the url which
118 comes after the search term. A sample configuration file
122 Copy 'multiwebsearch.conf' to ~/.claws-mail/
125 a) pre-configured website
126 Command: multiwebsearch.pl --where="google" --what="%s"
128 Command: multiwebsearch.pl --where="%u" --what="%s"
130 In type a) "google" refers to one of the configured aliases,
131 this Action will always search the website referred to by
134 In type b) you will be presented with a dialog box into
135 which you type one of your configured aliases
138 Contact: Paul Mangan <paul@claws-mail.org>
139 --------------------------------------------------------------------------------
141 Address book conversion
142 -----------------------
147 This perl script will import a Becky, Thunderbird, Kmail, Gmail and
148 Fox Mail address book.
151 (You must run claws-mail at least once before running this script.)
155 In Becky you need to do a CSV full export with titles of your
158 Run the script with the following options:
160 perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
162 Addtionally you can use the option '--name="My address book"', if
163 you don't use this option the new Claws address book will be
164 called 'Becky address book'.
167 Thunderbird >= 2.0.0.6
168 ----------------------
169 In Thunderbird you need to export your address book as 'comma
172 Run the script with the following options:
174 perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
176 Addtionally you can use the option '--name="My address book"', if
177 you don't use this option the new Claws address book will be
178 called 'Thunderbird address book'.
180 Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
181 --------------------------------------
182 In Kaddressbook you need to export your address book as 'CSV List'.
184 Run the script with the following options:
186 perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
188 Addtionally you can use the option '--name="My address book"', if
189 you don't use this option the new Claws address book will be
190 called 'Kmail address book'.
192 WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
193 formatted CSV if the values are quoted.
197 In the Gmail web interface you need to export your address book
198 as Outlook CSV format.
200 Run the script with the following options:
202 perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
204 Addtionally you can use the option '--name="My address book"', if
205 you don't use this option the new Claws address book will be
206 called 'gmail address book'.
210 Export your Fox Mail address book as CSV with all possible headers.
212 Run the script with the following options:
214 perl csv2addressbook.pl --type=foxmail --csv=/full/path/to/file.csv
216 Addtionally you can use the option '--name="My address book"', if
217 you don't use this option the new Claws address book will be
218 called 'foxmail address book'.
220 You can also run the script with '--help' to get a brief usage message.
222 Contact: Paul Mangan <paul@claws-mail.org>
227 This python-script is a quick hack to convert an Eudora (v.3?)
228 addressbook to vCard (GnomeCard) format.
231 You may do whatever you want with it! (Also regarding copying)
232 However, the script is intended to use like this:
234 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
236 Be careful not to overwrite your original GnomeCard.gcrd!
237 (But of course you might want to add the converted stuff to it)
239 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
241 * kmail2claws-mail.pl
244 This perl script will convert an exported Kmail addressbook into a
245 Claws Mail addressbook. If your version of Kmail is 1.37 or
246 greater and/or your version of KAddressBook is 3.1beta1 or greater,
247 or this script mixes up your definitions and their related data, use
248 'kmail2claws-mail_v2.pl' instead.
251 (You must run claws-mail at least once before running this script.)
253 In Kmail's Address book choose '/File/Export List'. This will export
254 your Kmail address book 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.pl --kmailfile=/path/to/addressbook.csv
262 Your Kmail address book data will now be contained in Claws Mail'
263 address book, under the name 'Kmail Address Book'.
265 Contact: Paul Mangan <paul@claws-mail.org>
268 * kmail2claws-mail_v2.pl
270 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
273 This perl script will convert a Kmail address book that has been
274 exported in csv format into a Claws Mail address book.
277 (You must run claws-mail at least once before running this script.)
279 Open Kmail's Addressbook, /File/Address Book
280 In Kmail's Addressbook choose '/File/Export/Export List...'. This
281 will allow you to export your Kmail addressbook data to a *.csv file.
283 If Claws Mail is running, close it.
285 From the command line, execute the following:
287 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
289 You can also use --help to see usage instructions.
291 Your Kmail addressbook data will now be contained in Claws Mail'
292 addressbook, under the name 'Kmail address book'.
294 Contact: Paul Mangan <paul@claws-mail.org>
299 This perl script will convert a Mew address book into a Claws Mail
303 (You must run claws-mail at least once before running this script.)
305 If Claws Mail is running, close it.
307 From the command line, execute the following:
309 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
311 You can also use --help to see usage instructions.
313 Your Mew addressbook data will now be contained in Claws Mail's
314 addressbook, under the name 'Mew Address Book'.
316 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
318 * outlook2claws-mail.pl
321 This perl script converts an Outlook generated contact list into a
322 Claws Mail XML address book.
327 You must export Outlook Express contact list as TXT file, choosing
328 only "Name" and "Address" fields to export.
330 You must exit Claws Mail before converting the contact list.
332 From the command line, execute the following:
334 outlook2claws-mail.pl fullpathname
338 You must export Outlook contact list as CSV file, choosing ALL the
339 fields available for exporting.
341 You must exit Claws Mail before converting the contact list.
343 From the command line, execute the following:
345 outlook2claws-mail.pl --csv fullpathname
348 For text files only works with fields described above. If you have
349 more complex examples send them to me, and I'll try to enhance the
352 For csv files you must export all fields (but only non empty fields
353 are added to the created Claws Mail address book) and the number
354 of fields expected is harcoded. Look for the $nboffields variable in
355 the script and change its value if you are sure you exported all
356 fields and script gives the 'unknown csv file format' error.
358 Contact: Ricardo Mones <ricardo@mones.org>
364 This perl script will convert an address book exported from The Bat!
365 into a Claws Mail address book.
368 (You must run claws-mail at least once before running this script.)
370 If Claws Mail is running, close it.
372 Export The Bat! Address Book to CSV file format with all fields
373 selected to YES and then start:
375 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
377 The Bat! addressbook data will now be contained in Claws Mail'
378 addressbook, under the name 'The Bat! Address Book'.
380 Contact: Urke MMI <urke@gmx.net>
386 This python script will convert an Evolution vCard into a Claws Mail
390 (You must run claws-mail at least once before running this script.)
392 If Claws Mail is running, close it.
393 From the command line, execute the following:
395 vcard2xml.py source_file [destination_file]
397 When only <source_file> is specified it will overwrite (and
398 create a backup of) the existing addressbook.
399 When both arguments are suplied it will create a new additional
400 addressbook named as <destination_file>.
401 If the script encounters an error it will attempt to roll back
402 the changes and restore the original files.
404 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
406 --------------------------------------------------------------------------------
414 This perl script imports mbox files that are exported by Calypso.
415 It recreates the folder structure by scanning the "X-CalypsoFolder"
416 header and reincludes the attachments referenced in the
417 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
420 Export the Calypso mailbox by selecting "Save to archive" and check
421 the "Save attachments" box.
423 Edit the script to set following variables (at the top of the file):
424 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
425 $mboxfile : name of exported mbox, e.g. 'mail.txt'
426 $outdir : name of the MH folder to create, e.g. 'Calypso'
430 perl calypso_convert.pl
432 Finally, import that folder by either selecting "New mailbox" or
433 moving it into your existing directory and recreate the folder
434 structure manually (contentmenu from folderview).
436 Contact: Thorsten Maerz <torte@netztorte.de>
441 This perl script converts an mbox directory's contents into
442 Claws Mail' MH format.
446 Run the script using:
448 perl convert_mbox.pl MBOX MH_DIR
450 Move the outputted MH_DIR and its contents into your Claws Mail
451 Mail folder; in Claws Mail right-click the top-level folder and
452 choose 'Rebuild folder tree' from the popup menu.
454 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
456 * kmail-mailbox2claws-mail.pl
459 This perl script converts a kmail mailbox into Claws Mail' mailbox.
463 Exit Claws Mail if running.
465 Run the script using:
467 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
469 Start Claws Mail and right-click the toplevel mailbox, i.e
470 "Mailbox (MH)", and select 'Rebuild folder tree'.
471 You may also need to run '/File/Folder/Check for new messages
476 --dry-run test mode, nothing is actually written
477 --help brief usage info
479 Contact: Paul Mangan <paul@claws-mail.org>
484 This python script integrates a Thunderbird folder tree into
489 The script receives two parameters from command-line:
490 <Thunderbird folder path> <Claws Mail folder path>
492 The best way to use it is to go to inside your Thunderbird
493 root mailfolder directory and invoke it as:
495 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
497 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
499 --------------------------------------------------------------------------------
504 * acroread2claws-mail.pl
507 This perl script enables Adobe Reader 7 to send documents to
508 Claws Mail as attachments.
511 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
512 Start up Adobe Reader 7 (acroread)
513 Go to /Edit/Preferences/SendMail
514 Select any email client except 'System Mail (mail)'
515 Enter the path to this script in the alternate location box
517 You can then use 'File/Email' or the Email toolbar button to launch
518 claws-mail (if not already launched) and open a new compose window
519 with the PDF attached.
521 Contact: Paul Mangan <paul@claws-mail.org>
523 * claws-mail-compose-insert-files.pl
526 This script enables inserting files into the message body of a new
527 Claws Mail Compose window from the command line. Additionally To,
528 Cc, Bcc, Subject and files to attach to the message can be specified.
531 claws-mail-compose-insert-files.pl [options]
534 --to "Person One <mail@address.net>"
535 --cc "Person One <mail@address.net>"
536 --bcc "Person One <mail@address.net>"
537 --subject "My subject"
541 For multiple recipients separate the addresses with ','
542 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
543 --attach and --insert can be used multiple times
545 Contact: Paul Mangan <paul@claws-mail.org>
550 This perl script provides easy conversion of your filtering rules from
551 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
553 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
554 writes '~/[CLAWS CONFIG DIR]/matcherrc'
557 Issue the following command from the 'tools' directory:
559 perl filter_conv_new.pl
561 That's it, the claws' filtering system is now implemented with your
562 previous rules applied.
567 Contact: Paul Mangan <paul@claws-mail.org>
573 This perl script provides easy conversion of your filtering rules
574 from sylpheed's old filter system (< 0.9.99) to the filtering system
576 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
579 Issue the following command from the 'tools' directory:
583 That's it, the new filtering system is now implemented with your
584 previous rules applied.
586 Contact: Paul Mangan <paul@claws-mail.org>
592 Add a 'Date:' header to the selected email(s) when such header is
593 missing. The correct date is guessed from other headers that contain
594 timestamp information (preferred: Fetchinfo header if found) or from
595 the file or system date as a fallback. The order or preference for the
596 date valuereplacement can be changed by editing the script.
597 This script can be used to fix messages that show non RFC-compliant
598 Date headers as well.
599 X-Original-Date is always added too if not already existing (if so,
600 it's left untouched), to keep track of the original value if any.
601 An existing Date: header is not overwritten unless you use the --force
603 Non RFC-compliant dates can be overwritten using the --rfc switch. Use
604 --strict to use strict RFC matching patterns for date values in other
610 Contact: wwp <wwp@claws-mail.org>
616 It's a wrapper to mairix, a tool that makes indexed searches
617 and shows search results in a virtual folder. Maildir, MH and
618 mbox formats are supported, see:
619 http://www.rpcurnow.force9.co.uk/mairix/
623 mairix.sh <mairix rcfile> [<mairix options>..]
626 mairix.sh ~/.mairixrc s:word1,word2
628 Contact: wwp <wwp@claws-mail.org>
631 * nautilus2claws-mail.sh
634 This script will recursively attach a number of selected
635 files/directories from Nautilus to a new blank e-mail.
638 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
639 and restart nautilus (killall -9 nautilus). You will now have
640 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
642 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
648 This perl script enables OpenOffice.org to send documents to
649 Claws Mail as attachments.
652 OpenOffice.org Version 2.0
653 ----------------------------
654 This script is not needed for OOo version 2, which can work
655 directly with Claws Mail.
656 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
659 OpenOffice.org Version 1.1.0
660 ----------------------------
661 Start up OpenOffice.org.
662 Go to 'Tools/Options/OpenOffice.org/External Programs'
663 Select either ''Mozilla 1.x (Option 1)', or
664 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
665 Enter the path to OOo2claws-mail.pl in the 'Path' box
666 or select it by clicking on the '...' button.
668 You can then use 'File/Send/Document as email' to launch
669 claws-mail (if not already launched) and open a new compose
670 window with the document attached.
672 OpenOffice.org Version 1.0
673 --------------------------
674 Start up OpenOffice.org.
675 Go to 'Tools/Options/OpenOffice.org/External Programs'
676 Enter the path to OOo2claws-mail.pl in the 'Program' box
677 or select it by clicking on the '...' button.
680 Contact: Paul Mangan <paul@claws-mail.org>
686 Open selected messages in POPFile control center to edit their
687 status. Requires that POPFile is running and that the messages
688 have been processed by it (X-POPFile-Link: header is expected).
689 POPFile control center opens with the web browser set in
693 popfile-link.sh <filename> [<filename>..]
696 Contact: wwp <wwp@claws-mail.org>
702 This script tries to recognise an attachment by using the 'file'
703 command and/or the file extension and then uses the available
704 utilities to make an effort to display it as text. For example
709 .html txt2htm or text2html
710 .xls, .sxc, .csv xlscat -L
714 .pl, .pm perltidy -st -se or cat
715 .bz2 bzip2 -d < %f | strings
718 Go to /Configuration/Message View/External Programs and enter the
719 path to the script in the "Command for 'Display as text'" box.
720 Now when you right-click an attachment and choose 'Display as text'
721 this script will be invoked.
724 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
727 * thunderbird-filters-convertor.pl
730 This perl script converts Thunderbird filtering rules into Claws Mail
731 filtering rules. It can be run several times, once for each filter
732 configuration file in Thunderbird.
735 The script takes 3 arguments:
737 --tbird-file=PATH TO FILE The full path to the file to be converted
738 --mailbox-name=NAME The name of the Claws Mail mailbox
739 --account-name=NAME The name of the account to be used (optional)
741 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
742 that you want to convert, it must contain the full path to the file.
743 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
744 if the top-level folder is 'Mailbox (MH)' then this option should be
746 --account-name is optional, only needed if you are creating account-specific
747 rules. This is the name of your account in Claws Mail, which should
748 correspond to an account that you had in Thunderbird, e.g. the acount whose
749 rules you are converting.
751 This script presumes that your folder hierarchy in Claws Mail matches the
752 one that you had in Thunderbird. If you used the tbird2claws.py script to
753 convert your Thunderbird mailbox, then the folder hierarchy should match.
755 If the Claws Mail filtering configuration file (matcherrc) does not exist,
756 the script will create it; if it does exist, the newly converted rules will
763 Contact: Paul Mangan <paul@claws-mail.org>
765 --------------------------------------------------------------------------------
773 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
774 into an X-Face graphic suitable for inclusion into custom headers of
775 Claws Mail. An X-Face allows to quickly identify (or be identified
776 as) the sender of a mail message in a xface-capable MUA (like Claws
780 After obtaining the desired image for your X-Face you should:
781 * scale it to 48x48 pixels (Image->Scale image on Gimp)
782 * down color depth to b/w (Image->Mode->Indexed selecting "Use
783 Black/White palette" and the desired dithering options (prior to
784 indexing doing Image->Colors->Threshold allows you to select the
785 b/w level if you don't want a dithered (dotty) image))
786 * save file as non-interlaced GIF
789 ./gif2xface < filename.gif > filename.xface
791 In filename.xface will be the X-Face header ready to use.
792 You can add a custom header in Claws Mail through Configuration->
793 Preferences per account, "Send" tab, check "Add user-defined header"
794 then "Edit..." if you want to add it via the Claws Mail interface, or do
796 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
798 if you want to create the custom headers file yourself (Warning: this
799 method is valid only if you don't have any other custom header set or
802 Contact: Ricardo Mones <ricardo@mones.org>
808 This script is a message catalog translator's tool, it updates the .po
809 files named on the command line.
812 This script needs to be copied to and run from the 'po' directory.
814 ./update-po lang.po lang2.po ...
816 to update one or more <yourlang>.po files from the sourcecode files
817 named in POTFILES.in. The old .po file is save in a .po.old file.
819 For example, when you want to update fr.po, run ./update-po fr.po,
820 then edit fr.po to update your translation.
822 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
824 --------------------------------------------------------------------------------
825 This file is Copyright 1999-2014 by the Claws Mail team.
826 See accompanying COPYING file for license details.
827 See each included script for copyright and license details.