claws-mail/tools/README

--------------------------------------------------------------------------------
Contents of the tools directory:
--------------------------------------------------------------------------------

Action scripts:
  freshmeat_search.pl		Search freshmeat.net for selected text
  google_msgid.pl               Search groups.google.com for selected message-id
  google_search.pl		Search google.com for selected text
  multiwebsearch.pl		Search any search engine for the selected text
  textviewer.sh			Attempt to view an attachment as plain text
  uudec                         Decode and display uuencoded images
  uuooffice			Decode uuencoded attachments and open them with
				OpenOffice

Addressbook conversion:
  eud2gc.py                     Convert Eudora address book to Gnomecard
  kmail2claws-mail.pl           Import a Kmail address book (KDE2)
  kmail2claws-mail_v2.pl        Import a Kmail address book (KDE3)
  outlook2claws-mail.pl         Import an Outlook generated contact list
  tb2claws-mail                 Import The Bat! address books
  vcard2xml.py			Import an Evolution vCard

Mailbox conversion:
  calypso_convert.pl            Import mbox files with attachments from Calypso
  convert_mbox.pl		Import mbox files
  kmail-mailbox2claws-mail.pl	Convert a kmail mailbox to a Claws Mail mailbox
  tbird2claws.py		Integrate a Thunderbird folder tree into Claws

Other tools:
  acroread2claws-mail.pl	Send PDFs from Adobe Reader 7
  filter_conv_new.pl		Convert new-style Sylpheed filters to filtering
  filter_conv.pl                Convert old-style Sylpheed filters to filtering
  fix-date.sh			Replace/Add a message's Date field
  nautilus2claws-mail.sh	Send files from Nautilus
  OOo2claws-mail.pl             Send documents from OpenOffice.org
  sylprint.pl                   Printing engine, explained in README.sylprint
  textviewer.pl			Display various attachments as text
  thunderbird-filters-convertor.pl
				Convert Thunderbird filtering rules

Extra tools:
  gif2xface.pl                  Convert a 48x48 GIF file to an X-Face header
  update-po                     Update the .po files named on the command line.

--------------------------------------------------------------------------------
Detailed Descriptions:
--------------------------------------------------------------------------------

Action scripts
--------------

* freshmeat_search.pl
  WORKS ON: selection
  COMMAND: |freshmeat_search.pl
  Search freshmeat.net for selected text using the default Claws Mail browser

* google_msgid.pl
  WORKS ON: selection
  COMMAND: |google_msgid.pl
  Lookup selected message-id in google using mozilla. Edit the script to use
  different browsers.

* google_search.pl
  WORKS ON: selection
  COMMAND: |google_search.pl
  Search google.com for selected text using the default Claws Mail browser

* multiwebsearch.pl
  WORKS ON: selection
  see further down for details

* textviewer.sh
  WORKS ON: current message part
  COMMAND: textviewer.sh %p |
  Attempt to view an attachment as plain text

* uudec
  WORKS ON: current message (or part of multipart message)
  COMMAND: uudec %f&
  Decode and display uuencoded images using uudecode.

* uuooffice
  WORKS ON: current message (or part of multipart message)
  COMMAND: uuooffice %f&
  Decode uuencoded attachments and open them with OpenOffice

* More action examples can be found at the Claws Mail FAQ
  http://www.claws-mail.org/faq/index.php/Actions

** multiwebsearch.pl **

  WHAT IT DOES
	This is an Actions script that allows you to search
	websites for the selected text. It uses the default
	Claws Mail browser as configured through Claws Mail's 
	GUI and specified in ~/.claws-mail/clawsrc, and a
	configuration file called multiwebsearch.conf.
	
  CONFIGURATION
  	The configuration file takes the following format:
	
	ALIAS|URL PART|URL PART
	
	ALIAS is a user-defined name; the first URL PART is the
	url before the search term; the second URL PART is
	optional and contains the remaining part of the url which
	comes after the search term. A sample configuration file
	is included.
	
  HOW TO USE IT
	Copy 'multiwebsearch.conf' to ~/.claws-mail/
	
	Configure an Action:
	a) pre-configured website 
	   Command: multiwebsearch.pl --where="google" --what="%s"
	b) dynamic
	   Command: multiwebsearch.pl --where="%u" --what="%s"
	   
	In type a) "google" refers to one of the configured aliases,
	this Action will always search the website referred to by
	the alias "google".
	
	In type b) you will be presented with a dialog box into
	which you type one of your configured aliases

  
  Contact: Paul Mangan <paul@claws-mail.org>
