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   Add a 'Date:' header to the selected email(s) when such header is
 598   missing.  The correct date is guessed from other headers that
 599   contain timestamp information (preferred: Fetchinfo header if found)
 600   or from the file or system date as a fallback. The order or
 601   preference for the date value replacement can be changed by editing
 602   the script.
 603
 604   This script can be used to fix messages that show non RFC-compliant
 605   Date headers as well.
 606
 607   X-Original-Date is always added too if not already existing (if so,
 608   it's left untouched), to keep track of the original value if any.
 609
 610   An existing Date: header is not overwritten unless you use the
 611   --force switch.
 612
 613   Non RFC-compliant dates can be overwritten using the --rfc switch.
 614   Use --strict to use strict RFC matching patterns for date values in
 615   other headers.
 616
 617   WORKS ON: selected message(s)
 618
 619   COMMAND: fix_date.sh %F
 620
 621   CONTACT: wwp <wwp@claws-mail.org>
 622
 623 * mairix.sh
 624
 625  WHAT IT DOES
 626         It's a wrapper to mairix, a tool that makes indexed searches
 627         and shows search results in a virtual folder. Maildir, MH and
 628         mbox formats are supported, see:
 629         http://www.rpcurnow.force9.co.uk/mairix/
 630
 631   HOW TO USE IT
 632         mairix.sh
 633         mairix.sh <mairix rcfile> [<mairix options>..]
 634
 635     For instance:
 636     mairix.sh ~/.mairixrc s:word1,word2
 637
 638   Contact: wwp <wwp@claws-mail.org>
 639
 640
 641 * nautilus2claws-mail.sh
 642
 643   WHAT IT DOES
 644         This script will recursively attach a number of selected
 645         files/directories from Nautilus to a new blank e-mail.
 646
 647   HOW TO USE IT
 648         Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x,
 649         and restart nautilus (killall -9 nautilus). You will now have
 650         a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
 651
 652   Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>
 653
 654
 655 * OOo2claws-mail.pl
 656
 657   WHAT IT DOES
 658         This perl script enables OpenOffice.org to send documents to
 659         Claws Mail as attachments.
 660
 661   HOW TO USE IT
 662     OpenOffice.org Version 2.0
 663     ----------------------------
 664         This script is not needed for OOo version 2, which can work
 665         directly with Claws Mail.
 666         Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
 667         in the box.
 668
 669     OpenOffice.org Version 1.1.0
 670     ----------------------------
 671         Start up OpenOffice.org.
 672         Go to 'Tools/Options/OpenOffice.org/External Programs'
 673         Select either ''Mozilla 1.x (Option 1)', or
 674         'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
 675         Enter the path to OOo2claws-mail.pl in the 'Path' box
 676         or select it by clicking on the '...' button.
 677
 678         You can then use 'File/Send/Document as email' to launch
 679         claws-mail (if not already launched) and open a new compose
 680         window with the document attached.
 681
 682     OpenOffice.org Version 1.0
 683     --------------------------
 684         Start up OpenOffice.org.
 685         Go to 'Tools/Options/OpenOffice.org/External Programs'
 686         Enter the path to OOo2claws-mail.pl in the 'Program' box
 687         or select it by clicking on the '...' button.
 688
 689
 690   Contact: Paul Mangan <paul@claws-mail.org>
 691
 692
 693 * popfile-link.sh
 694
 695  WHAT IT DOES
 696         Open selected messages in POPFile control center to edit their
 697         status. Requires that POPFile is running and that the messages
 698         have been processed by it (X-POPFile-Link: header is expected).
 699         POPFile control center opens with the web browser set in
 700         Claws Mail prefs.
 701
 702   HOW TO USE IT
 703         popfile-link.sh <filename> [<filename>..]
 704
 705
 706   Contact: wwp <wwp@claws-mail.org>
 707
 708
 709 * textviewer.pl
 710
 711   WHAT IT DOES
 712         This script tries to recognise an attachment by using the 'file'
 713         command and/or the file extension and then uses the available
 714         utilities to make an effort to display it as text.
 715
 716         $ textview.pl --list
 717
 718         will show available conversion, the top:
 719
 720           .awk          cat
 721           .bin          strings
 722           .bz2          bzip2 -d < %f | strings
 723           .c            cat
 724           .cc           cat
 725           .csv          xlscat -L
 726
 727         If there are multiple alternatives available, they are listed in
 728         the ordder they are tried, like for .xls:
 729
 730           .xls          xlscat -L
 731           .xls          catdoc -x -dutf-8
 732           .xls          wvText
 733
 734   HOW TO USE IT
 735         Go to /Configuration/Message View/External Programs and enter the
 736         path to the script in the "Command for 'Display as text'" box.
 737         Now when you right-click an attachment and choose 'Display as text'
 738         this script will be invoked.
 739
 740         xlscat comes with the perl module Spreadsheet::Read, which is a
 741         wrapper module over several parsers and supports ods, sxc, csv, xls,
 742         xlsx, and sq.  See https://metacpan.org/release/Spreadsheet-Read
 743
 744   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
 745
 746
 747 * thunderbird-filters-convertor.pl
 748
 749   WHAT IT DOES
 750         This perl script converts Thunderbird filtering rules into Claws Mail
 751         filtering rules. It can be run several times, once for each filter
 752         configuration file in Thunderbird.
 753
 754   HOW TO USE IT
 755         The script takes 3 arguments:
 756
 757         --tbird-file=PATH TO FILE       The full path to the file to be converted
 758         --mailbox-name=NAME             The name of the Claws Mail mailbox
 759         --account-name=NAME             The name of the account to be used (optional)
 760
 761         --tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
 762         that you want to convert, it must contain the full path to the file.
 763         --mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
 764         if the top-level folder is 'Mailbox (MH)' then this option should be
 765         'Mailbox'.
 766         --account-name is optional, only needed if you are creating account-specific
 767         rules. This is the name of your account in Claws Mail, which should
 768         correspond to an account that you had in Thunderbird, e.g. the acount whose
 769         rules you are converting.
 770
 771         This script presumes that your folder hierarchy in Claws Mail matches the
 772         one that you had in Thunderbird. If you used the tbird2claws.py script to
 773         convert your Thunderbird mailbox, then the folder hierarchy should match.
 774
 775         If the Claws Mail filtering configuration file (matcherrc) does not exist,
 776         the script will create it; if it does exist, the newly converted rules will
 777         be appended to it.
 778
 779   REQUIREMENTS
 780         Getopt::Long
 781         URI::Escape
 782
 783   Contact: Paul Mangan <paul@claws-mail.org>
 784
 785 --------------------------------------------------------------------------------
 786
 787 Extra tools
 788 -----------
 789
 790 * gif2xface.pl
 791
 792   WHAT IT DOES
 793         This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
 794         into an X-Face graphic suitable for inclusion into custom headers of
 795         Claws Mail. An X-Face allows to quickly identify (or be identified
 796         as) the sender of a mail message in a xface-capable MUA (like Claws
 797         Mail).
 798
 799   HOW TO USE IT
 800         After obtaining the desired image for your X-Face you should:
 801           * scale it to 48x48 pixels (Image->Scale image on Gimp)
 802           * down color depth to b/w (Image->Mode->Indexed selecting "Use
 803             Black/White palette" and the desired dithering options (prior to
 804             indexing doing Image->Colors->Threshold allows you to select the
 805             b/w level if you don't want a dithered (dotty) image))
 806           * save file as non-interlaced GIF
 807         Then do:
 808
 809                 ./gif2xface < filename.gif > filename.xface
 810
 811         In filename.xface will be the X-Face header ready to use.
 812         You can add a custom header in Claws Mail through Configuration->
 813         Preferences per account, "Send" tab, check "Add user-defined header"
 814         then "Edit..." if you want to add it via the Claws Mail interface, or do
 815
 816                 echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc
 817
 818         if you want to create the custom headers file yourself (Warning: this
 819         method is valid only if you don't have any other custom header set or
 820         they will be lost!).
 821
 822   Contact: Ricardo Mones <ricardo@mones.org>
 823
 824
 825 * update-po
 826
 827   WHAT IT DOES
 828         This script is a message catalog translator's tool, it updates the .po
 829         files named on the command line.
 830
 831   HOW TO USE IT
 832         This script needs to be copied to and run from the 'po' directory.
 833
 834                 ./update-po lang.po lang2.po ...
 835
 836         to update one or more <yourlang>.po files from the sourcecode files
 837          named in POTFILES.in. The old .po file is save in a .po.old file.
 838
 839         For example, when you want to update fr.po, run ./update-po fr.po,
 840         then edit fr.po to update your translation.
 841
 842   Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team
 843
 844 --------------------------------------------------------------------------------
 845 This file is Copyright 1999-2014 by the Claws Mail team.
 846 See accompanying COPYING file for license details.
 847 See each included script for copyright and license details.
 848
 849 * cm-reparent.pl
 850
 851   WHAT IT DOES
 852         This script tries to fix thread parenting for two or more messages
 853
 854   HOW TO USE IT
 855         Define an action as
 856
 857           Menu name:  Reparent (fix threading)
 858           Command:    cm-reparent.pl %F
 859
 860         Then select from the message list all files that should be re-parented
 861
 862         Then invoke the action
 863
 864   MORE INFORMATION
 865         $ perldoc cm-reparent.pl
 866
 867   REQUIREMENTS
 868         Date::Parse
 869         Getopt::Long
 870
 871   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>
 872
 873 * cm-break.pl
 874
 875   WHAT IT DOES
 876         This script tries to break thread parenting for one or more messages
 877
 878   HOW TO USE IT
 879         Define an action as
 880
 881           Menu name:  Unthread (break threading)
 882           Command:    cm-break.pl %F
 883
 884         Then select from the message list all files that should be un-threaded
 885
 886         Then invoke the action
 887
 888   MORE INFORMATION
 889         $ perldoc cm-break.pl
 890
 891   REQUIREMENTS
 892         Date::Parse
 893         Getopt::Long
 894
 895   Contact: H.Merijn Brand <h.m.brand@xs4all.nl>