d562f467e819df94a086616852c45a18d3e0f67a
[claws.git] / tools / README
1
2 --------------------------------------------------------------------------------
3 Contents of the tools directory:
4 --------------------------------------------------------------------------------
5
6 Action scripts:
7   cm-reparent.pl                Fix thread parenting for two or more messages
8   cm-break.pl                   Remove thread parenting for one or more messages
9   freshmeat_search.pl           Search freshmeat.net for selected text
10   google_msgid.pl               Search groups.google.com for selected message-id
11   google_search.pl              Search google.com for selected text
12   multiwebsearch.pl             Search any search engine for the selected text
13   textviewer.sh                 Attempt to view an attachment as plain text
14   uudec                         Decode and display uuencoded images
15   uuooffice                     Decode uuencoded attachments and open them with
16                                 OpenOffice
17
18 Addressbook conversion:
19   csv2addressbook.pl            Import Becky, Thunderbird, Kmail, Gmail and Fox
20                                 Mail address books
21   eud2gc.py                     Convert Eudora address book to Gnomecard
22   kmail2claws-mail.pl           Import a Kmail address book (KDE2)
23   kmail2claws-mail_v2.pl        Import a Kmail address book (KDE3)
24   mew2claws-mail.pl             Import a Mew address book
25   outlook2claws-mail.pl         Import an Outlook generated contact list
26   tb2claws-mail                 Import The Bat! address books
27   vcard2xml.py                  Import an Evolution vCard
28
29 Mailbox conversion:
30   calypso_convert.pl            Import mbox files with attachments from Calypso
31   convert_mbox.pl               Import mbox files
32   kmail-mailbox2claws-mail.pl   Convert a kmail mailbox to a Claws Mail mailbox
33   tbird2claws.py                Integrate a Thunderbird folder tree into Claws
34
35 Other tools:
36   acroread2claws-mail.pl        Send PDFs from Adobe Reader 7
37   claws-mail-compose-insert-files.pl
38                                 Insert files into a new Compose window
39   filter_conv_new.pl            Convert new-style Sylpheed filters to filtering
40   filter_conv.pl                Convert old-style Sylpheed filters to filtering
41   fix-date.sh                   Replace/Add a message's Date field
42   mairix.sh                     A wrapper to mairix, to enable global searches in
43                                 mail folders
44   nautilus2claws-mail.sh        Send files from Nautilus
45   OOo2claws-mail.pl             Send documents from OpenOffice.org
46   popfile-link.sh               Open messages in POPFile control center to edit
47                                 their status
48   sylprint.pl                   Printing engine, explained in README.sylprint
49   textviewer.pl                 Display various attachments as text
50   thunderbird-filters-convertor.pl
51                                 Convert Thunderbird filtering rules
52
53 Extra tools:
54   gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
55   update-po                     Update the .po files named on the command line.
56
57 --------------------------------------------------------------------------------
58 Detailed Descriptions:
59 --------------------------------------------------------------------------------
60
61 Action scripts
62 --------------
63
64 * cm-reparent.pl
65   WORKS ON: selected messages (two or more)
66   COMMAND: cm-reparent.pl %F
67   Thread the selected messages based on date, old to new
68
69 * cm-break.pl
70   WORKS ON: selected messages (one or more)
71   COMMAND: cm-break.pl %F
72   Break thread references for the selected messages
73
74 * google_msgid.pl
75   WORKS ON: selection
76   COMMAND: |google_msgid.pl
77   Lookup selected message-id in google using mozilla. Edit the script to use
78   different browsers.
79
80 * google_search.pl
81   WORKS ON: selection
82   COMMAND: |google_search.pl
83   Search google.com for selected text using the default Claws Mail browser
84
85 * multiwebsearch.pl
86   WORKS ON: selection
87   see further down for details
88
89 * textviewer.sh
90   WORKS ON: current message part
91   COMMAND: textviewer.sh %p |
92   Attempt to view an attachment as plain text
93
94 * uudec
95   WORKS ON: current message (or part of multipart message)
96   COMMAND: uudec %f&
97   Decode and display uuencoded images using uudecode.
98
99 * uuooffice
100   WORKS ON: current message (or part of multipart message)
101   COMMAND: uuooffice %f&
102   Decode uuencoded attachments and open them with OpenOffice
103
104 * More action examples can be found at the Claws Mail FAQ
105   http://www.claws-mail.org/faq/index.php/Actions
106
107 ** multiwebsearch.pl **
108
109   WHAT IT DOES
110         This is an Actions script that allows you to search
111         websites for the selected text. It uses the default
112         Claws Mail browser as configured through Claws Mail's 
113         GUI and specified in ~/.claws-mail/clawsrc, and a
114         configuration file called multiwebsearch.conf.
115         
116   CONFIGURATION
117         The configuration file takes the following format:
118         
119         ALIAS|URL PART|URL PART
120         
121         ALIAS is a user-defined name; the first URL PART is the
122         url before the search term; the second URL PART is
123         optional and contains the remaining part of the url which
124         comes after the search term. A sample configuration file
125         is included.
126         
127   HOW TO USE IT
128         Copy 'multiwebsearch.conf' to ~/.claws-mail/
129         
130         Configure an Action:
131         a) pre-configured website 
132            Command: multiwebsearch.pl --where="google" --what="%s"
133         b) dynamic
134            Command: multiwebsearch.pl --where="%u" --what="%s"
135            
136         In type a) "google" refers to one of the configured aliases,
137         this Action will always search the website referred to by
138         the alias "google".
139         
140         In type b) you will be presented with a dialog box into
141         which you type one of your configured aliases
142
143   
144   Contact: Paul Mangan <paul@claws-mail.org>
145 --------------------------------------------------------------------------------
146
147 Address book conversion
148 -----------------------
149
150 * csv2addressbook.pl
151
152   WHAT IT DOES
153         This perl script will import a Becky, Thunderbird, Kmail, Gmail and
154         Fox Mail address book.
155
156   HOW TO USE IT
157         (You must run claws-mail at least once before running this script.)
158
159         Becky >= 2.41
160         -------------
161         In Becky you need to do a CSV full export with titles of your
162         address book.
163
164         Run the script with the following options:
165
166         perl csv2addressbook.pl --type=becky --csv=/full/path/to/file.csv
167
168         Addtionally you can use the option '--name="My address book"', if
169         you don't use this option the new Claws address book will be
170         called 'Becky address book'.
171
172
173         Thunderbird >= 2.0.0.6
174         ----------------------
175         In Thunderbird you need to export your address book as 'comma
176         separated'.
177
178         Run the script with the following options:
179
180         perl csv2addressbook.pl --type=thunderbird --csv=/full/path/to/file.csv
181
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 'Thunderbird address book'.
185
186         Kmail >= 1.9.7 / Kaddressbook >= 3.5.7
187         --------------------------------------
188         In Kaddressbook you need to export your address book as 'CSV List'.
189
190         Run the script with the following options:
191
192         perl csv2addressbook.pl --type=kmail --csv=/full/path/to/file.csv
193
194         Addtionally you can use the option '--name="My address book"', if
195         you don't use this option the new Claws address book will be
196         called 'Kmail address book'.
197
198         WARNING: Kmail/Kaddressbook has a bug whereby it exports badly
199         formatted CSV if the values are quoted.
200
201         Gmail
202         -----
203         In the Gmail web interface you need to export your address book
204         as Outlook CSV format.
205
206         Run the script with the following options:
207
208         perl csv2addressbook.pl --type=gmail --csv=/full/path/to/file.csv
209
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 'gmail address book'.
213
214         Fox Mail
215         --------
216         Export your Fox Mail address book as CSV with all possible headers.
217
218         Run the script with the following options:
219
220         perl csv2addressbook.pl --type=foxmail --csv=/full/path/to/file.csv
221
222         Addtionally you can use the option '--name="My address book"', if
223         you don't use this option the new Claws address book will be
224         called 'foxmail address book'.
225
226         You can also run the script with '--help' to get a brief usage message.
227
228   Contact: Paul Mangan <paul@claws-mail.org>
229
230 * eud2gc.py
231
232   WHAT IT DOES
233         This python-script is a quick hack to convert an Eudora (v.3?)
234         addressbook to vCard (GnomeCard) format.
235
236   HOW TO USE IT
237         You may do whatever you want with it! (Also regarding copying)
238         However, the script is intended to use like this:
239
240                 eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>
241
242         Be careful not to overwrite your original GnomeCard.gcrd!
243         (But of course you might want to add the converted stuff to it)
244
245   Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>
246
247 * kmail2claws-mail.pl
248
249   WHAT IT DOES
250         This perl script will convert an exported Kmail addressbook into a
251         Claws Mail addressbook. If your version of Kmail is 1.37 or
252         greater and/or your version of KAddressBook is 3.1beta1 or greater,
253         or this script mixes up your definitions and their related data, use
254         'kmail2claws-mail_v2.pl' instead.
255
256   HOW TO USE IT
257         (You must run claws-mail at least once before running this script.)
258
259         In Kmail's Address book choose '/File/Export List'. This will export
260         your Kmail address book data to a *.csv file.
261
262         If Claws Mail is running, close it.
263
264         From the command line, execute the following:
265  
266                 perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv
267
268         Your Kmail address book data will now be contained in Claws Mail'
269         address book, under the name 'Kmail Address Book'.
270
271   Contact: Paul Mangan <paul@claws-mail.org>
272     
273
274 * kmail2claws-mail_v2.pl
275
276   This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1
277
278   WHAT IT DOES
279         This perl script will convert a Kmail address book that has been
280         exported in csv format into a Claws Mail address book.
281
282   HOW TO USE IT
283         (You must run claws-mail at least once before running this script.)
284   
285         Open Kmail's Addressbook, /File/Address Book
286         In Kmail's Addressbook choose '/File/Export/Export List...'. This 
287         will allow you to export your Kmail addressbook data to a *.csv file.
288
289         If Claws Mail is running, close it.
290
291         From the command line, execute the following:
292  
293                 perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
294         
295         You can also use --help to see usage instructions.
296
297         Your Kmail addressbook data will now be contained in Claws Mail'
298         addressbook, under the name 'Kmail address book'.
299
300   Contact: Paul Mangan <paul@claws-mail.org>
301
302 * mew2claws-mail.pl
303
304   WHAT IT DOES
305         This perl script will convert a Mew address book into a Claws Mail
306         address book.
307
308   HOW TO USE IT
309         (You must run claws-mail at least once before running this script.)
310   
311         If Claws Mail is running, close it.
312
313         From the command line, execute the following:
314  
315                 perl mew2claws-mail.pl --mew-addressbook=/path/to/mew/addressbook
316         
317         You can also use --help to see usage instructions.
318
319         Your Mew addressbook data will now be contained in Claws Mail's
320         addressbook, under the name 'Mew Address Book'.
321
322   Contact: Jérôme Lelong <jerome.lelong@gmail.com>
323
324 * outlook2claws-mail.pl
325
326   WHAT IT DOES
327         This perl script converts an Outlook generated contact list into a 
328         Claws Mail XML address book.
329
330   HOW TO USE IT
331         For text files:
332         --------------
333         You must export Outlook Express contact list as TXT file, choosing
334         only "Name" and "Address" fields to export.
335
336         You must exit Claws Mail before converting the contact list.
337
338         From the command line, execute the following:
339
340                 outlook2claws-mail.pl fullpathname
341
342         For csv files:
343         -------------
344         You must export Outlook contact list as CSV file, choosing ALL the
345         fields available for exporting.
346
347         You must exit Claws Mail before converting the contact list.
348
349         From the command line, execute the following:
350
351                 outlook2claws-mail.pl --csv fullpathname
352
353   LIMITATIONS
354         For text files only works with fields described above. If you have 
355         more complex examples send them to me, and I'll try to enhance the 
356         script.
357
358         For csv files you must export all fields (but only non empty fields
359         are added to the created Claws Mail address book) and the number
360         of fields expected is harcoded. Look for the $nboffields variable in
361         the script and change its value if you are sure you exported all
362         fields and script gives the 'unknown csv file format' error.
363
364   Contact: Ricardo Mones <ricardo@mones.org>
365
366
367 * tb2claws-mail
368
369   WHAT IT DOES
370         This perl script will convert an address book exported from The Bat! 
371         into a Claws Mail address book.
372
373   HOW TO USE IT
374         (You must run claws-mail at least once before running this script.)
375
376         If Claws Mail is running, close it.
377
378         Export The Bat! Address Book to CSV file format with all fields 
379         selected to YES and then start:
380
381                 tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
382  
383         The Bat! addressbook data will now be contained in Claws Mail'
384         addressbook, under the name 'The Bat! Address Book'.
385
386   Contact: Urke MMI <urke@gmx.net>  
387
388
389 * vcard2xml.py
390
391   WHAT IT DOES
392         This python script will convert an Evolution vCard into a Claws Mail
393         address book.
394
395   HOW TO USE IT
396         (You must run claws-mail at least once before running this script.)
397
398         If Claws Mail is running, close it.
399         From the command line, execute the following:
400
401                 vcard2xml.py source_file [destination_file]
402  
403         When only <source_file> is specified it will overwrite (and
404         create a backup of) the existing addressbook. 
405         When both arguments are suplied it will create a new additional 
406         addressbook named as <destination_file>.
407         If the script encounters an error it will attempt to roll back
408         the changes and restore the original files.
409
410   Contact: Bogdan Sumanariu <bsumanariu@one5.ro> 
411
412 --------------------------------------------------------------------------------
413
414 Mailbox conversion
415 ------------------
416
417 * calypso_convert.pl
418
419   WHAT IT DOES
420         This perl script imports mbox files that are exported by Calypso.
421         It recreates the folder structure by scanning the "X-CalypsoFolder"
422         header and reincludes the attachments referenced in the
423         "X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
424   
425   HOW TO USE IT
426         Export the Calypso mailbox by selecting "Save to archive" and check
427         the "Save attachments" box.
428         
429         Edit the script to set following variables (at the top of the file):
430            $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
431            $mboxfile : name of exported mbox, e.g. 'mail.txt'
432            $outdir   : name of the MH folder to create, e.g. 'Calypso'
433            
434          Run the script using
435          
436                 perl calypso_convert.pl
437                 
438         Finally, import that folder by either selecting "New mailbox" or
439         moving it into your existing directory and recreate the folder
440         structure manually (contentmenu from folderview).
441
442   Contact: Thorsten Maerz <torte@netztorte.de>
443
444 * convert_mbox.pl
445
446   WHAT IT DOES
447         This perl script converts an mbox directory's contents into 
448         Claws Mail' MH format.
449   
450   HOW TO USE IT
451   
452         Run the script using:
453          
454                 perl convert_mbox.pl MBOX MH_DIR
455                 
456         Move the outputted MH_DIR and its contents into your Claws Mail
457         Mail folder; in Claws Mail right-click the top-level folder and
458         choose 'Rebuild folder tree' from the popup menu.
459
460   Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>
461
462 * kmail-mailbox2claws-mail.pl
463
464   WHAT IT DOES
465         This perl script converts a kmail mailbox  into Claws Mail' mailbox.
466   
467   HOW TO USE IT
468   
469         Exit Claws Mail if running.
470         
471         Run the script using:
472          
473                 kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
474                 
475         Start Claws Mail and right-click the toplevel mailbox, i.e
476         "Mailbox (MH)", and select 'Rebuild folder tree'.
477         You may also need to run '/File/Folder/Check for new messages
478         in all folders'
479         
480         Additional options:
481                 --debug         debug mode
482                 --dry-run       test mode, nothing is actually written
483                 --help          brief usage info
484         
485   Contact: Paul Mangan <paul@claws-mail.org>
486
487 * tbird2claws.py
488
489   WHAT IT DOES
490         This python script integrates a Thunderbird folder tree into 
491         Claws Mail.
492   
493   HOW TO USE IT
494   
495         The script receives two parameters from command-line:
496         <Thunderbird folder path> <Claws Mail folder path>
497
498         The best way to use it is to go to inside your Thunderbird
499         root mailfolder directory and invoke it as:
500
501                 <path>\python2.4 <path>\tbird2claws.py . <path to Claws Mail>\Mail
502
503   Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>
504
505 --------------------------------------------------------------------------------
506
507 Other tools
508 -----------
509
510 * acroread2claws-mail.pl
511
512   WHAT IT DOES
513         This perl script enables Adobe Reader 7 to send documents to
514         Claws Mail as attachments.
515
516   HOW TO USE IT
517         Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
518         Start up Adobe Reader 7 (acroread)
519         Go to /Edit/Preferences/SendMail
520         Select any email client except 'System Mail (mail)'
521         Enter the path to this script in the alternate location box  
522
523         You can then use 'File/Email' or the Email toolbar button to launch
524         claws-mail (if not already launched) and open a new compose window
525         with the PDF attached.
526   
527   Contact: Paul Mangan <paul@claws-mail.org>
528
529 * claws-mail-compose-insert-files.pl
530
531   WHAT IT DOES
532         This script enables inserting files into the message body of a new 
533         Claws Mail Compose window from the command line. Additionally To,
534         Cc, Bcc, Subject and files to attach to the message can be specified. 
535
536   HOW TO USE IT
537         claws-mail-compose-insert-files.pl [options]
538         Options:
539                 --help -h
540                 --to "Person One <mail@address.net>"
541                 --cc "Person One <mail@address.net>"
542                 --bcc "Person One <mail@address.net>"
543                 --subject "My subject"
544                 --attach FILE
545                 --insert FILE
546
547         For multiple recipients separate the addresses with ','
548         e.g. --to "Person One <mail@address.net>,Person Two <mail2@address.net>"
549         --attach and --insert can be used multiple times
550   
551   Contact: Paul Mangan <paul@claws-mail.org>
552
553 * filter_conv_new.pl
554
555   WHAT IT DOES
556         This perl script provides easy conversion of your filtering rules from
557         sylpheed's new filter system (>= 0.9.99) to the filtering system used in
558         Claws Mail.
559         It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
560         writes '~/[CLAWS CONFIG DIR]/matcherrc'
561   
562   HOW TO USE IT
563         Issue the following command from the 'tools' directory:
564
565         perl filter_conv_new.pl
566
567         That's it, the claws' filtering system is now implemented with your
568         previous rules applied.
569
570   REQUIREMENTS
571         XML::SimpleObject
572
573   Contact: Paul Mangan <paul@claws-mail.org>
574   
575
576 * filter_conv.pl
577
578   WHAT IT DOES
579         This perl script provides easy conversion of your filtering rules
580         from sylpheed's old filter system (< 0.9.99) to the filtering system
581         used in Claws Mail.
582         It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
583   
584   HOW TO USE IT
585         Issue the following command from the 'tools' directory:
586
587         perl filter_conv.pl
588
589         That's it, the new filtering system is now implemented with your
590         previous rules applied.
591
592   Contact: Paul Mangan <paul@claws-mail.org>
593   
594
595 * fix-date.sh
596
597  WHAT IT DOES
598         Add a 'Date:' header to the selected email(s) when such header is 
599         missing. The correct date is guessed from other headers that contain 
600         timestamp information (preferred: Fetchinfo header if found) or from 
601         the file or system date as a fallback. The order or preference for the
602         date valuereplacement can be changed by editing the script.
603         This script can be used to fix messages that show non RFC-compliant
604         Date headers as well.
605         X-Original-Date is always added too if not already existing (if so,
606         it's left untouched), to keep track of the original value if any.
607         An existing Date: header is not overwritten unless you use the --force
608         switch.
609         Non RFC-compliant dates can be overwritten using the --rfc switch. Use
610         --strict to use strict RFC matching patterns for date values in other
611         headers.
612         
613   HOW TO USE IT
614         fix_date.sh %F
615
616   Contact: wwp <wwp@claws-mail.org>
617
618
619 * mairix.sh
620
621  WHAT IT DOES
622         It's a wrapper to mairix, a tool that makes indexed searches
623         and shows search results in a virtual folder. Maildir, MH and
624         mbox formats are supported, see:
625         http://www.rpcurnow.force9.co.uk/mairix/
626
627   HOW TO USE IT
628         mairix.sh
629         mairix.sh <mairix rcfile> [<mairix options>..]
630     
631     For instance:    
632     mairix.sh ~/.mairixrc s:word1,word2
633
634   Contact: wwp <wwp@claws-mail.org>
635
636
637 * nautilus2claws-mail.sh
638
639   WHAT IT DOES
640         This script will recursively attach a number of selected 
641         files/directories from Nautilus to a new blank e-mail.
642
643   HOW TO USE IT
644         Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x, 
645         and restart nautilus (killall -9 nautilus). You will now have 
646         a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
647         
648   Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
649
650
651 * OOo2claws-mail.pl
652
653   WHAT IT DOES
654         This perl script enables OpenOffice.org to send documents to
655         Claws Mail as attachments.
656
657   HOW TO USE IT
658     OpenOffice.org Version 2.0
659     ----------------------------
660         This script is not needed for OOo version 2, which can work
661         directly with Claws Mail.
662         Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
663         in the box.
664
665     OpenOffice.org Version 1.1.0
666     ----------------------------
667         Start up OpenOffice.org.
668         Go to 'Tools/Options/OpenOffice.org/External Programs'
669         Select either ''Mozilla 1.x (Option 1)', or 
670         'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
671         Enter the path to OOo2claws-mail.pl in the 'Path' box
672         or select it by clicking on the '...' button.
673     
674         You can then use 'File/Send/Document as email' to launch
675         claws-mail (if not already launched) and open a new compose
676         window with the document attached.
677
678     OpenOffice.org Version 1.0
679     --------------------------
680         Start up OpenOffice.org.
681         Go to 'Tools/Options/OpenOffice.org/External Programs'
682         Enter the path to OOo2claws-mail.pl in the 'Program' box
683         or select it by clicking on the '...' button.
684
685
686   Contact: Paul Mangan <paul@claws-mail.org>
687
688
689 * popfile-link.sh
690
691  WHAT IT DOES
692         Open selected messages in POPFile control center to edit their
693         status. Requires that POPFile is running and that the messages
694         have been processed by it (X-POPFile-Link: header is expected).
695         POPFile control center opens with the web browser set in
696         Claws Mail prefs.
697
698   HOW TO USE IT
699         popfile-link.sh <filename> [<filename>..]
700     
701
702   Contact: wwp <wwp@claws-mail.org>
703
704
705 * textviewer.pl
706
707   WHAT IT DOES
708         This script tries to recognise an attachment by using the 'file'
709         command and/or the file extension and then uses the available
710         utilities to make an effort to display it as text. For example
711                 .doc                    antiword -w 72
712                 .txt, .diff, .c, .h,
713                   .ic. .ec, .cc, .sh,
714                   .sed, .awk            cat
715                 .html                   txt2htm or text2html
716                 .xls, .sxc, .csv        xlscat -L
717                 .rtf                    rtf2text
718                 .pdf                    pdf2text %f -
719                 .odt                    ooo2txt
720                 .pl, .pm                perltidy -st -se or  cat
721                 .bz2                    bzip2 -d < %f | strings
722
723   HOW TO USE IT
724         Go to /Configuration/Message View/External Programs and enter the
725         path to the script in the "Command for 'Display as text'" box.
726         Now when you right-click an attachment and choose 'Display as text'
727         this script will be invoked.
728
729         
730   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
731
732
733 * thunderbird-filters-convertor.pl
734
735   WHAT IT DOES
736         This perl script converts Thunderbird filtering rules into Claws Mail
737         filtering rules. It can be run several times, once for each filter
738         configuration file in Thunderbird.
739
740   HOW TO USE IT
741         The script takes 3 arguments:
742
743         --tbird-file=PATH TO FILE       The full path to the file to be converted
744         --mailbox-name=NAME             The name of the Claws Mail mailbox
745         --account-name=NAME             The name of the account to be used (optional)   
746
747         --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
748         that you want to convert, it must contain the full path to the file.
749         --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
750         if the top-level folder is 'Mailbox (MH)' then this option should be
751         'Mailbox'.
752         --account-name is optional, only needed if you are creating account-specific
753         rules. This is the name of your account in Claws Mail, which should
754         correspond to an account that you had in Thunderbird, e.g. the acount whose
755         rules you are converting.
756
757         This script presumes that your folder hierarchy in Claws Mail matches the
758         one that you had in Thunderbird. If you used the tbird2claws.py script to
759         convert your Thunderbird mailbox, then the folder hierarchy should match.
760
761         If the Claws Mail filtering configuration file (matcherrc) does not exist,
762         the script will create it; if it does exist, the newly converted rules will
763         be appended to it.
764
765   REQUIREMENTS
766         Getopt::Long
767         URI::Escape
768
769   Contact: Paul Mangan <paul@claws-mail.org>
770
771 --------------------------------------------------------------------------------
772
773 Extra tools
774 -----------
775
776 * gif2xface.pl
777
778   WHAT IT DOES
779         This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
780         into an X-Face graphic suitable for inclusion into custom headers of
781         Claws Mail. An X-Face allows to quickly identify (or be identified
782         as) the sender of a mail message in a xface-capable MUA (like Claws
783         Mail).
784
785   HOW TO USE IT
786         After obtaining the desired image for your X-Face you should:
787           * scale it to 48x48 pixels (Image->Scale image on Gimp)
788           * down color depth to b/w (Image->Mode->Indexed selecting "Use
789             Black/White palette" and the desired dithering options (prior to
790             indexing doing Image->Colors->Threshold allows you to select the
791             b/w level if you don't want a dithered (dotty) image))
792           * save file as non-interlaced GIF
793         Then do:
794
795                 ./gif2xface < filename.gif > filename.xface
796
797         In filename.xface will be the X-Face header ready to use.
798         You can add a custom header in Claws Mail through Configuration->
799         Preferences per account, "Send" tab, check "Add user-defined header"
800         then "Edit..." if you want to add it via the Claws Mail interface, or do
801
802                 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
803
804         if you want to create the custom headers file yourself (Warning: this
805         method is valid only if you don't have any other custom header set or
806         they will be lost!).
807
808   Contact: Ricardo Mones <ricardo@mones.org>
809
810
811 * update-po
812
813   WHAT IT DOES
814         This script is a message catalog translator's tool, it updates the .po 
815         files named on the command line.
816
817   HOW TO USE IT
818         This script needs to be copied to and run from the 'po' directory.
819   
820                 ./update-po lang.po lang2.po ...
821
822         to update one or more <yourlang>.po files from the sourcecode files
823          named in POTFILES.in. The old .po file is save in a .po.old file.
824
825         For example, when you want to update fr.po, run ./update-po fr.po, 
826         then edit fr.po to update your translation.
827
828   Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
829
830 --------------------------------------------------------------------------------
831 This file is Copyright 1999-2014 by the Claws Mail team.
832 See accompanying COPYING file for license details.
833 See each included script for copyright and license details.
834
835 * cm-reparent.pl
836
837   WHAT IT DOES
838         This script tries to fix thread parenting for two or more messages
839
840   HOW TO USE IT
841         Define an action as
842
843           Menu name:  Reparent (fix threading)
844           Command:    cm-reparent.pl %F
845
846         Then select from the message list all files that should be re-parented
847
848         Then invoke the action
849
850   MORE INFORMATION
851         $ perldoc cm-reparent.pl
852
853   REQUIREMENTS
854         Date::Parse
855         Getopt::Long
856
857   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
858
859 * cm-break.pl
860
861   WHAT IT DOES
862         This script tries to break thread parenting for one or more messages
863
864   HOW TO USE IT
865         Define an action as
866
867           Menu name:  Unthread (break threading)
868           Command:    cm-break.pl %F
869
870         Then select from the message list all files that should be un-threaded
871
872         Then invoke the action
873
874   MORE INFORMATION
875         $ perldoc cm-break.pl
876
877   REQUIREMENTS
878         Date::Parse
879         Getopt::Long
880
881   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>