--------------------------------------------------------------------------------

Address book conversion
-----------------------

* eud2gc.py

  WHAT IT DOES
	This python-script is a quick hack to convert an Eudora (v.3?)
	addressbook to vCard (GnomeCard) format.

  HOW TO USE IT
	You may do whatever you want with it! (Also regarding copying)
	However, the script is intended to use like this:

		eud2gc.py <Eudora-addressbook-file> <Gnomecard-file>

  	Be careful not to overwrite your original GnomeCard.gcrd!
  	(But of course you might want to add the converted stuff to it)

  Contact: Jeroen Versteeg <j.m.versteeg@student.utwente.nl>

* kmail2claws-mail.pl

  WHAT IT DOES
	This perl script will convert an exported Kmail addressbook into a
  	Claws Mail addressbook. If your version of Kmail is 1.37 or
	greater and/or your version of KAddressBook is 3.1beta1 or greater,
	or this script mixes up your definitions and their related data, use
  	'kmail2claws-mail_v2.pl' instead.

  HOW TO USE IT
	(You must run claws-mail at least once before running this script.)

	In Kmail's Address book choose '/File/Export List'. This will export
  	your Kmail address book data to a *.csv file.

  	If Claws Mail is running, close it.

  	From the command line, execute the following:
 
		perl kmail2claws-mail.pl --kmailfile=/path/to/addressbook.csv

  	Your Kmail address book data will now be contained in Claws Mail'
  	address book, under the name 'Kmail Address Book'.

  Contact: Paul Mangan <paul@claws-mail.org>
    

* kmail2claws-mail_v2.pl

  This script has been tested with Kmail 1.4.7 and KAddressBook 3.1beta1

  WHAT IT DOES
	This perl script will convert a Kmail address book that has been
  	exported in csv format into a Claws Mail address book.

  HOW TO USE IT
	(You must run claws-mail at least once before running this script.)
  
  	Open Kmail's Addressbook, /File/Address Book
  	In Kmail's Addressbook choose '/File/Export/Export List...'. This 
  	will allow you to export your Kmail addressbook data to a *.csv file.

  	If Claws Mail is running, close it.

  	From the command line, execute the following:
 
		perl kmail2claws-mail_v2.pl --kmailfile=/path/to/addressbook.csv
	
  	You can also use --help to see usage instructions.

  	Your Kmail addressbook data will now be contained in Claws Mail'
  	addressbook, under the name 'Kmail address book'.

  Contact: Paul Mangan <paul@claws-mail.org>


* outlook2claws-mail.pl

  WHAT IT DOES
  	This perl script converts an Outlook generated contact list into a 
  	Claws Mail XML address book.

  HOW TO USE IT
  	For text files:
	--------------
  	You must export Outlook Express contact list as TXT file, choosing
  	only "Name" and "Address" fields to export.

  	You must exit Claws Mail before converting the contact list.

  	From the command line, execute the following:

		outlook2claws-mail.pl fullpathname

	For csv files:
	-------------
	You must export Outlook contact list as CSV file, choosing ALL the
	fields available for exporting.

	You must exit Claws Mail before converting the contact list.

	From the command line, execute the following:

		outlook2claws-mail.pl --csv fullpathname

  LIMITATIONS
	For text files only works with fields described above. If you have 
	more complex examples send them to me, and I'll try to enhance the 
	script.

	For csv files you must export all fields (but only non empty fields
	are added to the created Claws Mail address book) and the number
	of fields expected is harcoded. Look for the $nboffields variable in
	the script and change its value if you are sure you exported all
	fields and script gives the 'unknown csv file format' error.

  Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>


* tb2claws-mail

  WHAT IT DOES
  	This perl script will convert an address book exported from The Bat! 
	into a Claws Mail address book.

  HOW TO USE IT
	(You must run claws-mail at least once before running this script.)

  	If Claws Mail is running, close it.

  	Export The Bat! Address Book to CSV file format with all fields 
  	selected to YES and then start:

  		tb2claws-mail --tbfile=/full/path/to/thebat/addressbook.csv
 
  	The Bat! addressbook data will now be contained in Claws Mail'
  	addressbook, under the name 'The Bat! Address Book'.

  Contact: Urke MMI <urke@gmx.net>  


