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 or Thunderbird 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 address book and a Thunderbird
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 You can also run the script with '--help' to get a brief usage message.
180 Contact: Paul Mangan <paul@claws-mail.org>
185 This python-script is a quick hack to convert an Eudora (v.3?)
186 addressbook to vCard (GnomeCard) format.
189 You may do whatever you want with it! (Also regarding copying)
190 However, the script is intended to use like this:
192 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
194 Be careful not to overwrite your original GnomeCard.gcrd!
195 (But of course you might want to add the converted stuff to it)
197 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
199 * kmail2claws-mail.pl
202 This perl script will convert an exported Kmail addressbook into a
203 Claws Mail addressbook. If your version of Kmail is 1.37 or
204 greater and/or your version of KAddressBook is 3.1beta1 or greater,
205 or this script mixes up your definitions and their related data, use
206 'kmail2claws-mail_v2.pl' instead.
209 (You must run claws-mail at least once before running this script.)
211 In Kmail's Address book choose '/File/Export List'. This will export
212 your Kmail address book data to a *.csv file.
214 If Claws Mail is running, close it.
216 From the command line, execute the following:
218 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
220 Your Kmail address book data will now be contained in Claws Mail'
221 address book, under the name 'Kmail Address Book'.
223 Contact: Paul Mangan <paul@claws-mail.org>
226 * kmail2claws-mail_v2.pl
228 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
231 This perl script will convert a Kmail address book that has been
232 exported in csv format into a Claws Mail address book.
235 (You must run claws-mail at least once before running this script.)
237 Open Kmail's Addressbook, /File/Address Book
238 In Kmail's Addressbook choose '/File/Export/Export List...'. This
239 will allow you to export your Kmail addressbook data to a *.csv file.
241 If Claws Mail is running, close it.
243 From the command line, execute the following:
245 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
247 You can also use --help to see usage instructions.
249 Your Kmail addressbook data will now be contained in Claws Mail'
250 addressbook, under the name 'Kmail address book'.
252 Contact: Paul Mangan <paul@claws-mail.org>
257 This perl script will convert a Mew address book into a Claws Mail
261 (You must run claws-mail at least once before running this script.)
263 If Claws Mail is running, close it.
265 From the command line, execute the following:
267 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
269 You can also use --help to see usage instructions.
271 Your Mew addressbook data will now be contained in Claws Mail's
272 addressbook, under the name 'Mew Address Book'.
274 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
276 * outlook2claws-mail.pl
279 This perl script converts an Outlook generated contact list into a
280 Claws Mail XML address book.
285 You must export Outlook Express contact list as TXT file, choosing
286 only "Name" and "Address" fields to export.
288 You must exit Claws Mail before converting the contact list.
290 From the command line, execute the following:
292 outlook2claws-mail.pl fullpathname
296 You must export Outlook contact list as CSV file, choosing ALL the
297 fields available for exporting.
299 You must exit Claws Mail before converting the contact list.
301 From the command line, execute the following:
303 outlook2claws-mail.pl --csv fullpathname
306 For text files only works with fields described above. If you have
307 more complex examples send them to me, and I'll try to enhance the
310 For csv files you must export all fields (but only non empty fields
311 are added to the created Claws Mail address book) and the number
312 of fields expected is harcoded. Look for the $nboffields variable in
313 the script and change its value if you are sure you exported all
314 fields and script gives the 'unknown csv file format' error.
316 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
322 This perl script will convert an address book exported from The Bat!
323 into a Claws Mail address book.
326 (You must run claws-mail at least once before running this script.)
328 If Claws Mail is running, close it.
330 Export The Bat! Address Book to CSV file format with all fields
331 selected to YES and then start:
333 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
335 The Bat! addressbook data will now be contained in Claws Mail'
336 addressbook, under the name 'The Bat! Address Book'.
338 Contact: Urke MMI <urke@gmx.net>
344 This python script will convert an Evolution vCard into a Claws Mail
348 (You must run claws-mail at least once before running this script.)
350 If Claws Mail is running, close it.
351 From the command line, execute the following:
353 vcard2xml.py source_file [destination_file]
355 When only <source_file> is specified it will overwrite (and
356 create a backup of) the existing addressbook.
357 When both arguments are suplied it will create a new additional
358 addressbook named as <destination_file>.
359 If the script encounters an error it will attempt to roll back
360 the changes and restore the original files.
362 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
364 --------------------------------------------------------------------------------
372 This perl script imports mbox files that are exported by Calypso.
373 It recreates the folder structure by scanning the "X-CalypsoFolder"
374 header and reincludes the attachments referenced in the
375 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
378 Export the Calypso mailbox by selecting "Save to archive" and check
379 the "Save attachments" box.
381 Edit the script to set following variables (at the top of the file):
382 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
383 $mboxfile : name of exported mbox, e.g. 'mail.txt'
384 $outdir : name of the MH folder to create, e.g. 'Calypso'
388 perl calypso_convert.pl
390 Finally, import that folder by either selecting "New mailbox" or
391 moving it into your existing directory and recreate the folder
392 structure manually (contentmenu from folderview).
394 Contact: Thorsten Maerz <torte@netztorte.de>
399 This perl script converts an mbox directory's contents into
400 Claws Mail' MH format.
404 Run the script using:
406 perl convert_mbox.pl MBOX MH_DIR
408 Move the outputted MH_DIR and its contents into your Claws Mail
409 Mail folder; in Claws Mail right-click the top-level folder and
410 choose 'Rebuild folder tree' from the popup menu.
412 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
414 * kmail-mailbox2claws-mail.pl
417 This perl script converts a kmail mailbox into Claws Mail' mailbox.
421 Exit Claws Mail if running.
423 Run the script using:
425 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
427 Start Claws Mail and right-click the toplevel mailbox, i.e
428 "Mailbox (MH)", and select 'Rebuild folder tree'.
429 You may also need to run '/File/Folder/Check for new messages
434 --dry-run test mode, nothing is actually written
435 --help brief usage info
437 Contact: Paul Mangan <paul@claws-mail.org>
442 This python script integrates a Thunderbird folder tree into
447 The script receives two parameters from command-line:
448 <Thunderbird folder path> <Claws Mail folder path>
450 The best way to use it is to go to inside your Thunderbird
451 root mailfolder directory and invoke it as:
453 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
455 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
457 --------------------------------------------------------------------------------
462 * acroread2claws-mail.pl
465 This perl script enables Adobe Reader 7 to send documents to
466 Claws Mail as attachments.
469 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
470 Start up Adobe Reader 7 (acroread)
471 Go to /Edit/Preferences/SendMail
472 Select any email client except 'System Mail (mail)'
473 Enter the path to this script in the alternate location box
475 You can then use 'File/Email' or the Email toolbar button to launch
476 claws-mail (if not already launched) and open a new compose window
477 with the PDF attached.
479 Contact: Paul Mangan <paul@claws-mail.org>
481 * claws-mail-compose-insert-files.pl
484 This script enables inserting files into the message body of a new
485 Claws Mail Compose window from the command line. Additionally To,
486 Cc, Bcc, Subject and files to attach to the message can be specified.
489 claws-mail-compose-insert-files.pl [options]
492 --to "Person One <mail@address.net>"
493 --cc "Person One <mail@address.net>"
494 --bcc "Person One <mail@address.net>"
495 --subject "My subject"
499 For multiple recipients separate the addresses with ','
500 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
501 --attach and --insert can be used multiple times
503 Contact: Paul Mangan <paul@claws-mail.org>
508 This perl script provides easy conversion of your filtering rules from
509 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
511 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
512 writes '~/[CLAWS CONFIG DIR]/matcherrc'
515 Issue the following command from the 'tools' directory:
517 perl filter_conv_new.pl
519 That's it, the claws' filtering system is now implemented with your
520 previous rules applied.
525 Contact: Paul Mangan <paul@claws-mail.org>
531 This perl script provides easy conversion of your filtering rules
532 from sylpheed's old filter system (< 0.9.99) to the filtering system
534 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
537 Issue the following command from the 'tools' directory:
541 That's it, the new filtering system is now implemented with your
542 previous rules applied.
544 Contact: Paul Mangan <paul@claws-mail.org>
550 It will replace the Date: value w/ the one picked up from
551 more recent Received: field if this field resides in one
552 line. Otherwise, it will take the file modification time
553 (using a RFC 2822-compliant form). If no X-Original-Date already
554 exist, the former Date value will be set in such field.
557 fix_date.sh <filename> [<filename>..]
559 Contact: wwp <wwp@claws-mail.org>
565 It's a wrapper to mairix, a tool that makes indexed searches
566 and shows search results in a virtual folder. Maildir, MH and
567 mbox formats are supported, see:
568 http://www.rpcurnow.force9.co.uk/mairix/
572 mairix.sh <mairix rcfile> [<mairix options>..]
575 mairix.sh ~/.mairixrc s:word1,word2
577 Contact: wwp <wwp@claws-mail.org>
580 * nautilus2claws-mail.sh
583 This script will recursively attach a number of selected
584 files/directories from Nautilus to a new blank e-mail.
587 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
588 and restart nautilus (killall -9 nautilus). You will now have
589 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
591 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
597 This perl script enables OpenOffice.org to send documents to
598 Claws Mail as attachments.
601 OpenOffice.org Version 2.0
602 ----------------------------
603 This script is not needed for OOo version 2, which can work
604 directly with Claws Mail.
605 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
608 OpenOffice.org Version 1.1.0
609 ----------------------------
610 Start up OpenOffice.org.
611 Go to 'Tools/Options/OpenOffice.org/External Programs'
612 Select either ''Mozilla 1.x (Option 1)', or
613 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
614 Enter the path to OOo2claws-mail.pl in the 'Path' box
615 or select it by clicking on the '...' button.
617 You can then use 'File/Send/Document as email' to launch
618 claws-mail (if not already launched) and open a new compose
619 window with the document attached.
621 OpenOffice.org Version 1.0
622 --------------------------
623 Start up OpenOffice.org.
624 Go to 'Tools/Options/OpenOffice.org/External Programs'
625 Enter the path to OOo2claws-mail.pl in the 'Program' box
626 or select it by clicking on the '...' button.
629 Contact: Paul Mangan <paul@claws-mail.org>
635 Open selected messages in POPFile control center to edit their
636 status. Requires that POPFile is running and that the messages
637 have been processed by it (X-POPFile-Link: header is expected).
638 POPFile control center opens with the web browser set in
642 popfile-link.sh <filename> [<filename>..]
645 Contact: wwp <wwp@claws-mail.org>
651 This script tries to recognise an attachment by using the 'file'
652 command and/or the file extension and then uses the available Linux
653 utilities to make an effort to display it as text. For example
658 .html txt2htm or text2html
659 .xls, .sxc, .csv xlscat -L
663 .pl, .pm perltidy -st -se or cat
664 .bz2 bzip2 -d < %f | strings
667 Go to /Configuration/Message View/External Programs and enter the
668 path to the script in the "Command for 'Display as text'" box.
669 Now when you right-click an attachment and choose 'Display as text'
670 this script will be invoked.
673 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
676 * thunderbird-filters-convertor.pl
679 This perl script converts Thunderbird filtering rules into Claws Mail
680 filtering rules. It can be run several times, once for each filter
681 configuration file in Thunderbird.
684 The script takes 3 arguments:
686 --tbird-file=PATH TO FILE The full path to the file to be converted
687 --mailbox-name=NAME The name of the Claws Mail mailbox
688 --account-name=NAME The name of the account to be used (optional)
690 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
691 that you want to convert, it must contain the full path to the file.
692 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
693 if the top-level folder is 'Mailbox (MH)' then this option should be
695 --account-name is optional, only needed if you are creating account-specific
696 rules. This is the name of your account in Claws Mail, which should
697 correspond to an account that you had in Thunderbird, e.g. the acount whose
698 rules you are converting.
700 This script presumes that your folder hierarchy in Claws Mail matches the
701 one that you had in Thunderbird. If you used the tbird2claws.py script to
702 convert your Thunderbird mailbox, then the folder hierarchy should match.
704 If the Claws Mail filtering configuration file (matcherrc) does not exist,
705 the script will create it; if it does exist, the newly converted rules will
712 Contact: Paul Mangan <paul@claws-mail.org>
714 --------------------------------------------------------------------------------
722 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
723 into an X-Face graphic suitable for inclusion into custom headers of
724 Claws Mail. An X-Face allows to quickly identify (or be identified
725 as) the sender of a mail message in a xface-capable MUA (like Claws
729 After obtaining the desired image for your X-Face you should:
730 * scale it to 48x48 pixels (Image->Scale image on Gimp)
731 * down color depth to b/w (Image->Mode->Indexed selecting "Use
732 Black/White palette" and the desired dithering options (prior to
733 indexing doing Image->Colors->Threshold allows you to select the
734 b/w level if you don't want a dithered (dotty) image))
735 * save file as non-interlaced GIF
738 ./gif2xface < filename.gif > filename.xface
740 In filename.xface will be the X-Face header ready to use.
741 You can add a custom header in Claws Mail through Configuration->
742 Preferences per account, "Send" tab, check "Add user-defined header"
743 then "Edit..." if you want to add it via the Claws Mail interface, or do
745 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
747 if you want to create the custom headers file yourself (Warning: this
748 method is valid only if you don't have any other custom header set or
751 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
757 This script is a message catalog translator's tool, it updates the .po
758 files named on the command line.
761 This script needs to be copied to and run from the 'po' directory.
763 ./update-po lang.po lang2.po ...
765 to update one or more <yourlang>.po files from the sourcecode files
766 named in POTFILES.in. The old .po file is save in a .po.old file.
768 For example, when you want to update fr.po, run ./update-po fr.po,
769 then edit fr.po to update your translation.
771 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
773 --------------------------------------------------------------------------------