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 outlook2claws-mail.pl Import an Outlook generated contact list
21 tb2claws-mail Import The Bat! address books
22 vcard2xml.py Import an Evolution vCard
25 calypso_convert.pl Import mbox files with attachments from Calypso
26 convert_mbox.pl Import mbox files
27 kmail-mailbox2claws-mail.pl Convert a kmail mailbox to a Claws Mail mailbox
28 tbird2claws.py Integrate a Thunderbird folder tree into Claws
31 acroread2claws-mail.pl Send PDFs from Adobe Reader 7
32 claws-mail-compose-insert-files.pl
33 Insert files into a new Compose window
34 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
35 filter_conv.pl Convert old-style Sylpheed filters to filtering
36 fix-date.sh Replace/Add a message's Date field
37 mairix.sh Indexed search in virtual folders (mairix
39 nautilus2claws-mail.sh Send files from Nautilus
40 OOo2claws-mail.pl Send documents from OpenOffice.org
41 sylprint.pl Printing engine, explained in README.sylprint
42 textviewer.pl Display various attachments as text
43 thunderbird-filters-convertor.pl
44 Convert Thunderbird filtering rules
47 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
48 update-po Update the .po files named on the command line.
50 --------------------------------------------------------------------------------
51 Detailed Descriptions:
52 --------------------------------------------------------------------------------
59 COMMAND: |freshmeat_search.pl
60 Search freshmeat.net for selected text using the default Claws Mail browser
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 python-script is a quick hack to convert an Eudora (v.3?)
142 addressbook to vCard (GnomeCard) format.
145 You may do whatever you want with it! (Also regarding copying)
146 However, the script is intended to use like this:
148 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
150 Be careful not to overwrite your original GnomeCard.gcrd!
151 (But of course you might want to add the converted stuff to it)
153 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
155 * kmail2claws-mail.pl
158 This perl script will convert an exported Kmail addressbook into a
159 Claws Mail addressbook. If your version of Kmail is 1.37 or
160 greater and/or your version of KAddressBook is 3.1beta1 or greater,
161 or this script mixes up your definitions and their related data, use
162 'kmail2claws-mail_v2.pl' instead.
165 (You must run claws-mail at least once before running this script.)
167 In Kmail's Address book choose '/File/Export List'. This will export
168 your Kmail address book data to a *.csv file.
170 If Claws Mail is running, close it.
172 From the command line, execute the following:
174 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
176 Your Kmail address book data will now be contained in Claws Mail'
177 address book, under the name 'Kmail Address Book'.
179 Contact: Paul Mangan <paul@claws-mail.org>
182 * kmail2claws-mail_v2.pl
184 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
187 This perl script will convert a Kmail address book that has been
188 exported in csv format into a Claws Mail address book.
191 (You must run claws-mail at least once before running this script.)
193 Open Kmail's Addressbook, /File/Address Book
194 In Kmail's Addressbook choose '/File/Export/Export List...'. This
195 will allow you to export your Kmail addressbook data to a *.csv file.
197 If Claws Mail is running, close it.
199 From the command line, execute the following:
201 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
203 You can also use --help to see usage instructions.
205 Your Kmail addressbook data will now be contained in Claws Mail'
206 addressbook, under the name 'Kmail address book'.
208 Contact: Paul Mangan <paul@claws-mail.org>
211 * outlook2claws-mail.pl
214 This perl script converts an Outlook generated contact list into a
215 Claws Mail XML address book.
220 You must export Outlook Express contact list as TXT file, choosing
221 only "Name" and "Address" fields to export.
223 You must exit Claws Mail before converting the contact list.
225 From the command line, execute the following:
227 outlook2claws-mail.pl fullpathname
231 You must export Outlook contact list as CSV file, choosing ALL the
232 fields available for exporting.
234 You must exit Claws Mail before converting the contact list.
236 From the command line, execute the following:
238 outlook2claws-mail.pl --csv fullpathname
241 For text files only works with fields described above. If you have
242 more complex examples send them to me, and I'll try to enhance the
245 For csv files you must export all fields (but only non empty fields
246 are added to the created Claws Mail address book) and the number
247 of fields expected is harcoded. Look for the $nboffields variable in
248 the script and change its value if you are sure you exported all
249 fields and script gives the 'unknown csv file format' error.
251 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
257 This perl script will convert an address book exported from The Bat!
258 into a Claws Mail address book.
261 (You must run claws-mail at least once before running this script.)
263 If Claws Mail is running, close it.
265 Export The Bat! Address Book to CSV file format with all fields
266 selected to YES and then start:
268 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
270 The Bat! addressbook data will now be contained in Claws Mail'
271 addressbook, under the name 'The Bat! Address Book'.
273 Contact: Urke MMI <urke@gmx.net>
279 This python script will convert an Evolution vCard into a Claws Mail
283 (You must run claws-mail at least once before running this script.)
285 If Claws Mail is running, close it.
286 From the command line, execute the following:
288 vcard2xml.py source_file [destination_file]
290 When only <source_file> is specified it will overwrite (and
291 create a backup of) the existing addressbook.
292 When both arguments are suplied it will create a new additional
293 addressbook named as <destination_file>.
294 If the script encounters an error it will attempt to roll back
295 the changes and restore the original files.
297 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
299 --------------------------------------------------------------------------------
307 This perl script imports mbox files that are exported by Calypso.
308 It recreates the folder structure by scanning the "X-CalypsoFolder"
309 header and reincludes the attachments referenced in the
310 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
313 Export the Calypso mailbox by selecting "Save to archive" and check
314 the "Save attachments" box.
316 Edit the script to set following variables (at the top of the file):
317 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
318 $mboxfile : name of exported mbox, e.g. 'mail.txt'
319 $outdir : name of the MH folder to create, e.g. 'Calypso'
323 perl calypso_convert.pl
325 Finally, import that folder by either selecting "New mailbox" or
326 moving it into your existing directory and recreate the folder
327 structure manually (contentmenu from folderview).
329 Contact: Thorsten Maerz <torte@netztorte.de>
334 This perl script converts an mbox directory's contents into
335 Claws Mail' MH format.
339 Run the script using:
341 perl convert_mbox.pl MBOX MH_DIR
343 Move the outputted MH_DIR and its contents into your Claws Mail
344 Mail folder; in Claws Mail right-click the top-level folder and
345 choose 'Rebuild folder tree' from the popup menu.
347 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
349 * kmail-mailbox2claws-mail.pl
352 This perl script converts a kmail mailbox into Claws Mail' mailbox.
356 Exit Claws Mail if running.
358 Run the script using:
360 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
362 Start Claws Mail and right-click the toplevel mailbox, i.e
363 "Mailbox (MH)", and select 'Rebuild folder tree'.
364 You may also need to run '/File/Folder/Check for new messages
369 --dry-run test mode, nothing is actually written
370 --help brief usage info
372 Contact: Paul Mangan <paul@claws-mail.org>
377 This python script integrates a Thunderbird folder tree into
382 The script receives two parameters from command-line:
383 <Thunderbird folder path> <Claws Mail folder path>
385 The best way to use it is to go to inside your Thunderbird
386 root mailfolder directory and invoke it as:
388 <path>\python2.4 <path>\tbird2syl.py . <path to Claws Mail>\Mail
390 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
392 --------------------------------------------------------------------------------
397 * acroread2claws-mail.pl
400 This perl script enables Adobe Reader 7 to send documents to
401 Claws Mail as attachments.
404 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
405 Start up Adobe Reader 7 (acroread)
406 Go to /Edit/Preferences/SendMail
407 Select any email client except 'System Mail (mail)'
408 Enter the path to this script in the alternate location box
410 You can then use 'File/Email' or the Email toolbar button to launch
411 claws-mail (if not already launched) and open a new compose window
412 with the PDF attached.
414 Contact: Paul Mangan <paul@claws-mail.org>
416 * claws-mail-compose-insert-files.pl
419 This script enables inserting files into the message body of a new
420 Claws Mail Compose window from the command line. Additionally To,
421 Cc, Subject and files to attach to the message can be specified.
424 claws-mail-compose-insert-files.pl [options]
427 --to mail@address.net[,mail2@address.net]
428 --cc mail@address.net[,mail2@address.net]
429 --subject "My subject"
433 --attach and --insert can be used multiple times
435 Contact: Paul Mangan <paul@claws-mail.org>
440 This perl script provides easy conversion of your filtering rules from
441 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
443 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
444 writes '~/[CLAWS CONFIG DIR]/matcherrc'
447 Issue the following command from the 'tools' directory:
449 perl filter_conv_new.pl
451 That's it, the claws' filtering system is now implemented with your
452 previous rules applied.
457 Contact: Paul Mangan <paul@claws-mail.org>
463 This perl script provides easy conversion of your filtering rules
464 from sylpheed's old filter system (< 0.9.99) to the filtering system
466 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
469 Issue the following command from the 'tools' directory:
473 That's it, the new filtering system is now implemented with your
474 previous rules applied.
476 Contact: Paul Mangan <paul@claws-mail.org>
482 It will replace the Date: value w/ the one picked up from
483 more recent Received: field if this field resides in one
484 line. Otherwise, it will take the file modification time
485 (using a RFC 2822-compliant form). If no X-Original-Date already
486 exist, the former Date value will be set in such field.
489 fix_date.sh <filename> [<filename>..]
491 Contact: wwp <wwp@claws-mail.org>
497 It's a wrapper to mairix, a tool that makes indexed searches
498 and shows search results in a virtual folder. Maildir, MH and
499 mbox formats are supported, see:
500 http://www.rpcurnow.force9.co.uk/mairix/
504 mairix.sh <rcfile> [<options>..]
506 Contact: wwp <wwp@claws-mail.org>
509 * nautilus2claws-mail.sh
512 This script will recursively attach a number of selected
513 files/directories from Nautilus to a new blank e-mail.
516 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
517 and restart nautilus (killall -9 nautilus). You will now have
518 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
520 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
526 This perl script enables OpenOffice.org to send documents to
527 Claws Mail as attachments.
530 OpenOffice.org Version 2.0
531 ----------------------------
532 This script is not needed for OOo version 2, which can work
533 directly with Claws Mail.
534 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
537 OpenOffice.org Version 1.1.0
538 ----------------------------
539 Start up OpenOffice.org.
540 Go to 'Tools/Options/OpenOffice.org/External Programs'
541 Select either ''Mozilla 1.x (Option 1)', or
542 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
543 Enter the path to OOo2claws-mail.pl in the 'Path' box
544 or select it by clicking on the '...' button.
546 You can then use 'File/Send/Document as email' to launch
547 claws-mail (if not already launched) and open a new compose
548 window with the document attached.
550 OpenOffice.org Version 1.0
551 --------------------------
552 Start up OpenOffice.org.
553 Go to 'Tools/Options/OpenOffice.org/External Programs'
554 Enter the path to OOo2claws-mail.pl in the 'Program' box
555 or select it by clicking on the '...' button.
558 Contact: Paul Mangan <paul@claws-mail.org>
564 This script tries to recognise an attachment by using the 'file'
565 command and/or the file extension and then uses the available Linux
566 utilities to make an effort to display it as text. For example
571 .html txt2htm or text2html
572 .xls, .sxc, .csv xlscat -L
576 .pl, .pm perltidy -st -se or cat
577 .bz2 bzip2 -d < %f | strings
580 Go to /Configuration/Message View/External Programs and enter the
581 path to the script in the "Command for 'Display as text'" box.
582 Now when you right-click an attachment and choose 'Display as text'
583 this script will be invoked.
586 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
589 * thunderbird-filters-convertor.pl
592 This perl script converts Thunderbird filtering rules into Claws Mail
593 filtering rules. It can be run several times, once for each filter
594 configuration file in Thunderbird.
597 The script takes 3 arguments:
599 --tbird-file=PATH TO FILE The full path to the file to be converted
600 --mailbox-name=NAME The name of the Claws Mail mailbox
601 --account-name=NAME The name of the account to be used (optional)
603 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
604 that you want to convert, it must contain the full path to the file.
605 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
606 if the top-level folder is 'Mailbox (MH)' then this option should be
608 --account-name is optional, only needed if you are creating account-specific
609 rules. This is the name of your account in Claws Mail, which should
610 correspond to an account that you had in Thunderbird, e.g. the acount whose
611 rules you are converting.
613 This script presumes that your folder hierarchy in Claws Mail matches the
614 one that you had in Thunderbird. If you used the tbird2claws.py script to
615 convert your Thunderbird mailbox, then the folder hierarchy should match.
617 If the Claws Mail filtering configuration file (matcherrc) does not exist,
618 the script will create it; if it does exist, the newly converted rules will
625 Contact: Paul Mangan <paul@claws-mail.org>
627 --------------------------------------------------------------------------------
635 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
636 into an X-Face graphic suitable for inclusion into custom headers of
637 Claws Mail. An X-Face allows to quickly identify (or be identified
638 as) the sender of a mail message in a xface-capable MUA (like sylpheed
642 After obtaining the desired image for your X-Face you should:
643 * scale it to 48x48 pixels (Image->Scale image on Gimp)
644 * down color depth to b/w (Image->Mode->Indexed selecting "Use
645 Black/White palette" and the desired dithering options (prior to
646 indexing doing Image->Colors->Threshold allows you to select the
647 b/w level if you don't want a dithered (dotty) image))
648 * save file as non-interlaced GIF
651 ./gif2xface < filename.gif > filename.xface
653 In filename.xface will be the X-Face header ready to use.
654 You can add a custom header in Claws Mail through Configuration->
655 Preferences per account, "Send" tab, check "Add user-defined header"
656 then "Edit..." if you want to add it via the Claws Mail interface, or do
658 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
660 if you want to create the custom headers file yourself (Warning: this
661 method is valid only if you don't have any other custom header set or
664 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
670 This script is a message catalog translator's tool, it updates the .po
671 files named on the command line.
674 This script needs to be copied to and run from the 'po' directory.
676 ./update-po lang.po lang2.po ...
678 to update one or more <yourlang>.po files from the sourcecode files
679 named in POTFILES.in. The old .po file is save in a .po.old file.
681 For example, when you want to update fr.po, run ./update-po fr.po,
682 then edit fr.po to update your translation.
684 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
686 --------------------------------------------------------------------------------