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 filter_conv_new.pl Convert new-style Sylpheed filters to filtering
33 filter_conv.pl Convert old-style Sylpheed filters to filtering
34 fix-date.sh Replace/Add a message's Date field
35 nautilus2claws-mail.sh Send files from Nautilus
36 OOo2claws-mail.pl Send documents from OpenOffice.org
37 sylprint.pl Printing engine, explained in README.sylprint
38 textviewer.pl Display various attachments as text
39 thunderbird-filters-convertor.pl
40 Convert Thunderbird filtering rules
43 gif2xface.pl Convert a 48x48 GIF file to an X-Face header
44 update-po Update the .po files named on the command line.
46 --------------------------------------------------------------------------------
47 Detailed Descriptions:
48 --------------------------------------------------------------------------------
55 COMMAND: |freshmeat_search.pl
56 Search freshmeat.net for selected text using the default Claws Mail browser
60 COMMAND: |google_msgid.pl
61 Lookup selected message-id in google using mozilla. Edit the script to use
66 COMMAND: |google_search.pl
67 Search google.com for selected text using the default Claws Mail browser
71 see further down for details
74 WORKS ON: current message part
75 COMMAND: textviewer.sh %p |
76 Attempt to view an attachment as plain text
79 WORKS ON: current message (or part of multipart message)
81 Decode and display uuencoded images using uudecode.
84 WORKS ON: current message (or part of multipart message)
85 COMMAND: uuooffice %f&
86 Decode uuencoded attachments and open them with OpenOffice
88 * More action examples can be found at the Claws Mail FAQ
89 http://www.claws-mail.org/faq/index.php/Actions
91 ** multiwebsearch.pl **
94 This is an Actions script that allows you to search
95 websites for the selected text. It uses the default
96 Claws Mail browser as configured through Claws Mail's
97 GUI and specified in ~/.claws-mail/clawsrc, and a
98 configuration file called multiwebsearch.conf.
101 The configuration file takes the following format:
103 ALIAS|URL PART|URL PART
105 ALIAS is a user-defined name; the first URL PART is the
106 url before the search term; the second URL PART is
107 optional and contains the remaining part of the url which
108 comes after the search term. A sample configuration file
112 Copy 'multiwebsearch.conf' to ~/.claws-mail/
115 a) pre-configured website
116 Command: multiwebsearch.pl --where="google" --what="%s"
118 Command: multiwebsearch.pl --where="%u" --what="%s"
120 In type a) "google" refers to one of the configured aliases,
121 this Action will always search the website referred to by
124 In type b) you will be presented with a dialog box into
125 which you type one of your configured aliases
128 Contact: Paul Mangan <paul@claws-mail.org>
129 --------------------------------------------------------------------------------
131 Address book conversion
132 -----------------------
137 This python-script is a quick hack to convert an Eudora (v.3?)
138 addressbook to vCard (GnomeCard) format.
141 You may do whatever you want with it! (Also regarding copying)
142 However, the script is intended to use like this:
144 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
146 Be careful not to overwrite your original GnomeCard.gcrd!
147 (But of course you might want to add the converted stuff to it)
149 Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
151 * kmail2claws-mail.pl
154 This perl script will convert an exported Kmail addressbook into a
155 Claws Mail addressbook. If your version of Kmail is 1.37 or
156 greater and/or your version of KAddressBook is 3.1beta1 or greater,
157 or this script mixes up your definitions and their related data, use
158 'kmail2claws-mail_v2.pl' instead.
161 (You must run claws-mail at least once before running this script.)
163 In Kmail's Address book choose '/File/Export List'. This will export
164 your Kmail address book data to a *.csv file.
166 If Claws Mail is running, close it.
168 From the command line, execute the following:
170 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
172 Your Kmail address book data will now be contained in Claws Mail'
173 address book, under the name 'Kmail Address Book'.
175 Contact: Paul Mangan <paul@claws-mail.org>
178 * kmail2claws-mail_v2.pl
180 This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
183 This perl script will convert a Kmail address book that has been
184 exported in csv format into a Claws Mail address book.
187 (You must run claws-mail at least once before running this script.)
189 Open Kmail's Addressbook, /File/Address Book
190 In Kmail's Addressbook choose '/File/Export/Export List...'. This
191 will allow you to export your Kmail addressbook data to a *.csv file.
193 If Claws Mail is running, close it.
195 From the command line, execute the following:
197 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
199 You can also use --help to see usage instructions.
201 Your Kmail addressbook data will now be contained in Claws Mail'
202 addressbook, under the name 'Kmail address book'.
204 Contact: Paul Mangan <paul@claws-mail.org>
207 * outlook2claws-mail.pl
210 This perl script converts an Outlook generated contact list into a
211 Claws Mail XML address book.
216 You must export Outlook Express contact list as TXT file, choosing
217 only "Name" and "Address" fields to export.
219 You must exit Claws Mail before converting the contact list.
221 From the command line, execute the following:
223 outlook2claws-mail.pl fullpathname
227 You must export Outlook contact list as CSV file, choosing ALL the
228 fields available for exporting.
230 You must exit Claws Mail before converting the contact list.
232 From the command line, execute the following:
234 outlook2claws-mail.pl --csv fullpathname
237 For text files only works with fields described above. If you have
238 more complex examples send them to me, and I'll try to enhance the
241 For csv files you must export all fields (but only non empty fields
242 are added to the created Claws Mail address book) and the number
243 of fields expected is harcoded. Look for the $nboffields variable in
244 the script and change its value if you are sure you exported all
245 fields and script gives the 'unknown csv file format' error.
247 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
253 This perl script will convert an address book exported from The Bat!
254 into a Claws Mail address book.
257 (You must run claws-mail at least once before running this script.)
259 If Claws Mail is running, close it.
261 Export The Bat! Address Book to CSV file format with all fields
262 selected to YES and then start:
264 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
266 The Bat! addressbook data will now be contained in Claws Mail'
267 addressbook, under the name 'The Bat! Address Book'.
269 Contact: Urke MMI <urke@gmx.net>
275 This python script will convert an Evolution vCard into a Claws Mail
279 (You must run claws-mail at least once before running this script.)
281 If Claws Mail is running, close it.
282 From the command line, execute the following:
284 vcard2xml.py source_file [destination_file]
286 When only <source_file> is specified it will overwrite (and
287 create a backup of) the existing addressbook.
288 When both arguments are suplied it will create a new additional
289 addressbook named as <destination_file>.
290 If the script encounters an error it will attempt to roll back
291 the changes and restore the original files.
293 Contact: Bogdan Sumanariu <bsumanariu@one5.ro>
295 --------------------------------------------------------------------------------
303 This perl script imports mbox files that are exported by Calypso.
304 It recreates the folder structure by scanning the "X-CalypsoFolder"
305 header and reincludes the attachments referenced in the
306 "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
309 Export the Calypso mailbox by selecting "Save to archive" and check
310 the "Save attachments" box.
312 Edit the script to set following variables (at the top of the file):
313 $mboxdir : path to the exported mbox, e.g. 'Archive' or '.'
314 $mboxfile : name of exported mbox, e.g. 'mail.txt'
315 $outdir : name of the MH folder to create, e.g. 'Calypso'
319 perl calypso_convert.pl
321 Finally, import that folder by either selecting "New mailbox" or
322 moving it into your existing directory and recreate the folder
323 structure manually (contentmenu from folderview).
325 Contact: Thorsten Maerz <torte@netztorte.de>
330 This perl script converts an mbox directory's contents into
331 Claws Mail' MH format.
335 Run the script using:
337 perl convert_mbox.pl MBOX MH_DIR
339 Move the outputted MH_DIR and its contents into your Claws Mail
340 Mail folder; in Claws Mail right-click the top-level folder and
341 choose 'Rebuild folder tree' from the popup menu.
343 Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
345 * kmail-mailbox2claws-mail.pl
348 This perl script converts a kmail mailbox into Claws Mail' mailbox.
352 Exit Claws Mail if running.
354 Run the script using:
356 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
358 Start Claws Mail and right-click the toplevel mailbox, i.e
359 "Mailbox (MH)", and select 'Rebuild folder tree'.
360 You may also need to run '/File/Folder/Check for new messages
365 --dry-run test mode, nothing is actually written
366 --help brief usage info
368 Contact: Paul Mangan <paul@claws-mail.org>
373 This python script integrates a Thunderbird folder tree into
378 The script receives two parameters from command-line:
379 <Thunderbird folder path> <Claws Mail folder path>
381 The best way to use it is to go to inside your Thunderbird
382 root mailfolder directory and invoke it as:
384 <path>\python2.4 <path>\tbird2syl.py . <path to Claws Mail>\Mail
386 Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
388 --------------------------------------------------------------------------------
393 * acroread2claws-mail.pl
396 This perl script enables Adobe Reader 7 to send documents to
397 Claws Mail as attachments.
400 Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
401 Start up Adobe Reader 7 (acroread)
402 Go to /Edit/Preferences/SendMail
403 Select any email client except 'System Mail (mail)'
404 Enter the path to this script in the alternate location box
406 You can then use 'File/Email' or the Email toolbar button to launch
407 claws-mail (if not already launched) and open a new compose window
408 with the PDF attached.
410 Contact: Paul Mangan <paul@claws-mail.org>
416 This perl script provides easy conversion of your filtering rules from
417 sylpheed's new filter system (>= 0.9.99) to the filtering system used in
419 It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
420 writes '~/[CLAWS CONFIG DIR]/matcherrc'
423 Issue the following command from the 'tools' directory:
425 perl filter_conv_new.pl
427 That's it, the claws' filtering system is now implemented with your
428 previous rules applied.
433 Contact: Paul Mangan <paul@claws-mail.org>
439 This perl script provides easy conversion of your filtering rules
440 from sylpheed's old filter system (< 0.9.99) to the filtering system
442 It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
445 Issue the following command from the 'tools' directory:
449 That's it, the new filtering system is now implemented with your
450 previous rules applied.
452 Contact: Paul Mangan <paul@claws-mail.org>
458 It will replace the Date: value w/ the one picked up from
459 more recent Received: field if this field resides in one
460 line. Otherwise, it will take the file modification time
461 (using a RFC 2822-compliant form). If no X-Original-Date already
462 exist, the former Date value will be set in such field.
465 fix_date.sh <filename> [<filename>..]
467 Contact: wwp <wwp@claws-mail.org>
470 * nautilus2claws-mail.sh
473 This script will recursively attach a number of selected
474 files/directories from Nautilus to a new blank e-mail.
477 Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
478 and restart nautilus (killall -9 nautilus). You will now have
479 a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
481 Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
487 This perl script enables OpenOffice.org to send documents to
488 Claws Mail as attachments.
491 OpenOffice.org Version 2.0
492 ----------------------------
493 This script is not needed for OOo version 2, which can work
494 directly with Claws Mail.
495 Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
498 OpenOffice.org Version 1.1.0
499 ----------------------------
500 Start up OpenOffice.org.
501 Go to 'Tools/Options/OpenOffice.org/External Programs'
502 Select either ''Mozilla 1.x (Option 1)', or
503 'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
504 Enter the path to OOo2claws-mail.pl in the 'Path' box
505 or select it by clicking on the '...' button.
507 You can then use 'File/Send/Document as email' to launch
508 claws-mail (if not already launched) and open a new compose
509 window with the document attached.
511 OpenOffice.org Version 1.0
512 --------------------------
513 Start up OpenOffice.org.
514 Go to 'Tools/Options/OpenOffice.org/External Programs'
515 Enter the path to OOo2claws-mail.pl in the 'Program' box
516 or select it by clicking on the '...' button.
519 Contact: Paul Mangan <paul@claws-mail.org>
525 This script tries to recognise an attachment by using the 'file'
526 command and/or the file extension and then uses the available Linux
527 utilities to make an effort to display it as text. For example
532 .html txt2htm or text2html
533 .xls, .sxc, .csv xlscat -L
537 .pl, .pm perltidy -st -se or cat
538 .bz2 bzip2 -d < %f | strings
541 Go to /Configuration/Message View/External Programs and enter the
542 path to the script in the "Command for 'Display as text'" box.
543 Now when you right-click an attachment and choose 'Display as text'
544 this script will be invoked.
547 Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
550 * thunderbird-filters-convertor.pl
553 This perl script converts Thunderbird filtering rules into Claws Mail
554 filtering rules. It can be run several times, once for each filter
555 configuration file in Thunderbird.
558 The script takes 3 arguments:
560 --tbird-file=PATH TO FILE The full path to the file to be converted
561 --mailbox-name=NAME The name of the Claws Mail mailbox
562 --account-name=NAME The name of the account to be used (optional)
564 --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
565 that you want to convert, it must contain the full path to the file.
566 --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
567 if the top-level folder is 'Mailbox (MH)' then this option should be
569 --account-name is optional, only needed if you are creating account-specific
570 rules. This is the name of your account in Claws Mail, which should
571 correspond to an account that you had in Thunderbird, e.g. the acount whose
572 rules you are converting.
574 This script presumes that your folder hierarchy in Claws Mail matches the
575 one that you had in Thunderbird. If you used the tbird2claws.py script to
576 convert your Thunderbird mailbox, then the folder hierarchy should match.
578 If the Claws Mail filtering configuration file (matcherrc) does not exist,
579 the script will create it; if it does exist, the newly converted rules will
586 Contact: Paul Mangan <paul@claws-mail.org>
588 --------------------------------------------------------------------------------
596 This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
597 into an X-Face graphic suitable for inclusion into custom headers of
598 Claws Mail. An X-Face allows to quickly identify (or be identified
599 as) the sender of a mail message in a xface-capable MUA (like sylpheed
603 After obtaining the desired image for your X-Face you should:
604 * scale it to 48x48 pixels (Image->Scale image on Gimp)
605 * down color depth to b/w (Image->Mode->Indexed selecting "Use
606 Black/White palette" and the desired dithering options (prior to
607 indexing doing Image->Colors->Threshold allows you to select the
608 b/w level if you don't want a dithered (dotty) image))
609 * save file as non-interlaced GIF
612 ./gif2xface < filename.gif > filename.xface
614 In filename.xface will be the X-Face header ready to use.
615 You can add a custom header in Claws Mail through Configuration->
616 Preferences per account, "Send" tab, check "Add user-defined header"
617 then "Edit..." if you want to add it via the Claws Mail interface, or do
619 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
621 if you want to create the custom headers file yourself (Warning: this
622 method is valid only if you don't have any other custom header set or
625 Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>
631 This script is a message catalog translator's tool, it updates the .po
632 files named on the command line.
635 This script needs to be copied to and run from the 'po' directory.
637 ./update-po lang.po lang2.po ...
639 to update one or more <yourlang>.po files from the sourcecode files
640 named in POTFILES.in. The old .po file is save in a .po.old file.
642 For example, when you want to update fr.po, run ./update-po fr.po,
643 then edit fr.po to update your translation.
645 Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
647 --------------------------------------------------------------------------------