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
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, Kmail and Gmail
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.
195 In the Gmail web interface you need to export your address book
196 as Outlook CSV format.
198 Run the script with the following options:
200 perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
202 Addtionally you can use the option '--name="My address book"', if
203 you don't use this option the new Claws address book will be
204 called 'gmail address book'.
206 You can also run the script with '--help' to get a brief usage message.
208 Contact: Paul Mangan <paul@claws-mail.org>
213 This python-script is a quick hack to convert an Eudora (v.3?)
214 addressbook to vCard (GnomeCard) format.
217 You may do whatever you want with it! (Also regarding copying)
218 However, the script is intended to use like this:
220 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
222 Be careful not to overwrite your original GnomeCard.gcrd!
223 (But of course you might want to add the converted stuff to it)
225 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
227 * kmail2claws-mail.pl
230 This perl script will convert an exported Kmail addressbook into a
231 Claws Mail addressbook. If your version of Kmail is 1.37 or
232 greater and/or your version of KAddressBook is 3.1beta1 or greater,
233 or this script mixes up your definitions and their related data, use
234 'kmail2claws-mail_v2.pl' instead.
237 (You must run claws-mail at least once before running this script.)
239 In Kmail's Address book choose '/File/Export List'. This will export
240 your Kmail address book data to a *.csv file.
242 If Claws Mail is running, close it.
244 From the command line, execute the following:
246 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
248 Your Kmail address book data will now be contained in Claws Mail'
249 address book, under the name 'Kmail Address Book'.
251 Contact: Paul Mangan <paul@claws-mail.org>
254 * kmail2claws-mail_v2.pl
256 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
259 This perl script will convert a Kmail address book that has been
260 exported in csv format into a Claws Mail address book.
263 (You must run claws-mail at least once before running this script.)
265 Open Kmail's Addressbook, /File/Address Book
266 In Kmail's Addressbook choose '/File/Export/Export List...'. This
267 will allow you to export your Kmail addressbook data to a *.csv file.
269 If Claws Mail is running, close it.
271 From the command line, execute the following:
273 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
275 You can also use --help to see usage instructions.
277 Your Kmail addressbook data will now be contained in Claws Mail'
278 addressbook, under the name 'Kmail address book'.
280 Contact: Paul Mangan <paul@claws-mail.org>
285 This perl script will convert a Mew address book into a Claws Mail
289 (You must run claws-mail at least once before running this script.)
291 If Claws Mail is running, close it.
293 From the command line, execute the following:
295 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
297 You can also use --help to see usage instructions.
299 Your Mew addressbook data will now be contained in Claws Mail's
300 addressbook, under the name 'Mew Address Book'.
302 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
304 * outlook2claws-mail.pl
307 This perl script converts an Outlook generated contact list into a
308 Claws Mail XML address book.
313 You must export Outlook Express contact list as TXT file, choosing
314 only "Name" and "Address" fields to export.
316 You must exit Claws Mail before converting the contact list.
318 From the command line, execute the following:
320 outlook2claws-mail.pl fullpathname
324 You must export Outlook contact list as CSV file, choosing ALL the
325 fields available for exporting.
327 You must exit Claws Mail before converting the contact list.
329 From the command line, execute the following:
331 outlook2claws-mail.pl --csv fullpathname
334 For text files only works with fields described above. If you have
335 more complex examples send them to me, and I'll try to enhance the
338 For csv files you must export all fields (but only non empty fields
339 are added to the created Claws Mail address book) and the number
340 of fields expected is harcoded. Look for the $nboffields variable in
341 the script and change its value if you are sure you exported all
342 fields and script gives the 'unknown csv file format' error.
344 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
350 This perl script will convert an address book exported from The Bat!
351 into a Claws Mail address book.
354 (You must run claws-mail at least once before running this script.)
356 If Claws Mail is running, close it.
358 Export The Bat! Address Book to CSV file format with all fields
359 selected to YES and then start:
361 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
363 The Bat! addressbook data will now be contained in Claws Mail'
364 addressbook, under the name 'The Bat! Address Book'.
366 Contact: Urke MMI <urke@gmx.net>
372 This python script will convert an Evolution vCard into a Claws Mail
376 (You must run claws-mail at least once before running this script.)
378 If Claws Mail is running, close it.
379 From the command line, execute the following:
381 vcard2xml.py source_file [destination_file]
383 When only <source_file> is specified it will overwrite (and
384 create a backup of) the existing addressbook.
385 When both arguments are suplied it will create a new additional
386 addressbook named as <destination_file>.
387 If the script encounters an error it will attempt to roll back
388 the changes and restore the original files.
390 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
392 --------------------------------------------------------------------------------
400 This perl script imports mbox files that are exported by Calypso.
401 It recreates the folder structure by scanning the "X-CalypsoFolder"
402 header and reincludes the attachments referenced in the
403 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
406 Export the Calypso mailbox by selecting "Save to archive" and check
407 the "Save attachments" box.
409 Edit the script to set following variables (at the top of the file):
410 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
411 $mboxfile : name of exported mbox, e.g. 'mail.txt'
412 $outdir : name of the MH folder to create, e.g. 'Calypso'
416 perl calypso_convert.pl
418 Finally, import that folder by either selecting "New mailbox" or
419 moving it into your existing directory and recreate the folder
420 structure manually (contentmenu from folderview).
422 Contact: Thorsten Maerz <torte@netztorte.de>
427 This perl script converts an mbox directory's contents into
428 Claws Mail' MH format.
432 Run the script using:
434 perl convert_mbox.pl MBOX MH_DIR
436 Move the outputted MH_DIR and its contents into your Claws Mail
437 Mail folder; in Claws Mail right-click the top-level folder and
438 choose 'Rebuild folder tree' from the popup menu.
440 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
442 * kmail-mailbox2claws-mail.pl
445 This perl script converts a kmail mailbox into Claws Mail' mailbox.
449 Exit Claws Mail if running.
451 Run the script using:
453 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
455 Start Claws Mail and right-click the toplevel mailbox, i.e
456 "Mailbox (MH)", and select 'Rebuild folder tree'.
457 You may also need to run '/File/Folder/Check for new messages
462 --dry-run test mode, nothing is actually written
463 --help brief usage info
465 Contact: Paul Mangan <paul@claws-mail.org>
470 This python script integrates a Thunderbird folder tree into
475 The script receives two parameters from command-line:
476 <Thunderbird folder path> <Claws Mail folder path>
478 The best way to use it is to go to inside your Thunderbird
479 root mailfolder directory and invoke it as:
481 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
483 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
485 --------------------------------------------------------------------------------
490 * acroread2claws-mail.pl
493 This perl script enables Adobe Reader 7 to send documents to
494 Claws Mail as attachments.
497 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
498 Start up Adobe Reader 7 (acroread)
499 Go to /Edit/Preferences/SendMail
500 Select any email client except 'System Mail (mail)'
501 Enter the path to this script in the alternate location box
503 You can then use 'File/Email' or the Email toolbar button to launch
504 claws-mail (if not already launched) and open a new compose window
505 with the PDF attached.
507 Contact: Paul Mangan <paul@claws-mail.org>
509 * claws-mail-compose-insert-files.pl
512 This script enables inserting files into the message body of a new
513 Claws Mail Compose window from the command line. Additionally To,
514 Cc, Bcc, Subject and files to attach to the message can be specified.
517 claws-mail-compose-insert-files.pl [options]
520 --to "Person One <mail@address.net>"
521 --cc "Person One <mail@address.net>"
522 --bcc "Person One <mail@address.net>"
523 --subject "My subject"
527 For multiple recipients separate the addresses with ','
528 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
529 --attach and --insert can be used multiple times
531 Contact: Paul Mangan <paul@claws-mail.org>
536 This perl script provides easy conversion of your filtering rules from
537 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
539 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
540 writes '~/[CLAWS CONFIG DIR]/matcherrc'
543 Issue the following command from the 'tools' directory:
545 perl filter_conv_new.pl
547 That's it, the claws' filtering system is now implemented with your
548 previous rules applied.
553 Contact: Paul Mangan <paul@claws-mail.org>
559 This perl script provides easy conversion of your filtering rules
560 from sylpheed's old filter system (< 0.9.99) to the filtering system
562 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
565 Issue the following command from the 'tools' directory:
569 That's it, the new filtering system is now implemented with your
570 previous rules applied.
572 Contact: Paul Mangan <paul@claws-mail.org>
578 It will replace the Date: value w/ the one picked up from
579 more recent Received: field if this field resides in one
580 line. Otherwise, it will take the file modification time
581 (using a RFC 2822-compliant form). If no X-Original-Date already
582 exist, the former Date value will be set in such field.
585 fix_date.sh <filename> [<filename>..]
587 Contact: wwp <wwp@claws-mail.org>
593 It's a wrapper to mairix, a tool that makes indexed searches
594 and shows search results in a virtual folder. Maildir, MH and
595 mbox formats are supported, see:
596 http://www.rpcurnow.force9.co.uk/mairix/
600 mairix.sh <mairix rcfile> [<mairix options>..]
603 mairix.sh ~/.mairixrc s:word1,word2
605 Contact: wwp <wwp@claws-mail.org>
608 * nautilus2claws-mail.sh
611 This script will recursively attach a number of selected
612 files/directories from Nautilus to a new blank e-mail.
615 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
616 and restart nautilus (killall -9 nautilus). You will now have
617 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
619 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
625 This perl script enables OpenOffice.org to send documents to
626 Claws Mail as attachments.
629 OpenOffice.org Version 2.0
630 ----------------------------
631 This script is not needed for OOo version 2, which can work
632 directly with Claws Mail.
633 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
636 OpenOffice.org Version 1.1.0
637 ----------------------------
638 Start up OpenOffice.org.
639 Go to 'Tools/Options/OpenOffice.org/External Programs'
640 Select either ''Mozilla 1.x (Option 1)', or
641 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
642 Enter the path to OOo2claws-mail.pl in the 'Path' box
643 or select it by clicking on the '...' button.
645 You can then use 'File/Send/Document as email' to launch
646 claws-mail (if not already launched) and open a new compose
647 window with the document attached.
649 OpenOffice.org Version 1.0
650 --------------------------
651 Start up OpenOffice.org.
652 Go to 'Tools/Options/OpenOffice.org/External Programs'
653 Enter the path to OOo2claws-mail.pl in the 'Program' box
654 or select it by clicking on the '...' button.
657 Contact: Paul Mangan <paul@claws-mail.org>
663 Open selected messages in POPFile control center to edit their
664 status. Requires that POPFile is running and that the messages
665 have been processed by it (X-POPFile-Link: header is expected).
666 POPFile control center opens with the web browser set in
670 popfile-link.sh <filename> [<filename>..]
673 Contact: wwp <wwp@claws-mail.org>
679 This script tries to recognise an attachment by using the 'file'
680 command and/or the file extension and then uses the available Linux
681 utilities to make an effort to display it as text. For example
686 .html txt2htm or text2html
687 .xls, .sxc, .csv xlscat -L
691 .pl, .pm perltidy -st -se or cat
692 .bz2 bzip2 -d < %f | strings
695 Go to /Configuration/Message View/External Programs and enter the
696 path to the script in the "Command for 'Display as text'" box.
697 Now when you right-click an attachment and choose 'Display as text'
698 this script will be invoked.
701 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
704 * thunderbird-filters-convertor.pl
707 This perl script converts Thunderbird filtering rules into Claws Mail
708 filtering rules. It can be run several times, once for each filter
709 configuration file in Thunderbird.
712 The script takes 3 arguments:
714 --tbird-file=PATH TO FILE The full path to the file to be converted
715 --mailbox-name=NAME The name of the Claws Mail mailbox
716 --account-name=NAME The name of the account to be used (optional)
718 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
719 that you want to convert, it must contain the full path to the file.
720 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
721 if the top-level folder is 'Mailbox (MH)' then this option should be
723 --account-name is optional, only needed if you are creating account-specific
724 rules. This is the name of your account in Claws Mail, which should
725 correspond to an account that you had in Thunderbird, e.g. the acount whose
726 rules you are converting.
728 This script presumes that your folder hierarchy in Claws Mail matches the
729 one that you had in Thunderbird. If you used the tbird2claws.py script to
730 convert your Thunderbird mailbox, then the folder hierarchy should match.
732 If the Claws Mail filtering configuration file (matcherrc) does not exist,
733 the script will create it; if it does exist, the newly converted rules will
740 Contact: Paul Mangan <paul@claws-mail.org>
742 --------------------------------------------------------------------------------
750 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
751 into an X-Face graphic suitable for inclusion into custom headers of
752 Claws Mail. An X-Face allows to quickly identify (or be identified
753 as) the sender of a mail message in a xface-capable MUA (like Claws
757 After obtaining the desired image for your X-Face you should:
758 * scale it to 48x48 pixels (Image->Scale image on Gimp)
759 * down color depth to b/w (Image->Mode->Indexed selecting "Use
760 Black/White palette" and the desired dithering options (prior to
761 indexing doing Image->Colors->Threshold allows you to select the
762 b/w level if you don't want a dithered (dotty) image))
763 * save file as non-interlaced GIF
766 ./gif2xface < filename.gif > filename.xface
768 In filename.xface will be the X-Face header ready to use.
769 You can add a custom header in Claws Mail through Configuration->
770 Preferences per account, "Send" tab, check "Add user-defined header"
771 then "Edit..." if you want to add it via the Claws Mail interface, or do
773 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
775 if you want to create the custom headers file yourself (Warning: this
776 method is valid only if you don't have any other custom header set or
779 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
785 This script is a message catalog translator's tool, it updates the .po
786 files named on the command line.
789 This script needs to be copied to and run from the 'po' directory.
791 ./update-po lang.po lang2.po ...
793 to update one or more <yourlang>.po files from the sourcecode files
794 named in POTFILES.in. The old .po file is save in a .po.old file.
796 For example, when you want to update fr.po, run ./update-po fr.po,
797 then edit fr.po to update your translation.
799 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
801 --------------------------------------------------------------------------------