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 eud2gc.py Convert Eudora address book to Gnomecard
18 kmail2claws-mail.pl Import a Kmail address book (KDE2)
19 kmail2claws-mail_v2.pl Import a Kmail address book (KDE3)
20 mew2claws-mail.pl Import a Mew address book
21 outlook2claws-mail.pl Import an Outlook generated contact list
22 tb2claws-mail Import The Bat! address books
23 vcard2xml.py Import an Evolution vCard
26 calypso_convert.pl Import mbox files with attachments from Calypso
27 convert_mbox.pl Import mbox files
28 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
29 tbird2claws.py Integrate a Thunderbird folder tree into Claws
32 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
33 claws-mail-compose-insert-files.pl
34 Insert files into a new Compose window
35 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
36 filter_conv.pl Convert old-style Sylpheed filters to filtering
37 fix-date.sh Replace/Add a message's Date field
38 mairix.sh A wrapper to mairix, to enable global searches in
40 nautilus2claws-mail.sh Send files from Nautilus
41 OOo2claws-mail.pl Send documents from OpenOffice.org
42 popfile-link.sh Open messages in POPFile control center to edit
44 sylprint.pl Printing engine, explained in README.sylprint
45 textviewer.pl Display various attachments as text
46 thunderbird-filters-convertor.pl
47 Convert Thunderbird filtering rules
50 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
51 update-po Update the .po files named on the command line.
53 --------------------------------------------------------------------------------
54 Detailed Descriptions:
55 --------------------------------------------------------------------------------
62 COMMAND: |freshmeat_search.pl
63 Search freshmeat.net for selected text using the default Claws Mail browser
67 COMMAND: |google_msgid.pl
68 Lookup selected message-id in google using mozilla. Edit the script to use
73 COMMAND: |google_search.pl
74 Search google.com for selected text using the default Claws Mail browser
78 see further down for details
81 WORKS ON: current message part
82 COMMAND: textviewer.sh %p |
83 Attempt to view an attachment as plain text
86 WORKS ON: current message (or part of multipart message)
88 Decode and display uuencoded images using uudecode.
91 WORKS ON: current message (or part of multipart message)
92 COMMAND: uuooffice %f&
93 Decode uuencoded attachments and open them with OpenOffice
95 * More action examples can be found at the Claws Mail FAQ
96 http://www.claws-mail.org/faq/index.php/Actions
98 ** multiwebsearch.pl **
101 This is an Actions script that allows you to search
102 websites for the selected text. It uses the default
103 Claws Mail browser as configured through Claws Mail's
104 GUI and specified in ~/.claws-mail/clawsrc, and a
105 configuration file called multiwebsearch.conf.
108 The configuration file takes the following format:
110 ALIAS|URL PART|URL PART
112 ALIAS is a user-defined name; the first URL PART is the
113 url before the search term; the second URL PART is
114 optional and contains the remaining part of the url which
115 comes after the search term. A sample configuration file
119 Copy 'multiwebsearch.conf' to ~/.claws-mail/
122 a) pre-configured website
123 Command: multiwebsearch.pl --where="google" --what="%s"
125 Command: multiwebsearch.pl --where="%u" --what="%s"
127 In type a) "google" refers to one of the configured aliases,
128 this Action will always search the website referred to by
131 In type b) you will be presented with a dialog box into
132 which you type one of your configured aliases
135 Contact: Paul Mangan <paul@claws-mail.org>
136 --------------------------------------------------------------------------------
138 Address book conversion
139 -----------------------
144 This python-script is a quick hack to convert an Eudora (v.3?)
145 addressbook to vCard (GnomeCard) format.
148 You may do whatever you want with it! (Also regarding copying)
149 However, the script is intended to use like this:
151 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
153 Be careful not to overwrite your original GnomeCard.gcrd!
154 (But of course you might want to add the converted stuff to it)
156 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
158 * kmail2claws-mail.pl
161 This perl script will convert an exported Kmail addressbook into a
162 Claws Mail addressbook. If your version of Kmail is 1.37 or
163 greater and/or your version of KAddressBook is 3.1beta1 or greater,
164 or this script mixes up your definitions and their related data, use
165 'kmail2claws-mail_v2.pl' instead.
168 (You must run claws-mail at least once before running this script.)
170 In Kmail's Address book choose '/File/Export List'. This will export
171 your Kmail address book data to a *.csv file.
173 If Claws Mail is running, close it.
175 From the command line, execute the following:
177 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
179 Your Kmail address book data will now be contained in Claws Mail'
180 address book, under the name 'Kmail Address Book'.
182 Contact: Paul Mangan <paul@claws-mail.org>
185 * kmail2claws-mail_v2.pl
187 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
190 This perl script will convert a Kmail address book that has been
191 exported in csv format into a Claws Mail address book.
194 (You must run claws-mail at least once before running this script.)
196 Open Kmail's Addressbook, /File/Address Book
197 In Kmail's Addressbook choose '/File/Export/Export List...'. This
198 will allow you to export your Kmail addressbook data to a *.csv file.
200 If Claws Mail is running, close it.
202 From the command line, execute the following:
204 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
206 You can also use --help to see usage instructions.
208 Your Kmail addressbook data will now be contained in Claws Mail'
209 addressbook, under the name 'Kmail address book'.
211 Contact: Paul Mangan <paul@claws-mail.org>
216 This perl script will convert a Mew address book into a Claws Mail
220 (You must run claws-mail at least once before running this script.)
222 If Claws Mail is running, close it.
224 From the command line, execute the following:
226 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
228 You can also use --help to see usage instructions.
230 Your Mew addressbook data will now be contained in Claws Mail's
231 addressbook, under the name 'Mew Address Book'.
233 Contact: Jérôme Lelong <jerome.lelong@gmail.com>
235 * outlook2claws-mail.pl
238 This perl script converts an Outlook generated contact list into a
239 Claws Mail XML address book.
244 You must export Outlook Express contact list as TXT file, choosing
245 only "Name" and "Address" fields to export.
247 You must exit Claws Mail before converting the contact list.
249 From the command line, execute the following:
251 outlook2claws-mail.pl fullpathname
255 You must export Outlook contact list as CSV file, choosing ALL the
256 fields available for exporting.
258 You must exit Claws Mail before converting the contact list.
260 From the command line, execute the following:
262 outlook2claws-mail.pl --csv fullpathname
265 For text files only works with fields described above. If you have
266 more complex examples send them to me, and I'll try to enhance the
269 For csv files you must export all fields (but only non empty fields
270 are added to the created Claws Mail address book) and the number
271 of fields expected is harcoded. Look for the $nboffields variable in
272 the script and change its value if you are sure you exported all
273 fields and script gives the 'unknown csv file format' error.
275 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
281 This perl script will convert an address book exported from The Bat!
282 into a Claws Mail address book.
285 (You must run claws-mail at least once before running this script.)
287 If Claws Mail is running, close it.
289 Export The Bat! Address Book to CSV file format with all fields
290 selected to YES and then start:
292 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
294 The Bat! addressbook data will now be contained in Claws Mail'
295 addressbook, under the name 'The Bat! Address Book'.
297 Contact: Urke MMI <urke@gmx.net>
303 This python script will convert an Evolution vCard into a Claws Mail
307 (You must run claws-mail at least once before running this script.)
309 If Claws Mail is running, close it.
310 From the command line, execute the following:
312 vcard2xml.py source_file [destination_file]
314 When only <source_file> is specified it will overwrite (and
315 create a backup of) the existing addressbook.
316 When both arguments are suplied it will create a new additional
317 addressbook named as <destination_file>.
318 If the script encounters an error it will attempt to roll back
319 the changes and restore the original files.
321 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
323 --------------------------------------------------------------------------------
331 This perl script imports mbox files that are exported by Calypso.
332 It recreates the folder structure by scanning the "X-CalypsoFolder"
333 header and reincludes the attachments referenced in the
334 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
337 Export the Calypso mailbox by selecting "Save to archive" and check
338 the "Save attachments" box.
340 Edit the script to set following variables (at the top of the file):
341 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
342 $mboxfile : name of exported mbox, e.g. 'mail.txt'
343 $outdir : name of the MH folder to create, e.g. 'Calypso'
347 perl calypso_convert.pl
349 Finally, import that folder by either selecting "New mailbox" or
350 moving it into your existing directory and recreate the folder
351 structure manually (contentmenu from folderview).
353 Contact: Thorsten Maerz <torte@netztorte.de>
358 This perl script converts an mbox directory's contents into
359 Claws Mail' MH format.
363 Run the script using:
365 perl convert_mbox.pl MBOX MH_DIR
367 Move the outputted MH_DIR and its contents into your Claws Mail
368 Mail folder; in Claws Mail right-click the top-level folder and
369 choose 'Rebuild folder tree' from the popup menu.
371 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
373 * kmail-mailbox2claws-mail.pl
376 This perl script converts a kmail mailbox into Claws Mail' mailbox.
380 Exit Claws Mail if running.
382 Run the script using:
384 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
386 Start Claws Mail and right-click the toplevel mailbox, i.e
387 "Mailbox (MH)", and select 'Rebuild folder tree'.
388 You may also need to run '/File/Folder/Check for new messages
393 --dry-run test mode, nothing is actually written
394 --help brief usage info
396 Contact: Paul Mangan <paul@claws-mail.org>
401 This python script integrates a Thunderbird folder tree into
406 The script receives two parameters from command-line:
407 <Thunderbird folder path> <Claws Mail folder path>
409 The best way to use it is to go to inside your Thunderbird
410 root mailfolder directory and invoke it as:
412 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
414 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
416 --------------------------------------------------------------------------------
421 * acroread2claws-mail.pl
424 This perl script enables Adobe Reader 7 to send documents to
425 Claws Mail as attachments.
428 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
429 Start up Adobe Reader 7 (acroread)
430 Go to /Edit/Preferences/SendMail
431 Select any email client except 'System Mail (mail)'
432 Enter the path to this script in the alternate location box
434 You can then use 'File/Email' or the Email toolbar button to launch
435 claws-mail (if not already launched) and open a new compose window
436 with the PDF attached.
438 Contact: Paul Mangan <paul@claws-mail.org>
440 * claws-mail-compose-insert-files.pl
443 This script enables inserting files into the message body of a new
444 Claws Mail Compose window from the command line. Additionally To,
445 Cc, Subject and files to attach to the message can be specified.
448 claws-mail-compose-insert-files.pl [options]
451 --to mail@address.net[,mail2@address.net]
452 --cc mail@address.net[,mail2@address.net]
453 --subject "My subject"
457 --attach and --insert can be used multiple times
459 Contact: Paul Mangan <paul@claws-mail.org>
464 This perl script provides easy conversion of your filtering rules from
465 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
467 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
468 writes '~/[CLAWS CONFIG DIR]/matcherrc'
471 Issue the following command from the 'tools' directory:
473 perl filter_conv_new.pl
475 That's it, the claws' filtering system is now implemented with your
476 previous rules applied.
481 Contact: Paul Mangan <paul@claws-mail.org>
487 This perl script provides easy conversion of your filtering rules
488 from sylpheed's old filter system (< 0.9.99) to the filtering system
490 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
493 Issue the following command from the 'tools' directory:
497 That's it, the new filtering system is now implemented with your
498 previous rules applied.
500 Contact: Paul Mangan <paul@claws-mail.org>
506 It will replace the Date: value w/ the one picked up from
507 more recent Received: field if this field resides in one
508 line. Otherwise, it will take the file modification time
509 (using a RFC 2822-compliant form). If no X-Original-Date already
510 exist, the former Date value will be set in such field.
513 fix_date.sh <filename> [<filename>..]
515 Contact: wwp <wwp@claws-mail.org>
521 It's a wrapper to mairix, a tool that makes indexed searches
522 and shows search results in a virtual folder. Maildir, MH and
523 mbox formats are supported, see:
524 http://www.rpcurnow.force9.co.uk/mairix/
528 mairix.sh <mairix rcfile> [<mairix options>..]
531 mairix.sh ~/.mairixrc s:word1,word2
533 Contact: wwp <wwp@claws-mail.org>
536 * nautilus2claws-mail.sh
539 This script will recursively attach a number of selected
540 files/directories from Nautilus to a new blank e-mail.
543 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
544 and restart nautilus (killall -9 nautilus). You will now have
545 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
547 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
553 This perl script enables OpenOffice.org to send documents to
554 Claws Mail as attachments.
557 OpenOffice.org Version 2.0
558 ----------------------------
559 This script is not needed for OOo version 2, which can work
560 directly with Claws Mail.
561 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
564 OpenOffice.org Version 1.1.0
565 ----------------------------
566 Start up OpenOffice.org.
567 Go to 'Tools/Options/OpenOffice.org/External Programs'
568 Select either ''Mozilla 1.x (Option 1)', or
569 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
570 Enter the path to OOo2claws-mail.pl in the 'Path' box
571 or select it by clicking on the '...' button.
573 You can then use 'File/Send/Document as email' to launch
574 claws-mail (if not already launched) and open a new compose
575 window with the document attached.
577 OpenOffice.org Version 1.0
578 --------------------------
579 Start up OpenOffice.org.
580 Go to 'Tools/Options/OpenOffice.org/External Programs'
581 Enter the path to OOo2claws-mail.pl in the 'Program' box
582 or select it by clicking on the '...' button.
585 Contact: Paul Mangan <paul@claws-mail.org>
591 Open selected messages in POPFile control center to edit their
592 status. Requires that POPFile is running and that the messages
593 have been processed by it (X-POPFile-Link: header is expected).
594 POPFile control center opens with the web browser set in
598 popfile-link.sh <filename> [<filename>..]
601 Contact: wwp <wwp@claws-mail.org>
607 This script tries to recognise an attachment by using the 'file'
608 command and/or the file extension and then uses the available Linux
609 utilities to make an effort to display it as text. For example
614 .html txt2htm or text2html
615 .xls, .sxc, .csv xlscat -L
619 .pl, .pm perltidy -st -se or cat
620 .bz2 bzip2 -d < %f | strings
623 Go to /Configuration/Message View/External Programs and enter the
624 path to the script in the "Command for 'Display as text'" box.
625 Now when you right-click an attachment and choose 'Display as text'
626 this script will be invoked.
629 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
632 * thunderbird-filters-convertor.pl
635 This perl script converts Thunderbird filtering rules into Claws Mail
636 filtering rules. It can be run several times, once for each filter
637 configuration file in Thunderbird.
640 The script takes 3 arguments:
642 --tbird-file=PATH TO FILE The full path to the file to be converted
643 --mailbox-name=NAME The name of the Claws Mail mailbox
644 --account-name=NAME The name of the account to be used (optional)
646 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
647 that you want to convert, it must contain the full path to the file.
648 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
649 if the top-level folder is 'Mailbox (MH)' then this option should be
651 --account-name is optional, only needed if you are creating account-specific
652 rules. This is the name of your account in Claws Mail, which should
653 correspond to an account that you had in Thunderbird, e.g. the acount whose
654 rules you are converting.
656 This script presumes that your folder hierarchy in Claws Mail matches the
657 one that you had in Thunderbird. If you used the tbird2claws.py script to
658 convert your Thunderbird mailbox, then the folder hierarchy should match.
660 If the Claws Mail filtering configuration file (matcherrc) does not exist,
661 the script will create it; if it does exist, the newly converted rules will
668 Contact: Paul Mangan <paul@claws-mail.org>
670 --------------------------------------------------------------------------------
678 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
679 into an X-Face graphic suitable for inclusion into custom headers of
680 Claws Mail. An X-Face allows to quickly identify (or be identified
681 as) the sender of a mail message in a xface-capable MUA (like Claws
685 After obtaining the desired image for your X-Face you should:
686 * scale it to 48x48 pixels (Image->Scale image on Gimp)
687 * down color depth to b/w (Image->Mode->Indexed selecting "Use
688 Black/White palette" and the desired dithering options (prior to
689 indexing doing Image->Colors->Threshold allows you to select the
690 b/w level if you don't want a dithered (dotty) image))
691 * save file as non-interlaced GIF
694 ./gif2xface < filename.gif > filename.xface
696 In filename.xface will be the X-Face header ready to use.
697 You can add a custom header in Claws Mail through Configuration->
698 Preferences per account, "Send" tab, check "Add user-defined header"
699 then "Edit..." if you want to add it via the Claws Mail interface, or do
701 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
703 if you want to create the custom headers file yourself (Warning: this
704 method is valid only if you don't have any other custom header set or
707 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
713 This script is a message catalog translator's tool, it updates the .po
714 files named on the command line.
717 This script needs to be copied to and run from the 'po' directory.
719 ./update-po lang.po lang2.po ...
721 to update one or more <yourlang>.po files from the sourcecode files
722 named in POTFILES.in. The old .po file is save in a .po.old file.
724 For example, when you want to update fr.po, run ./update-po fr.po,
725 then edit fr.po to update your translation.
727 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
729 --------------------------------------------------------------------------------