* vcard2xml.py

  WHAT IT DOES
  	This python script will convert an Evolution vCard into a Claws Mail
	address book.

  HOW TO USE IT
	(You must run claws-mail at least once before running this script.)

  	If Claws Mail is running, close it.
	From the command line, execute the following:

  		vcard2xml.py source_file [destination_file]
 
  	When only <source_file> is specified it will overwrite (and
	create a backup of) the existing addressbook. 
	When both arguments are suplied it will create a new additional 
	addressbook named as <destination_file>.
	If the script encounters an error it will attempt to roll back
	the changes and restore the original files.

  Contact: Bogdan Sumanariu <bsumanariu@one5.ro> 

--------------------------------------------------------------------------------

Mailbox conversion
------------------

* calypso_convert.pl

  WHAT IT DOES
	This perl script imports mbox files that are exported by Calypso.
  	It recreates the folder structure by scanning the "X-CalypsoFolder"
  	header and reincludes the attachments referenced in the
  	"X-CalypsoHtmlBody" "X-CalypsoAccount" "X-Attachment" headers.
  
  HOW TO USE IT
	Export the Calypso mailbox by selecting "Save to archive" and check
  	the "Save attachments" box.
	
  	Edit the script to set following variables (at the top of the file):
 	   $mboxdir  : path to the exported mbox, e.g. 'Archive' or '.'
 	   $mboxfile : name of exported mbox, e.g. 'mail.txt'
 	   $outdir   : name of the MH folder to create, e.g. 'Calypso'
	   
 	 Run the script using
	 
    		perl calypso_convert.pl
		
  	Finally, import that folder by either selecting "New mailbox" or
  	moving it into your existing directory and recreate the folder
  	structure manually (contentmenu from folderview).

  Contact: Thorsten Maerz <torte@netztorte.de>

* convert_mbox.pl

  WHAT IT DOES
	This perl script converts an mbox directory's contents into 
	Claws Mail' MH format.
  
  HOW TO USE IT
  
	Run the script using:
	 
    		perl convert_mbox.pl MBOX MH_DIR
		
	Move the outputted MH_DIR and its contents into your Claws Mail
	Mail folder; in Claws Mail right-click the top-level folder and
	choose 'Rebuild folder tree' from the popup menu.

  Contact: Fred Marton <Fred.Marton@uni-bayreuth.de>

* kmail-mailbox2claws-mail.pl

  WHAT IT DOES
	This perl script converts a kmail mailbox  into Claws Mail' mailbox.
  
  HOW TO USE IT
  
  	Exit Claws Mail if running.
	
	Run the script using:
	 
    		kmail-mailbox2claws-mail.pl --kmaildir=/full/path/to/kmail/mailbox
		
	Start Claws Mail and right-click the toplevel mailbox, i.e
	"Mailbox (MH)", and select 'Rebuild folder tree'.
	You may also need to run '/File/Folder/Check for new messages
	in all folders'
	
	Additional options:
		--debug		debug mode
		--dry-run	test mode, nothing is actually written
		--help		brief usage info
	
  Contact: Paul Mangan <paul@claws-mail.org>

* tbird2syl.py

  WHAT IT DOES
	This python script integrates a Thunderbird folder tree into 
        Claws Mail.
  
  HOW TO USE IT
  
	The script receives two parameters from command-line:
	<Thunderbird folder path> <Claws Mail folder path>

	The best way to use it is to go to inside your Thunderbird
	root mailfolder directory and invoke it as:

		<path>\python2.4 <path>\tbird2syl.py . <path to Claws Mail>\Mail

  Contact: Aleksandar Urosevic aka Urke MMI <urke@gmx.net>

--------------------------------------------------------------------------------

Other tools
-----------

