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 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
31 convert_mbox.sh Convert arbitrary Evolution mail folders (mbox
32 format + subfolders) - uses convert_mbox.pl
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 --------------------------------------------------------------------------------
65 COMMAND: |freshmeat_search.pl
66 Search freshmeat.net for selected text using the default Claws Mail browser
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 and Gmail
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'.
208 You can also run the script with '--help' to get a brief usage message.
210 Contact: Paul Mangan <paul@claws-mail.org>
215 This python-script is a quick hack to convert an Eudora (v.3?)
216 addressbook to vCard (GnomeCard) format.
219 You may do whatever you want with it! (Also regarding copying)
220 However, the script is intended to use like this:
222 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
224 Be careful not to overwrite your original GnomeCard.gcrd!
225 (But of course you might want to add the converted stuff to it)
227 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
229 * kmail2claws-mail.pl
232 This perl script will convert an exported Kmail addressbook into a
233 Claws Mail addressbook. If your version of Kmail is 1.37 or
234 greater and/or your version of KAddressBook is 3.1beta1 or greater,
235 or this script mixes up your definitions and their related data, use
236 'kmail2claws-mail_v2.pl' instead.
239 (You must run claws-mail at least once before running this script.)
241 In Kmail's Address book choose '/File/Export List'. This will export
242 your Kmail address book data to a *.csv file.
244 If Claws Mail is running, close it.
246 From the command line, execute the following:
248 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
250 Your Kmail address book data will now be contained in Claws Mail'
251 address book, under the name 'Kmail Address Book'.
253 Contact: Paul Mangan <paul@claws-mail.org>
256 * kmail2claws-mail_v2.pl
258 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
261 This perl script will convert a Kmail address book that has been
262 exported in csv format into a Claws Mail address book.
265 (You must run claws-mail at least once before running this script.)
267 Open Kmail's Addressbook, /File/Address Book
268 In Kmail's Addressbook choose '/File/Export/Export List...'. This
269 will allow you to export your Kmail addressbook data to a *.csv file.
271 If Claws Mail is running, close it.
273 From the command line, execute the following:
275 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
277 You can also use --help to see usage instructions.
279 Your Kmail addressbook data will now be contained in Claws Mail'
280 addressbook, under the name 'Kmail address book'.
282 Contact: Paul Mangan <paul@claws-mail.org>
287 This perl script will convert a Mew address book into a Claws Mail
291 (You must run claws-mail at least once before running this script.)
293 If Claws Mail is running, close it.
295 From the command line, execute the following:
297 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
299 You can also use --help to see usage instructions.
301 Your Mew addressbook data will now be contained in Claws Mail's
302 addressbook, under the name 'Mew Address Book'.
304 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
306 * outlook2claws-mail.pl
309 This perl script converts an Outlook generated contact list into a
310 Claws Mail XML address book.
315 You must export Outlook Express contact list as TXT file, choosing
316 only "Name" and "Address" fields to export.
318 You must exit Claws Mail before converting the contact list.
320 From the command line, execute the following:
322 outlook2claws-mail.pl fullpathname
326 You must export Outlook contact list as CSV file, choosing ALL the
327 fields available for exporting.
329 You must exit Claws Mail before converting the contact list.
331 From the command line, execute the following:
333 outlook2claws-mail.pl --csv fullpathname
336 For text files only works with fields described above. If you have
337 more complex examples send them to me, and I'll try to enhance the
340 For csv files you must export all fields (but only non empty fields
341 are added to the created Claws Mail address book) and the number
342 of fields expected is harcoded. Look for the $nboffields variable in
343 the script and change its value if you are sure you exported all
344 fields and script gives the 'unknown csv file format' error.
346 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
352 This perl script will convert an address book exported from The Bat!
353 into a Claws Mail address book.
356 (You must run claws-mail at least once before running this script.)
358 If Claws Mail is running, close it.
360 Export The Bat! Address Book to CSV file format with all fields
361 selected to YES and then start:
363 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
365 The Bat! addressbook data will now be contained in Claws Mail'
366 addressbook, under the name 'The Bat! Address Book'.
368 Contact: Urke MMI <urke@gmx.net>
374 This python script will convert an Evolution vCard into a Claws Mail
378 (You must run claws-mail at least once before running this script.)
380 If Claws Mail is running, close it.
381 From the command line, execute the following:
383 vcard2xml.py source_file [destination_file]
385 When only <source_file> is specified it will overwrite (and
386 create a backup of) the existing addressbook.
387 When both arguments are suplied it will create a new additional
388 addressbook named as <destination_file>.
389 If the script encounters an error it will attempt to roll back
390 the changes and restore the original files.
392 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
394 --------------------------------------------------------------------------------
402 This perl script imports mbox files that are exported by Calypso.
403 It recreates the folder structure by scanning the "X-CalypsoFolder"
404 header and reincludes the attachments referenced in the
405 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
408 Export the Calypso mailbox by selecting "Save to archive" and check
409 the "Save attachments" box.
411 Edit the script to set following variables (at the top of the file):
412 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
413 $mboxfile : name of exported mbox, e.g. 'mail.txt'
414 $outdir : name of the MH folder to create, e.g. 'Calypso'
418 perl calypso_convert.pl
420 Finally, import that folder by either selecting "New mailbox" or
421 moving it into your existing directory and recreate the folder
422 structure manually (contentmenu from folderview).
424 Contact: Thorsten Maerz <torte@netztorte.de>
429 This perl script converts an mbox directory's contents into
430 Claws Mail' MH format.
434 Run the script using:
436 perl convert_mbox.pl MBOX MH_DIR
438 Move the outputted MH_DIR and its contents into your Claws Mail
439 Mail folder; in Claws Mail right-click the top-level folder and
440 choose 'Rebuild folder tree' from the popup menu.
442 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
444 * kmail-mailbox2claws-mail.pl
447 This perl script converts a kmail mailbox into Claws Mail' mailbox.
451 Exit Claws Mail if running.
453 Run the script using:
455 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
457 Start Claws Mail and right-click the toplevel mailbox, i.e
458 "Mailbox (MH)", and select 'Rebuild folder tree'.
459 You may also need to run '/File/Folder/Check for new messages
464 --dry-run test mode, nothing is actually written
465 --help brief usage info
467 Contact: Paul Mangan <paul@claws-mail.org>
472 This python script integrates a Thunderbird folder tree into
477 The script receives two parameters from command-line:
478 <Thunderbird folder path> <Claws Mail folder path>
480 The best way to use it is to go to inside your Thunderbird
481 root mailfolder directory and invoke it as:
483 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
485 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
487 --------------------------------------------------------------------------------
492 * acroread2claws-mail.pl
495 This perl script enables Adobe Reader 7 to send documents to
496 Claws Mail as attachments.
499 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
500 Start up Adobe Reader 7 (acroread)
501 Go to /Edit/Preferences/SendMail
502 Select any email client except 'System Mail (mail)'
503 Enter the path to this script in the alternate location box
505 You can then use 'File/Email' or the Email toolbar button to launch
506 claws-mail (if not already launched) and open a new compose window
507 with the PDF attached.
509 Contact: Paul Mangan <paul@claws-mail.org>
511 * claws-mail-compose-insert-files.pl
514 This script enables inserting files into the message body of a new
515 Claws Mail Compose window from the command line. Additionally To,
516 Cc, Bcc, Subject and files to attach to the message can be specified.
519 claws-mail-compose-insert-files.pl [options]
522 --to "Person One <mail@address.net>"
523 --cc "Person One <mail@address.net>"
524 --bcc "Person One <mail@address.net>"
525 --subject "My subject"
529 For multiple recipients separate the addresses with ','
530 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
531 --attach and --insert can be used multiple times
533 Contact: Paul Mangan <paul@claws-mail.org>
538 This perl script provides easy conversion of your filtering rules from
539 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
541 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
542 writes '~/[CLAWS CONFIG DIR]/matcherrc'
545 Issue the following command from the 'tools' directory:
547 perl filter_conv_new.pl
549 That's it, the claws' filtering system is now implemented with your
550 previous rules applied.
555 Contact: Paul Mangan <paul@claws-mail.org>
561 This perl script provides easy conversion of your filtering rules
562 from sylpheed's old filter system (< 0.9.99) to the filtering system
564 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
567 Issue the following command from the 'tools' directory:
571 That's it, the new filtering system is now implemented with your
572 previous rules applied.
574 Contact: Paul Mangan <paul@claws-mail.org>
580 It will replace the Date: value w/ the one picked up from
581 more recent Received: field if this field resides in one
582 line. Otherwise, it will take the file modification time
583 (using a RFC 2822-compliant form). If no X-Original-Date already
584 exist, the former Date value will be set in such field.
587 fix_date.sh <filename> [<filename>..]
589 Contact: wwp <wwp@claws-mail.org>
595 It's a wrapper to mairix, a tool that makes indexed searches
596 and shows search results in a virtual folder. Maildir, MH and
597 mbox formats are supported, see:
598 http://www.rpcurnow.force9.co.uk/mairix/
602 mairix.sh <mairix rcfile> [<mairix options>..]
605 mairix.sh ~/.mairixrc s:word1,word2
607 Contact: wwp <wwp@claws-mail.org>
610 * nautilus2claws-mail.sh
613 This script will recursively attach a number of selected
614 files/directories from Nautilus to a new blank e-mail.
617 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
618 and restart nautilus (killall -9 nautilus). You will now have
619 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
621 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
627 This perl script enables OpenOffice.org to send documents to
628 Claws Mail as attachments.
631 OpenOffice.org Version 2.0
632 ----------------------------
633 This script is not needed for OOo version 2, which can work
634 directly with Claws Mail.
635 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
638 OpenOffice.org Version 1.1.0
639 ----------------------------
640 Start up OpenOffice.org.
641 Go to 'Tools/Options/OpenOffice.org/External Programs'
642 Select either ''Mozilla 1.x (Option 1)', or
643 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
644 Enter the path to OOo2claws-mail.pl in the 'Path' box
645 or select it by clicking on the '...' button.
647 You can then use 'File/Send/Document as email' to launch
648 claws-mail (if not already launched) and open a new compose
649 window with the document attached.
651 OpenOffice.org Version 1.0
652 --------------------------
653 Start up OpenOffice.org.
654 Go to 'Tools/Options/OpenOffice.org/External Programs'
655 Enter the path to OOo2claws-mail.pl in the 'Program' box
656 or select it by clicking on the '...' button.
659 Contact: Paul Mangan <paul@claws-mail.org>
665 Open selected messages in POPFile control center to edit their
666 status. Requires that POPFile is running and that the messages
667 have been processed by it (X-POPFile-Link: header is expected).
668 POPFile control center opens with the web browser set in
672 popfile-link.sh <filename> [<filename>..]
675 Contact: wwp <wwp@claws-mail.org>
681 This script tries to recognise an attachment by using the 'file'
682 command and/or the file extension and then uses the available Linux
683 utilities to make an effort to display it as text. For example
688 .html txt2htm or text2html
689 .xls, .sxc, .csv xlscat -L
693 .pl, .pm perltidy -st -se or cat
694 .bz2 bzip2 -d < %f | strings
697 Go to /Configuration/Message View/External Programs and enter the
698 path to the script in the "Command for 'Display as text'" box.
699 Now when you right-click an attachment and choose 'Display as text'
700 this script will be invoked.
703 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
706 * thunderbird-filters-convertor.pl
709 This perl script converts Thunderbird filtering rules into Claws Mail
710 filtering rules. It can be run several times, once for each filter
711 configuration file in Thunderbird.
714 The script takes 3 arguments:
716 --tbird-file=PATH TO FILE The full path to the file to be converted
717 --mailbox-name=NAME The name of the Claws Mail mailbox
718 --account-name=NAME The name of the account to be used (optional)
720 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
721 that you want to convert, it must contain the full path to the file.
722 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
723 if the top-level folder is 'Mailbox (MH)' then this option should be
725 --account-name is optional, only needed if you are creating account-specific
726 rules. This is the name of your account in Claws Mail, which should
727 correspond to an account that you had in Thunderbird, e.g. the acount whose
728 rules you are converting.
730 This script presumes that your folder hierarchy in Claws Mail matches the
731 one that you had in Thunderbird. If you used the tbird2claws.py script to
732 convert your Thunderbird mailbox, then the folder hierarchy should match.
734 If the Claws Mail filtering configuration file (matcherrc) does not exist,
735 the script will create it; if it does exist, the newly converted rules will
742 Contact: Paul Mangan <paul@claws-mail.org>
744 --------------------------------------------------------------------------------
752 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
753 into an X-Face graphic suitable for inclusion into custom headers of
754 Claws Mail. An X-Face allows to quickly identify (or be identified
755 as) the sender of a mail message in a xface-capable MUA (like Claws
759 After obtaining the desired image for your X-Face you should:
760 * scale it to 48x48 pixels (Image->Scale image on Gimp)
761 * down color depth to b/w (Image->Mode->Indexed selecting "Use
762 Black/White palette" and the desired dithering options (prior to
763 indexing doing Image->Colors->Threshold allows you to select the
764 b/w level if you don't want a dithered (dotty) image))
765 * save file as non-interlaced GIF
768 ./gif2xface < filename.gif > filename.xface
770 In filename.xface will be the X-Face header ready to use.
771 You can add a custom header in Claws Mail through Configuration->
772 Preferences per account, "Send" tab, check "Add user-defined header"
773 then "Edit..." if you want to add it via the Claws Mail interface, or do
775 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
777 if you want to create the custom headers file yourself (Warning: this
778 method is valid only if you don't have any other custom header set or
781 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
787 This script is a message catalog translator's tool, it updates the .po
788 files named on the command line.
791 This script needs to be copied to and run from the 'po' directory.
793 ./update-po lang.po lang2.po ...
795 to update one or more <yourlang>.po files from the sourcecode files
796 named in POTFILES.in. The old .po file is save in a .po.old file.
798 For example, when you want to update fr.po, run ./update-po fr.po,
799 then edit fr.po to update your translation.
801 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
803 --------------------------------------------------------------------------------