Documentation

Mail2rdf uses a configuration (ini) file to configure how the resulting RSS feed looks (using Perl module Config::Simple). The ini-file is structured in four sections: general, rss_image, rss and imap.

If a configuration file is not present when started, a default one will be created and a message will be shown, leading you to edit it to suit your needs. The file must be placed in $HOME/.mail2rdf/config.ini

Configuration example

[general]
debug=false

[rss_image]
link=http://kmail.kde.org/
url=http://kmail.kde.org/favicon.ico
title=Recent mails

[rss]
language=en
file=/home/foobar/.mail2rdf/mail.rdf
title=Recent mails
description=Short information on the recent unread mails from a IMAP folder
encoding=ISO-8859-1

[imap]
debug=false
login=foo
password=bar
host=mail.foobar.com
port=143
folder=INBOX

Section: general

Only one parameter can be set here: debug. It can be set to one of true or false. Setting it to true enables debugging in the mail2rdf tool itself.

Section: rss_image

These settings describe how the RSS image section is produced.

link

The URL of the RSS news source. This really does not give any good meaning when this is mail from your account. Maybe you could point to your webmail-access (if you have such one).

url

The URL of a image to show for the news source.

title

The title text of the news source, which is shown in your RSS reader.

Section: rss

These settings describe how the RSS file is produced.

language

The language code of the generated RSS file.

file

Full path of the RSS file to write.

Title

A title for the news.

description

A description for the news.

encoding

The encoding for the XML preample in the RSS file. In most cases, this is "ISO-8859-1" or "UTF-8".

Section: imap

These settings describe how connection to your IMAP server is made.

debug

Defines if debugging should be enabled on the "Mail::IMAPClient" perl module.

login

Your IMAP login.

password

Your IMAP password for the login.

host

Hostname of your IMAP server.

port

Port number of your IMAP server (most often this should be 143).

folder

The folder to check for new unseen mail in. (use INBOX in most cases).