2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
7 freshmeat_search.pl Search freshmeat.net for selected text
8 google_msgid.pl Search groups.google.com for selected message-id
9 google_search.pl Search google.com for selected text
10 multiwebsearch.pl Search any search engine for the selected text
11 textviewer.sh Attempt to view an attachment as plain text
12 uudec Decode and display uuencoded images
13 uuooffice Decode uuencoded attachments and open them with
16 Addressbook conversion:
17 csv2addressbook.pl Import Becky, Thunderbird, Kmail, Gmail and Fox
19 eud2gc.py Convert Eudora address book to Gnomecard
20 kmail2claws-mail.pl Import a Kmail address book (KDE2)
21 kmail2claws-mail_v2.pl Import a Kmail address book (KDE3)
22 mew2claws-mail.pl Import a Mew address book
23 outlook2claws-mail.pl Import an Outlook generated contact list
24 tb2claws-mail Import The Bat! address books
25 vcard2xml.py Import an Evolution vCard
28 calypso_convert.pl Import mbox files with attachments from Calypso
29 convert_mbox.pl Import mbox files
30 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
31 tbird2claws.py Integrate a Thunderbird folder tree into Claws
34 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
35 claws-mail-compose-insert-files.pl
36 Insert files into a new Compose window
37 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
38 filter_conv.pl Convert old-style Sylpheed filters to filtering
39 fix-date.sh Replace/Add a message's Date field
40 mairix.sh A wrapper to mairix, to enable global searches in
42 nautilus2claws-mail.sh Send files from Nautilus
43 OOo2claws-mail.pl Send documents from OpenOffice.org
44 popfile-link.sh Open messages in POPFile control center to edit
46 sylprint.pl Printing engine, explained in README.sylprint
47 textviewer.pl Display various attachments as text
48 thunderbird-filters-convertor.pl
49 Convert Thunderbird filtering rules
52 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
53 update-po Update the .po files named on the command line.
55 --------------------------------------------------------------------------------
56 Detailed Descriptions:
57 --------------------------------------------------------------------------------
64 COMMAND: |google_msgid.pl
65 Lookup selected message-id in google using mozilla. Edit the script to use
70 COMMAND: |google_search.pl
71 Search google.com for selected text using the default Claws Mail browser
75 see further down for details
78 WORKS ON: current message part
79 COMMAND: textviewer.sh %p |
80 Attempt to view an attachment as plain text
83 WORKS ON: current message (or part of multipart message)
85 Decode and display uuencoded images using uudecode.
88 WORKS ON: current message (or part of multipart message)
89 COMMAND: uuooffice %f&
90 Decode uuencoded attachments and open them with OpenOffice
92 * More action examples can be found at the Claws Mail FAQ
93 http://www.claws-mail.org/faq/index.php/Actions
95 ** multiwebsearch.pl **
98 This is an Actions script that allows you to search
99 websites for the selected text. It uses the default
100 Claws Mail browser as configured through Claws Mail's
101 GUI and specified in ~/.claws-mail/clawsrc, and a
102 configuration file called multiwebsearch.conf.
105 The configuration file takes the following format:
107 ALIAS|URL PART|URL PART
109 ALIAS is a user-defined name; the first URL PART is the
110 url before the search term; the second URL PART is
111 optional and contains the remaining part of the url which
112 comes after the search term. A sample configuration file
116 Copy 'multiwebsearch.conf' to ~/.claws-mail/
119 a) pre-configured website
120 Command: multiwebsearch.pl --where="google" --what="%s"
122 Command: multiwebsearch.pl --where="%u" --what="%s"
124 In type a) "google" refers to one of the configured aliases,
125 this Action will always search the website referred to by
128 In type b) you will be presented with a dialog box into
129 which you type one of your configured aliases
132 Contact: Paul Mangan <paul@claws-mail.org>
133 --------------------------------------------------------------------------------
135 Address book conversion
136 -----------------------
141 This perl script will import a Becky, Thunderbird, Kmail, Gmail and
142 Fox Mail address book.
145 (You must run claws-mail at least once before running this script.)
149 In Becky you need to do a CSV full export with titles of your
152 Run the script with the following options:
154 perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
156 Addtionally you can use the option '--name="My address book"', if
157 you don't use this option the new Claws address book will be
158 called 'Becky address book'.
161 Thunderbird >= 2.0.0.6
162 ----------------------
163 In Thunderbird you need to export your address book as 'comma
166 Run the script with the following options:
168 perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
170 Addtionally you can use the option '--name="My address book"', if
171 you don't use this option the new Claws address book will be
172 called 'Thunderbird address book'.
174 Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
175 --------------------------------------
176 In Kaddressbook you need to export your address book as 'CSV List'.
178 Run the script with the following options:
180 perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
182 Addtionally you can use the option '--name="My address book"', if
183 you don't use this option the new Claws address book will be
184 called 'Kmail address book'.
186 WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
187 formatted CSV if the values are quoted.
191 In the Gmail web interface you need to export your address book
192 as Outlook CSV format.
194 Run the script with the following options:
196 perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
198 Addtionally you can use the option '--name="My address book"', if
199 you don't use this option the new Claws address book will be
200 called 'gmail address book'.
204 Export your Fox Mail address book as CSV with all possible headers.
206 Run the script with the following options:
208 perl csv2addressbook.pl --type=foxmail --csv=/full/path/to/file.csv
210 Addtionally you can use the option '--name="My address book"', if
211 you don't use this option the new Claws address book will be
212 called 'foxmail address book'.
214 You can also run the script with '--help' to get a brief usage message.
216 Contact: Paul Mangan <paul@claws-mail.org>
221 This python-script is a quick hack to convert an Eudora (v.3?)
222 addressbook to vCard (GnomeCard) format.
225 You may do whatever you want with it! (Also regarding copying)
226 However, the script is intended to use like this:
228 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
230 Be careful not to overwrite your original GnomeCard.gcrd!
231 (But of course you might want to add the converted stuff to it)
233 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
235 * kmail2claws-mail.pl
238 This perl script will convert an exported Kmail addressbook into a
239 Claws Mail addressbook. If your version of Kmail is 1.37 or
240 greater and/or your version of KAddressBook is 3.1beta1 or greater,
241 or this script mixes up your definitions and their related data, use
242 'kmail2claws-mail_v2.pl' instead.
245 (You must run claws-mail at least once before running this script.)
247 In Kmail's Address book choose '/File/Export List'. This will export
248 your Kmail address book data to a *.csv file.
250 If Claws Mail is running, close it.
252 From the command line, execute the following:
254 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
256 Your Kmail address book data will now be contained in Claws Mail'
257 address book, under the name 'Kmail Address Book'.
259 Contact: Paul Mangan <paul@claws-mail.org>
262 * kmail2claws-mail_v2.pl
264 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
267 This perl script will convert a Kmail address book that has been
268 exported in csv format into a Claws Mail address book.
271 (You must run claws-mail at least once before running this script.)
273 Open Kmail's Addressbook, /File/Address Book
274 In Kmail's Addressbook choose '/File/Export/Export List...'. This
275 will allow you to export your Kmail addressbook data to a *.csv file.
277 If Claws Mail is running, close it.
279 From the command line, execute the following:
281 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
283 You can also use --help to see usage instructions.
285 Your Kmail addressbook data will now be contained in Claws Mail'
286 addressbook, under the name 'Kmail address book'.
288 Contact: Paul Mangan <paul@claws-mail.org>
293 This perl script will convert a Mew address book into a Claws Mail
297 (You must run claws-mail at least once before running this script.)
299 If Claws Mail is running, close it.
301 From the command line, execute the following:
303 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
305 You can also use --help to see usage instructions.
307 Your Mew addressbook data will now be contained in Claws Mail's
308 addressbook, under the name 'Mew Address Book'.
310 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
312 * outlook2claws-mail.pl
315 This perl script converts an Outlook generated contact list into a
316 Claws Mail XML address book.
321 You must export Outlook Express contact list as TXT file, choosing
322 only "Name" and "Address" fields to export.
324 You must exit Claws Mail before converting the contact list.
326 From the command line, execute the following:
328 outlook2claws-mail.pl fullpathname
332 You must export Outlook contact list as CSV file, choosing ALL the
333 fields available for exporting.
335 You must exit Claws Mail before converting the contact list.
337 From the command line, execute the following:
339 outlook2claws-mail.pl --csv fullpathname
342 For text files only works with fields described above. If you have
343 more complex examples send them to me, and I'll try to enhance the
346 For csv files you must export all fields (but only non empty fields
347 are added to the created Claws Mail address book) and the number
348 of fields expected is harcoded. Look for the $nboffields variable in
349 the script and change its value if you are sure you exported all
350 fields and script gives the 'unknown csv file format' error.
352 Contact: Ricardo Mones <ricardo@mones.org>
358 This perl script will convert an address book exported from The Bat!
359 into a Claws Mail address book.
362 (You must run claws-mail at least once before running this script.)
364 If Claws Mail is running, close it.
366 Export The Bat! Address Book to CSV file format with all fields
367 selected to YES and then start:
369 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
371 The Bat! addressbook data will now be contained in Claws Mail'
372 addressbook, under the name 'The Bat! Address Book'.
374 Contact: Urke MMI <urke@gmx.net>
380 This python script will convert an Evolution vCard into a Claws Mail
384 (You must run claws-mail at least once before running this script.)
386 If Claws Mail is running, close it.
387 From the command line, execute the following:
389 vcard2xml.py source_file [destination_file]
391 When only <source_file> is specified it will overwrite (and
392 create a backup of) the existing addressbook.
393 When both arguments are suplied it will create a new additional
394 addressbook named as <destination_file>.
395 If the script encounters an error it will attempt to roll back
396 the changes and restore the original files.
398 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
400 --------------------------------------------------------------------------------
408 This perl script imports mbox files that are exported by Calypso.
409 It recreates the folder structure by scanning the "X-CalypsoFolder"
410 header and reincludes the attachments referenced in the
411 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
414 Export the Calypso mailbox by selecting "Save to archive" and check
415 the "Save attachments" box.
417 Edit the script to set following variables (at the top of the file):
418 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
419 $mboxfile : name of exported mbox, e.g. 'mail.txt'
420 $outdir : name of the MH folder to create, e.g. 'Calypso'
424 perl calypso_convert.pl
426 Finally, import that folder by either selecting "New mailbox" or
427 moving it into your existing directory and recreate the folder
428 structure manually (contentmenu from folderview).
430 Contact: Thorsten Maerz <torte@netztorte.de>
435 This perl script converts an mbox directory's contents into
436 Claws Mail' MH format.
440 Run the script using:
442 perl convert_mbox.pl MBOX MH_DIR
444 Move the outputted MH_DIR and its contents into your Claws Mail
445 Mail folder; in Claws Mail right-click the top-level folder and
446 choose 'Rebuild folder tree' from the popup menu.
448 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
450 * kmail-mailbox2claws-mail.pl
453 This perl script converts a kmail mailbox into Claws Mail' mailbox.
457 Exit Claws Mail if running.
459 Run the script using:
461 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
463 Start Claws Mail and right-click the toplevel mailbox, i.e
464 "Mailbox (MH)", and select 'Rebuild folder tree'.
465 You may also need to run '/File/Folder/Check for new messages
470 --dry-run test mode, nothing is actually written
471 --help brief usage info
473 Contact: Paul Mangan <paul@claws-mail.org>
478 This python script integrates a Thunderbird folder tree into
483 The script receives two parameters from command-line:
484 <Thunderbird folder path> <Claws Mail folder path>
486 The best way to use it is to go to inside your Thunderbird
487 root mailfolder directory and invoke it as:
489 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
491 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
493 --------------------------------------------------------------------------------
498 * acroread2claws-mail.pl
501 This perl script enables Adobe Reader 7 to send documents to
502 Claws Mail as attachments.
505 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
506 Start up Adobe Reader 7 (acroread)
507 Go to /Edit/Preferences/SendMail
508 Select any email client except 'System Mail (mail)'
509 Enter the path to this script in the alternate location box
511 You can then use 'File/Email' or the Email toolbar button to launch
512 claws-mail (if not already launched) and open a new compose window
513 with the PDF attached.
515 Contact: Paul Mangan <paul@claws-mail.org>
517 * claws-mail-compose-insert-files.pl
520 This script enables inserting files into the message body of a new
521 Claws Mail Compose window from the command line. Additionally To,
522 Cc, Bcc, Subject and files to attach to the message can be specified.
525 claws-mail-compose-insert-files.pl [options]
528 --to "Person One <mail@address.net>"
529 --cc "Person One <mail@address.net>"
530 --bcc "Person One <mail@address.net>"
531 --subject "My subject"
535 For multiple recipients separate the addresses with ','
536 e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
537 --attach and --insert can be used multiple times
539 Contact: Paul Mangan <paul@claws-mail.org>
544 This perl script provides easy conversion of your filtering rules from
545 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
547 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
548 writes '~/[CLAWS CONFIG DIR]/matcherrc'
551 Issue the following command from the 'tools' directory:
553 perl filter_conv_new.pl
555 That's it, the claws' filtering system is now implemented with your
556 previous rules applied.
561 Contact: Paul Mangan <paul@claws-mail.org>
567 This perl script provides easy conversion of your filtering rules
568 from sylpheed's old filter system (< 0.9.99) to the filtering system
570 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
573 Issue the following command from the 'tools' directory:
577 That's it, the new filtering system is now implemented with your
578 previous rules applied.
580 Contact: Paul Mangan <paul@claws-mail.org>
586 Add a 'Date:' header to the selected email(s) when such header is
587 missing. The correct date is guessed from other headers that contain
588 timestamp information (preferred: Fetchinfo header if found) or from
589 the file or system date as a fallback. The order or preference for the
590 date valuereplacement can be changed by editing the script.
591 This script can be used to fix messages that show non RFC-compliant
592 Date headers as well.
593 X-Original-Date is always added too if not already existing (if so,
594 it's left untouched), to keep track of the original value if any.
595 An existing Date: header is not overwritten unless you use the --force
597 Non RFC-compliant dates can be overwritten using the --rfc switch. Use
598 --strict to use strict RFC matching patterns for date values in other
604 Contact: wwp <wwp@claws-mail.org>
610 It's a wrapper to mairix, a tool that makes indexed searches
611 and shows search results in a virtual folder. Maildir, MH and
612 mbox formats are supported, see:
613 http://www.rpcurnow.force9.co.uk/mairix/
617 mairix.sh <mairix rcfile> [<mairix options>..]
620 mairix.sh ~/.mairixrc s:word1,word2
622 Contact: wwp <wwp@claws-mail.org>
625 * nautilus2claws-mail.sh
628 This script will recursively attach a number of selected
629 files/directories from Nautilus to a new blank e-mail.
632 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
633 and restart nautilus (killall -9 nautilus). You will now have
634 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
636 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
642 This perl script enables OpenOffice.org to send documents to
643 Claws Mail as attachments.
646 OpenOffice.org Version 2.0
647 ----------------------------
648 This script is not needed for OOo version 2, which can work
649 directly with Claws Mail.
650 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
653 OpenOffice.org Version 1.1.0
654 ----------------------------
655 Start up OpenOffice.org.
656 Go to 'Tools/Options/OpenOffice.org/External Programs'
657 Select either ''Mozilla 1.x (Option 1)', or
658 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
659 Enter the path to OOo2claws-mail.pl in the 'Path' box
660 or select it by clicking on the '...' button.
662 You can then use 'File/Send/Document as email' to launch
663 claws-mail (if not already launched) and open a new compose
664 window with the document attached.
666 OpenOffice.org Version 1.0
667 --------------------------
668 Start up OpenOffice.org.
669 Go to 'Tools/Options/OpenOffice.org/External Programs'
670 Enter the path to OOo2claws-mail.pl in the 'Program' box
671 or select it by clicking on the '...' button.
674 Contact: Paul Mangan <paul@claws-mail.org>
680 Open selected messages in POPFile control center to edit their
681 status. Requires that POPFile is running and that the messages
682 have been processed by it (X-POPFile-Link: header is expected).
683 POPFile control center opens with the web browser set in
687 popfile-link.sh <filename> [<filename>..]
690 Contact: wwp <wwp@claws-mail.org>
696 This script tries to recognise an attachment by using the 'file'
697 command and/or the file extension and then uses the available
698 utilities to make an effort to display it as text. For example
703 .html txt2htm or text2html
704 .xls, .sxc, .csv xlscat -L
708 .pl, .pm perltidy -st -se or cat
709 .bz2 bzip2 -d < %f | strings
712 Go to /Configuration/Message View/External Programs and enter the
713 path to the script in the "Command for 'Display as text'" box.
714 Now when you right-click an attachment and choose 'Display as text'
715 this script will be invoked.
718 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
721 * thunderbird-filters-convertor.pl
724 This perl script converts Thunderbird filtering rules into Claws Mail
725 filtering rules. It can be run several times, once for each filter
726 configuration file in Thunderbird.
729 The script takes 3 arguments:
731 --tbird-file=PATH TO FILE The full path to the file to be converted
732 --mailbox-name=NAME The name of the Claws Mail mailbox
733 --account-name=NAME The name of the account to be used (optional)
735 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
736 that you want to convert, it must contain the full path to the file.
737 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
738 if the top-level folder is 'Mailbox (MH)' then this option should be
740 --account-name is optional, only needed if you are creating account-specific
741 rules. This is the name of your account in Claws Mail, which should
742 correspond to an account that you had in Thunderbird, e.g. the acount whose
743 rules you are converting.
745 This script presumes that your folder hierarchy in Claws Mail matches the
746 one that you had in Thunderbird. If you used the tbird2claws.py script to
747 convert your Thunderbird mailbox, then the folder hierarchy should match.
749 If the Claws Mail filtering configuration file (matcherrc) does not exist,
750 the script will create it; if it does exist, the newly converted rules will
757 Contact: Paul Mangan <paul@claws-mail.org>
759 --------------------------------------------------------------------------------
767 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
768 into an X-Face graphic suitable for inclusion into custom headers of
769 Claws Mail. An X-Face allows to quickly identify (or be identified
770 as) the sender of a mail message in a xface-capable MUA (like Claws
774 After obtaining the desired image for your X-Face you should:
775 * scale it to 48x48 pixels (Image->Scale image on Gimp)
776 * down color depth to b/w (Image->Mode->Indexed selecting "Use
777 Black/White palette" and the desired dithering options (prior to
778 indexing doing Image->Colors->Threshold allows you to select the
779 b/w level if you don't want a dithered (dotty) image))
780 * save file as non-interlaced GIF
783 ./gif2xface < filename.gif > filename.xface
785 In filename.xface will be the X-Face header ready to use.
786 You can add a custom header in Claws Mail through Configuration->
787 Preferences per account, "Send" tab, check "Add user-defined header"
788 then "Edit..." if you want to add it via the Claws Mail interface, or do
790 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
792 if you want to create the custom headers file yourself (Warning: this
793 method is valid only if you don't have any other custom header set or
796 Contact: Ricardo Mones <ricardo@mones.org>
802 This script is a message catalog translator's tool, it updates the .po
803 files named on the command line.
806 This script needs to be copied to and run from the 'po' directory.
808 ./update-po lang.po lang2.po ...
810 to update one or more <yourlang>.po files from the sourcecode files
811 named in POTFILES.in. The old .po file is save in a .po.old file.
813 For example, when you want to update fr.po, run ./update-po fr.po,
814 then edit fr.po to update your translation.
816 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
818 --------------------------------------------------------------------------------
819 This file is Copyright 1999-2014 by the Claws Mail team.
820 See accompanying COPYING file for license details.
821 See each included script for copyright and license details.