* acroread2claws-mail.pl

  WHAT IT DOES
  	This perl script enables Adobe Reader 7 to send documents to
	Claws Mail as attachments.

  HOW TO USE IT
  	Make sure that the script is executable (chmod +x acroread2claws-mail.pl)
	Start up Adobe Reader 7 (acroread)
	Go to /Edit/Preferences/SendMail
	Select any email client except 'System Mail (mail)'
	Enter the path to this script in the alternate location box  

  	You can then use 'File/Email' or the Email toolbar button to launch
	claws-mail (if not already launched) and open a new compose window
	with the PDF attached.
  
  Contact: Paul Mangan <paul@claws-mail.org>


* filter_conv_new.pl

  WHAT IT DOES
	This perl script provides easy conversion of your filtering rules from
	sylpheed's new filter system (>= 0.9.99) to the filtering system used in
	Claws Mail.
	It reads '~/.sylpheed-2.0/filter.xml' or '~/.sylpheed/filter.xml' and
	writes '~/[CLAWS CONFIG DIR]/matcherrc'
  
  HOW TO USE IT
	Issue the following command from the 'tools' directory:

        perl filter_conv_new.pl

  	That's it, the claws' filtering system is now implemented with your
  	previous rules applied.

  REQUIREMENTS
	XML::SimpleObject

  Contact: Paul Mangan <paul@claws-mail.org>
  

* filter_conv.pl

  WHAT IT DOES
	This perl script provides easy conversion of your filtering rules
  	from sylpheed's old filter system (< 0.9.99) to the filtering system
	used in Claws Mail.
	It reads '~/.sylpheed/filterrc' and writes '~/.claws-mail/matcherrc'
  
  HOW TO USE IT
	Issue the following command from the 'tools' directory:

        perl filter_conv.pl

  	That's it, the new filtering system is now implemented with your
  	previous rules applied.

  Contact: Paul Mangan <paul@claws-mail.org>
  

* fix-date.sh

 WHAT IT DOES
	It will replace the Date: value w/ the one picked up from
	more recent Received: field if this field resides in one
	line. Otherwise, it will take the file modification time
	(using a RFC 2822-compliant form). If no X-Original-Date already
	exist, the former Date value will be set in such field.

  HOW TO USE IT
	fix_date.sh <filename> [<filename>..]

  Contact: wwp <wwp@claws-mail.org>


* nautilus2claws-mail.sh

  WHAT IT DOES
	This script will recursively attach a number of selected 
	files/directories from Nautilus to a new blank e-mail.

  HOW TO USE IT
  	Copy the script to $HOME/.gnome2/nautilus-scripts, chmod u+x, 
	and restart nautilus (killall -9 nautilus). You will now have 
	a right-click menu item: '/Scripts/nautilus2claws-mail.sh'
	
  Contact: Reza Pakdel <hrpakdel@cpsc.ucalgary.ca>


* OOo2claws-mail.pl

  WHAT IT DOES
  	This perl script enables OpenOffice.org to send documents to
	Claws Mail as attachments.

  HOW TO USE IT
    OpenOffice.org Version 2.0
    ----------------------------
	This script is not needed for OOo version 2, which can work
	directly with Claws Mail.
	Go to 'Tools/Options/Internet/E-mail' and enter 'claws-mail'
	in the box.

    OpenOffice.org Version 1.1.0
    ----------------------------
  	Start up OpenOffice.org.
  	Go to 'Tools/Options/OpenOffice.org/External Programs'
	Select either ''Mozilla 1.x (Option 1)', or 
	'Netscape 6.x - 7.0 (Option 1)' from the 'Program' selection
  	Enter the path to OOo2claws-mail.pl in the 'Path' box
  	or select it by clicking on the '...' button.
    
  	You can then use 'File/Send/Document as email' to launch
	claws-mail (if not already launched) and open a new compose
	window with the document attached.

    OpenOffice.org Version 1.0
    --------------------------
  	Start up OpenOffice.org.
  	Go to 'Tools/Options/OpenOffice.org/External Programs'
  	Enter the path to OOo2claws-mail.pl in the 'Program' box
  	or select it by clicking on the '...' button.


  Contact: Paul Mangan <paul@claws-mail.org>


* textviewer.pl

  WHAT IT DOES
	This script tries to recognise an attachment by using the 'file'
	command and/or the file extension and then uses the available Linux
	utilities to make an effort to display it as text. For example
		.doc			antiword -w 72
		.txt, .diff, .c, .h,
  		  .ic. .ec, .cc, .sh,
  		  .sed, .awk		cat
		.html			txt2htm	or text2html
		.xls, .sxc, .csv	xlscat -L
		.rtf			rtf2text
		.pdf			pdf2text %f -
		.odt			ooo2txt
		.pl, .pm		perltidy -st -se or  cat
		.bz2			bzip2 -d < %f | strings

  HOW TO USE IT
  	Go to /Configuration/Message View/External Programs and enter the
	path to the script in the "Command for 'Display as text'" box.
	Now when you right-click an attachment and choose 'Display as text'
	this script will be invoked.

	
  Contact: H.Merijn Brand <h.m.brand@xs4all.nl>


* thunderbird-filters-convertor.pl

  WHAT IT DOES
	This perl script converts Thunderbird filtering rules into Claws Mail
	filtering rules. It can be run several times, once for each filter
	configuration file in Thunderbird.

  HOW TO USE IT
	The script takes 3 arguments:

	--tbird-file=PATH TO FILE	The full path to the file to be converted
	--mailbox-name=NAME		The name of the Claws Mail mailbox
	--account-name=NAME		The name of the account to be used (optional)	

	--tbird-file must point to the Thunderbird filter file (msgFilterRules.dat)
	that you want to convert, it must contain the full path to the file.
	--mailbox-name should be given the name of your mailbox in Claws Mail, e.g.
	if the top-level folder is 'Mailbox (MH)' then this option should be
	'Mailbox'.
	--account-name is optional, only needed if you are creating account-specific
	rules. This is the name of your account in Claws Mail, which should
	correspond to an account that you had in Thunderbird, e.g. the acount whose
	rules you are converting.

	This script presumes that your folder hierarchy in Claws Mail matches the
	one that you had in Thunderbird. If you used the tbird2claws.py script to
	convert your Thunderbird mailbox, then the folder hierarchy should match.

	If the Claws Mail filtering configuration file (matcherrc) does not exist,
	the script will create it; if it does exist, the newly converted rules will
	be appended to it.

  REQUIREMENTS
	Getopt::Long
	URI::Escape

  Contact: Paul Mangan <paul@claws-mail.org>

--------------------------------------------------------------------------------

Extra tools
-----------

* gif2xface.pl

  WHAT IT DOES
	This perl script converts a monochrome (1 bit) 48x48 pixels GIF file
  	into an X-Face graphic suitable for inclusion into custom headers of
  	Claws Mail. An X-Face allows to quickly identify (or be identified
	as) the sender of a mail message in a xface-capable MUA (like sylpheed
	-claws).

  HOW TO USE IT
	After obtaining the desired image for your X-Face you should:
    	  * scale it to 48x48 pixels (Image->Scale image on Gimp)
    	  * down color depth to b/w (Image->Mode->Indexed selecting "Use
      	    Black/White palette" and the desired dithering options (prior to
      	    indexing doing Image->Colors->Threshold allows you to select the
      	    b/w level if you don't want a dithered (dotty) image))
    	  * save file as non-interlaced GIF
  	Then do:

      		./gif2xface < filename.gif > filename.xface

  	In filename.xface will be the X-Face header ready to use.
  	You can add a custom header in Claws Mail through Configuration->
  	Preferences per account, "Send" tab, check "Add user-defined header"
  	then "Edit..." if you want to add it via the Claws Mail interface, or do

      		echo "0:" `cat filename.xface` > ~/.claws-mail/customheaderrc

  	if you want to create the custom headers file yourself (Warning: this
  	method is valid only if you don't have any other custom header set or
  	they will be lost!).

  Contact: Ricardo Mones Lastra <mones@aic.uniovi.es>


* update-po

  WHAT IT DOES
  	This script is a message catalog translator's tool, it updates the .po 
  	files named on the command line.

  HOW TO USE IT
	This script needs to be copied to and run from the 'po' directory.
  
		./update-po lang.po lang2.po ...

  	to update one or more <yourlang>.po files from the sourcecode files
 	 named in POTFILES.in. The old .po file is save in a .po.old file.

  	For example, when you want to update fr.po, run ./update-po fr.po, 
  	then edit fr.po to update your translation.

  Contact: Wilbert Berendsen <wilbert@oswf.org> or the Claws Mail Team

--------------------------------------------------------------------------------