2005-11-20 10:52:31 +01:00
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
2005-10-24 12:09:38 +02:00
|
|
|
<section id="ch_advanced">
|
2005-11-20 10:41:20 +01:00
|
|
|
<title>Advanced features</title>
|
2005-10-24 12:09:38 +02:00
|
|
|
<section id="adv_actions">
|
|
|
|
<title>Actions</title>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Actions allow you to use all the power of the Unix command-line with
|
|
|
|
your emails. You can define various commands, taking parameters such
|
|
|
|
as the current email file, a list of emails, the currently selected
|
|
|
|
text, and so on. In this way, you'll be able to perform various tasks
|
|
|
|
such as editing a raw mail in your text editor,
|
|
|
|
<emphasis>hide</emphasis> what you mean using ROT-13, apply patches
|
|
|
|
contained in emails directly, and so on. The only limit is your
|
2008-03-21 11:06:41 +01:00
|
|
|
imagination. You can create and configure Actions via the
|
|
|
|
<quote>/Configuration/Actions...</quote> menu.
|
2005-10-24 12:09:38 +02:00
|
|
|
</para>
|
2007-10-04 17:28:26 +02:00
|
|
|
<para>
|
|
|
|
The <quote>Tools/Actions/</quote> menu will contain one submenu
|
|
|
|
item for each action that you have created. When you have selected
|
|
|
|
one or more messages in the Message List, or are viewing a message
|
|
|
|
in the Message View, selecting one of these menu items will invoke
|
|
|
|
the action, and, depending on how it was defined, will pass the
|
|
|
|
message(s) to it.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
Additionally, it is possible to add toolbar entries for your
|
2007-10-05 02:13:37 +02:00
|
|
|
actions. To do so, open the <quote>Configuration/Preferences</quote>
|
2007-10-04 17:28:26 +02:00
|
|
|
menu and select <quote>Customize Toolbars/Main Window</quote>.
|
2008-03-21 11:06:41 +01:00
|
|
|
Select <quote>User Action</quote> in the <quote>Item type</quote>
|
|
|
|
dropdown menu, then select the Action in the <quote>Event executed on click</quote>
|
|
|
|
dropdown menu, and click the <quote>Icon</quote> button to select the
|
|
|
|
icon that you want to use.
|
2007-10-04 17:28:26 +02:00
|
|
|
</para>
|
2005-11-24 13:37:29 +01:00
|
|
|
<blockquote>
|
2006-08-24 06:52:01 +02:00
|
|
|
<example>
|
|
|
|
<title>Simple <quote>Open With...</quote></title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term>
|
|
|
|
Menu name: <emphasis>Open with/kate</emphasis>
|
|
|
|
Command Line: <command>kate %p</command>
|
|
|
|
</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Opens the file of the selected decoded MIME part
|
|
|
|
(<emphasis>%p</emphasis>) with the <emphasis>kate</emphasis> text
|
|
|
|
editor.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</example>
|
|
|
|
<example>
|
|
|
|
<title>Spam management using <ulink
|
|
|
|
url="http://bogofilter.sourceforge.net/">Bogofilter</ulink>
|
|
|
|
</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term>
|
|
|
|
Menu name: <emphasis>Bogofilter/Mark as Ham</emphasis>
|
|
|
|
Command Line: <command>bogofilter -n -v -B "%f"</command>
|
|
|
|
</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Marks the currently selected mails (<emphasis>%f</emphasis>) as
|
|
|
|
<quote>not spam</quote> using <emphasis>Bogofilter</emphasis>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term>
|
|
|
|
Menu name: <emphasis>Bogofilter/Mark as Spam</emphasis>
|
|
|
|
Command Line: <command>bogofilter -s -v -B "%f"</command>
|
|
|
|
</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Marks the currently selected mails (<emphasis>%f</emphasis>) as
|
|
|
|
<quote>spam</quote> using <emphasis>Bogofilter</emphasis>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</example>
|
|
|
|
<example>
|
|
|
|
<title>Search Google using an external script</title>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term>
|
|
|
|
Menu name: <emphasis>Search/Google</emphasis>
|
|
|
|
Command Line: <command>|/path/to/google_search.pl</command>
|
|
|
|
</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Searches Google for the currently selected text
|
|
|
|
(<emphasis>|</emphasis>) using the external script <emphasis><ulink
|
2006-11-07 11:24:03 +01:00
|
|
|
url="http://www.claws-mail.org/tools.php"
|
2006-08-24 06:52:01 +02:00
|
|
|
>google_search.pl</ulink></emphasis>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</example>
|
2005-11-24 13:37:29 +01:00
|
|
|
</blockquote>
|
2005-10-24 12:09:38 +02:00
|
|
|
</section>
|
|
|
|
<section id="adv_templates">
|
|
|
|
<title>Templates</title>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Templates are used in composition windows, and act as a model for
|
|
|
|
emails. Templates can be filled with static text and dynamic parts,
|
|
|
|
such as the original sender's name (<quote>Dear %N, ...</quote>),
|
|
|
|
the date, etc. When applying a template, the dynamic fields will be
|
|
|
|
replaced with the relevant values. You can configure templates via
|
|
|
|
the <quote>Tools</quote> menu.
|
|
|
|
</para><para>
|
|
|
|
When applying a template, you will be asked to <quote>Insert</quote>
|
|
|
|
or <quote>Replace</quote>, the difference between replacing and
|
|
|
|
inserting is only concerned with the message body.
|
|
|
|
<quote>Replace</quote> will replace the current composition window
|
|
|
|
message body with the body defined in the template, clearing it if
|
|
|
|
the template body is empty. <quote>Insert</quote> will insert
|
|
|
|
the template's body, if set, at the current cursor position.
|
|
|
|
</para><para>
|
|
|
|
Whether you choose to Insert or Replace, any To, Cc or Bcc field
|
|
|
|
that is defined in the template will be appended to the compose
|
|
|
|
window's recipients list. If it is defined, the template's Subject
|
|
|
|
will always replace the compose window's Subject.
|
|
|
|
</para><para>
|
|
|
|
Symbols can be used in all parts of the templates and will be
|
|
|
|
substituted with their respective dynamic value if possible, otherwise
|
|
|
|
no value will be used. This often makes more sense if you apply a
|
|
|
|
template when replying or forwarding, otherwise most of the symbols
|
|
|
|
value will be undefined. There is no restriction on which symbols can
|
|
|
|
be used in template parts, even if inserting the body (%M or %Q) may
|
|
|
|
make no sense in common situations.
|
|
|
|
</para><para>
|
|
|
|
When applying a template, the body is processed first, then the To, Cc,
|
|
|
|
Bcc and Subject fields follow.
|
|
|
|
</para><para>
|
|
|
|
Further information and examples of usage can be found in the
|
2006-11-07 11:24:03 +01:00
|
|
|
user-contributed FAQ on the Claws Mail website <ulink
|
|
|
|
url="http://www.claws-mail.org/faq/"
|
|
|
|
>http://www.claws-mail.org/faq/</ulink>.
|
2006-02-15 09:25:24 +01:00
|
|
|
</para>
|
|
|
|
</section>
|
2005-10-24 12:09:38 +02:00
|
|
|
<section id="adv_processing">
|
|
|
|
<title>Processing</title>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Processing rules are the same as Filtering rules, except that they are
|
2007-08-07 11:07:47 +02:00
|
|
|
applied when entering a folder or when manually applied from a folder's
|
|
|
|
context menu and apply only to this folder. You can use them to automatically
|
|
|
|
move old mails into an archive folder, or for further dispatching of
|
|
|
|
emails, and more. You can set each folder's Processing rules by
|
|
|
|
right-clicking on it.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para><para>
|
|
|
|
Processing rules are accompanied by Pre-processing and Post-processing
|
2007-08-07 11:07:47 +02:00
|
|
|
rules. Like Processing rules, they apply when opening a folder or manually
|
|
|
|
applying them from a folder's context menu, but like Filtering rules,
|
|
|
|
they are shared across all folders. You can configure them from the
|
|
|
|
<quote>Tools</quote> menu. Pre-processing rules are executed before the
|
|
|
|
folder's specific Processing rules, while Post-processing rules are executed
|
|
|
|
afterwards.
|
2005-10-24 12:09:38 +02:00
|
|
|
</para>
|
|
|
|
</section>
|
2006-04-05 11:58:39 +02:00
|
|
|
<section id="adv_colour_labels">
|
2006-08-24 06:52:01 +02:00
|
|
|
<title>Colour Labels</title>
|
|
|
|
<para>
|
|
|
|
Colour labels can be used to denote a message as having a particular
|
|
|
|
significance. To set a colour label simply right-click a message in the
|
|
|
|
Message List and use the <quote>Color label</quote> submenu.
|
|
|
|
</para><para>
|
|
|
|
Colour labels are user-configurable. Both the colour and the label can
|
|
|
|
be set by the user. Preferences can be found on the
|
|
|
|
<quote>Configuration/Preferences/Display/Colors</quote> page.
|
|
|
|
</para>
|
2006-04-05 11:58:39 +02:00
|
|
|
</section>
|
2006-05-18 13:18:28 +02:00
|
|
|
<section id="adv_ml_support">
|
2006-08-24 06:52:01 +02:00
|
|
|
<title>Mailing-List support</title>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Claws Mail offers mailing-list support from the
|
2006-08-24 06:52:01 +02:00
|
|
|
<quote>Message/Mailing-List/</quote> submenu. When you have a
|
|
|
|
mailing-list message selected, the submenu allows you to quickly
|
|
|
|
initiate subscribing, unsubscribing, posting, getting help, contacting
|
|
|
|
the list owner, and viewing the list archive; either by opening a new
|
|
|
|
Compose window with the appropriate address pre-filled, or by opening
|
|
|
|
the URL in your web browser.
|
|
|
|
</para>
|
2006-05-18 13:18:28 +02:00
|
|
|
</section>
|
2005-10-24 12:09:38 +02:00
|
|
|
<section id="adv_plugins">
|
|
|
|
<title>Plugins</title>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Plugins are the mechanism for extending Claws Mail' capabilities.
|
2006-08-24 06:52:01 +02:00
|
|
|
For example, imagine that you want to store your mails in a remote
|
|
|
|
<acronym>SQL</acronym> database. In most mailers out there this is
|
|
|
|
simply impossible without reworking the internals of the mailer. With
|
2006-11-07 11:24:03 +01:00
|
|
|
Claws Mail you can simply write a plugin to achieve the task.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para><para>
|
|
|
|
This is just an example of the possibilities. A good number of plugins
|
2006-11-07 11:24:03 +01:00
|
|
|
developed for Claws Mail already exist, and more are to come. The
|
|
|
|
<link linkend="ch_plugins">Extending Claws Mail section</link>
|
2006-08-24 06:52:01 +02:00
|
|
|
gives details of them.
|
2005-10-24 12:09:38 +02:00
|
|
|
</para>
|
|
|
|
</section>
|
2006-04-06 19:41:26 +02:00
|
|
|
<section id="deploying">
|
2006-11-07 11:24:03 +01:00
|
|
|
<title>Deploying Claws Mail</title>
|
2006-04-06 19:41:26 +02:00
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
The initial configuration wizard tries to guess various fields using
|
|
|
|
information gathered from the system, such as username, hostname, and
|
|
|
|
more. As it is oriented towards general use, the default values often
|
|
|
|
have to be fixed. However, this wizard is customisable, in a manner
|
2006-11-07 11:24:03 +01:00
|
|
|
designed to allow system administrators to deploy Claws Mail easily
|
2006-08-24 06:52:01 +02:00
|
|
|
over various users of one machine, or even over multiple machines
|
|
|
|
installed via some replication tool.
|
|
|
|
</para><para>
|
|
|
|
The first part consists of creating a wizard configuration template
|
2006-11-07 11:24:03 +01:00
|
|
|
and setting the various default parameters of a new Claws Mail
|
2006-08-24 06:52:01 +02:00
|
|
|
installation.
|
2006-04-06 19:41:26 +02:00
|
|
|
</para>
|
|
|
|
<itemizedlist>
|
2006-08-24 06:52:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Start with a user who does not have a <filename class="directory"
|
2006-11-07 11:24:03 +01:00
|
|
|
>~/.claws-mail</filename> directory, ideally a new user.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Start Claws Mail and go through the wizard. The values you fill in
|
2006-08-24 06:52:01 +02:00
|
|
|
will be of no use for the future deployment, so you can click
|
|
|
|
next-next-next.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Once the wizard is finished and you have Claws Mail' main window
|
2006-08-24 06:52:01 +02:00
|
|
|
opened, configure the various defaults you want to have in the master.
|
|
|
|
You can load plugins, add people or LDAP servers in the addressbook,
|
|
|
|
create filtering rules, and so on.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
If needed, and if the deployed Claws Mail will use MH folders, you
|
2006-08-24 06:52:01 +02:00
|
|
|
can create subdirectories in the mailbox.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Next, quit Claws Mail.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Now, edit the newly created wizard template file,
|
2006-11-07 11:24:03 +01:00
|
|
|
<filename>~/.claws-mail/accountrc.tmpl</filename>. In this file,
|
2006-08-24 06:52:01 +02:00
|
|
|
you will see different variables, corresponding to the wizard's fields.
|
|
|
|
You can leave some commented, in which case the usual default will be
|
|
|
|
used, or specify values or variables. Not all fields can contain
|
|
|
|
variables; for example, <literal>smtpauth</literal>,
|
|
|
|
<literal>smtpssl</literal> and <literal>recvssl</literal> are booleans,
|
|
|
|
either 0 or 1, and <literal>recvtype</literal> is an integer value. The
|
|
|
|
other fields, like <literal>name</literal>, <literal>email</literal>,
|
|
|
|
or <literal>recvuser</literal>, are parsed by the wizard and the
|
|
|
|
variables they contain are replaced by values. This allows you to
|
|
|
|
specify everything as needed for your site, even if you have strange
|
|
|
|
server names or server logins.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Save this file, and delete both
|
2006-11-07 11:24:03 +01:00
|
|
|
<filename>~/.claws-mail/accountrc</filename>, (which contains your
|
2006-08-24 06:52:01 +02:00
|
|
|
dummy account) and
|
2006-11-07 11:24:03 +01:00
|
|
|
<filename>~/.claws-mail/folderlist.xml</filename>, (so that the
|
2006-08-24 06:52:01 +02:00
|
|
|
folder tree will be correctly parsed for new users). Recursively copy
|
2006-11-07 11:24:03 +01:00
|
|
|
<filename class="directory">.claws-mail</filename> to
|
2006-08-24 06:52:01 +02:00
|
|
|
<filename class="directory">/etc/skel/</filename>; if the deployed
|
2006-11-07 11:24:03 +01:00
|
|
|
Claws Mail will use MH folders, also copy the created
|
2006-08-24 06:52:01 +02:00
|
|
|
<filename class="directory">Mail</filename> directory. chown all of
|
2006-11-07 11:24:03 +01:00
|
|
|
<filename class="directory">/etc/skel/.claws-mail</filename>
|
2006-08-24 06:52:01 +02:00
|
|
|
and <filename class="directory">/etc/skel/Mail</filename> to
|
|
|
|
<literal>root:root</literal> for security reasons.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
Test! Create a new user, login as that user, run Claws Mail. If you
|
2006-08-24 06:52:01 +02:00
|
|
|
filled everything as you wanted, this user will just have to fill in
|
|
|
|
his passwords.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Now, if you're creating a master for a site-wide deployment, you can
|
|
|
|
continue with this process. If you were just doing it for one machine,
|
|
|
|
you're done!
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2006-04-06 19:41:26 +02:00
|
|
|
</itemizedlist>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Here are the different variables of the <filename>accountrc.tmpl</filename>
|
|
|
|
file:
|
2006-04-06 19:41:26 +02:00
|
|
|
</para>
|
|
|
|
<variablelist>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>domain</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Your domain name (example.com). If not set, it'll be extracted from the
|
|
|
|
hostname.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>name</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The user's name. If not set, it'll be extracted from Unix login
|
|
|
|
information, which is usually ok.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>email</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The user's email. If not set, it'll be extracted from
|
|
|
|
<literal>$name</literal> and <literal>$domain</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>organization</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Your organization. If not set, it'll be empty.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>smtpserver</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The SMTP server to use. If not set, it'll be
|
|
|
|
<literal>smtp.$domain</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>smtpauth</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. Whether to authenticate on the SMTP server. If not set, it'll
|
|
|
|
be 0.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>smtpuser</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The login on the SMTP server. If not set, it'll be empty (same login as
|
|
|
|
for reception will be used).
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>smtppass</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The password on the SMTP server. If not set, it'll be empty (if
|
|
|
|
<literal>smtppass</literal> is empty but <literal>smtpuser</literal> is
|
|
|
|
not, the user will be asked for the password).
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>recvtype</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The type of server to receive from. 0 for POP3, 3 for IMAP4, 5 for a
|
|
|
|
local MBOX file. If not set, it'll be 0 (POP3).
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>recvserver</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The reception server. If not set, it'll be
|
|
|
|
<literal>(pop|imap).$domain</literal>, depending on
|
|
|
|
<literal>$recvtype</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>recvuser</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The login on the reception server. If not set, it'll be extracted from
|
|
|
|
the Unix login information.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>recvpass</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The password on the reception server. If not set, it'll be empty (the
|
|
|
|
user will be asked for it once per session).
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>imapdir</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The IMAP subdirectory. If not set, it'll be empty, which is often
|
|
|
|
sufficient.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>mboxfile</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The MBOX file to receive from if <literal>$recvtype</literal> is 5.
|
|
|
|
If not set, <literal>/var/mail/$LOGIN</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>mailbox</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The MH mailbox to store mail in (for <literal>$recvtype</literal> 0 or
|
|
|
|
5). If not set, it'll be <quote>Mail</quote>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>smtpssl</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. Whether to use SSL for sending mail. If not set, it'll be 0.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>recvssl</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. Whether to use SSL for receiving mail. If not set, it'll be 0.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-04-06 19:41:26 +02:00
|
|
|
</variablelist>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Here are the different variables you can use in the
|
|
|
|
<literal>domain</literal>, <literal>name</literal>,
|
|
|
|
<literal>email</literal>, <literal>organization</literal>,
|
|
|
|
<literal>smtpserver</literal>, <literal>smtpuser</literal>,
|
|
|
|
<literal>smtppass</literal>, <literal>recvserver</literal>,
|
|
|
|
<literal>recvuser</literal>, <literal>recvpass</literal>,
|
|
|
|
<literal>imapdir</literal>, <literal>mboxfile</literal> and
|
|
|
|
<literal>mailbox</literal> fields:
|
2006-04-06 19:41:26 +02:00
|
|
|
</para>
|
|
|
|
<variablelist>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$DEFAULTDOMAIN</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The domain name as extracted from Unix hostname information.
|
|
|
|
Often wrong.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$DOMAIN</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The domain name as set in the domain variable, the first of the
|
|
|
|
template file.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$USERNAME</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>The user's real name.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$LOGIN</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>The user's Unix login.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$NAME_MAIL</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The user's real name as set in the name variable of the template field,
|
|
|
|
in lowercase and with spaces replaced by dots.
|
|
|
|
<quote>Colin Leroy</quote> becomes <quote>colin.leroy</quote>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>$EMAIL</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The email address as set in the email variable of the template field.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-04-06 19:41:26 +02:00
|
|
|
</variablelist>
|
|
|
|
<para>
|
2006-08-24 06:52:01 +02:00
|
|
|
Be sure not to use a variable before defining it.
|
2006-04-06 19:41:26 +02:00
|
|
|
</para>
|
|
|
|
</section>
|
2005-10-24 12:09:38 +02:00
|
|
|
<section id="adv_hidden">
|
|
|
|
<title>Hidden preferences</title>
|
|
|
|
<para>
|
2006-11-07 11:24:03 +01:00
|
|
|
There are a number of hidden preferences in Claws Mail, preferences
|
2006-08-24 06:52:01 +02:00
|
|
|
that some users who we wanted to please couldn't live without, but
|
|
|
|
which did not have a place in the GUI in our opinion. You can find the
|
2006-11-07 11:24:03 +01:00
|
|
|
following, and change them while Claws Mail is not running, in
|
2006-11-10 08:41:05 +01:00
|
|
|
<filename>~/.claws-mail/clawsrc</filename>.
|
2005-10-24 12:09:38 +02:00
|
|
|
</para>
|
2008-06-20 13:13:30 +02:00
|
|
|
<para>
|
|
|
|
There's a small tool written in Perl-GTK called Clawsker which
|
|
|
|
provides a user-friendly GUI for tweaking these settings instead of
|
|
|
|
direct editing of <filename>clawsrc</filename>. You can read more
|
|
|
|
about it on the <ulink url="http://www.claws-mail.org/clawsker">Clawsker
|
|
|
|
page</ulink>.
|
|
|
|
</para>
|
2005-11-20 10:41:20 +01:00
|
|
|
<variablelist>
|
2006-12-01 15:24:50 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>addressbook_use_editaddress_dialog</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2007-01-08 10:51:31 +01:00
|
|
|
Use a separate dialogue to edit a person's details.
|
|
|
|
'0' will use a form embedded in the addressbook's main window.
|
2006-12-01 15:24:50 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>bold_unread</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Show unread messages in the Message List using a bold font.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>cache_max_mem_usage</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The maximum amount of memory to use to cache messages, in kB.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>cache_min_keep_time</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
The minimum time in minutes to keep a cache in memory. Caches more
|
2006-08-24 06:52:01 +02:00
|
|
|
recent than this time will not be freed, even if the memory usage is
|
|
|
|
too high.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>compose_no_markup</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Don't use bold and italic text in Compose dialogue's account selector.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2007-08-24 14:01:29 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>emphasis_color</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The colour used for the X-Mailer line when its value is Claws Mail.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-09-01 11:43:35 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>enable_dotted_lines</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-14 10:42:08 +02:00
|
|
|
Use the <emphasis>old</emphasis> dotted line look in the main window
|
|
|
|
GtkTreeView components, (Folder List and Message List), instead of the
|
|
|
|
<emphasis>modern</emphasis> lineless look.
|
2006-09-01 11:43:35 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>enable_hscrollbar</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Enable the horizontal scrollbar in the Message List.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>enable_swap_from</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Display the sender's email address in the To column of the
|
|
|
|
Sent folder instead of the recipient's.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>folderview_vscrollbar_policy</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Specify the policy of vertical scrollbar of Folder List.
|
|
|
|
'0' is always shown, '1' is automatic, '2' is always hidden.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>hover_timeout</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Time in milliseconds that will cause a folder tree to expand
|
|
|
|
when the mouse cursor is held over it during drag 'n' drop.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>live_dangerously</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Don't ask for confirmation before definitive deletion of emails.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>log_error_color</literal></term>
|
|
|
|
<term><literal>log_in_color</literal></term>
|
|
|
|
<term><literal>log_msg_color</literal></term>
|
|
|
|
<term><literal>log_out_color</literal></term>
|
|
|
|
<term><literal>log_warn_color</literal></term>
|
2008-11-29 09:48:22 +01:00
|
|
|
<term><literal>log_status_ok_color</literal></term>
|
|
|
|
<term><literal>log_status_nok_color</literal></term>
|
|
|
|
<term><literal>log_status_skip_color</literal></term>
|
2006-08-24 06:52:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
The colours used in the log window.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2008-05-15 11:03:53 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>outgoing_fallback_to_ascii</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. The outgoing encoding of a message will use 7bit US-ASCII
|
|
|
|
whenever it is suitable for the message content, ignoring the
|
2008-06-20 13:13:30 +02:00
|
|
|
<quote>Outgoing encoding</quote> option unless it is necessary. Turning
|
|
|
|
this option off forces the user-defined encoding to be used, regardless
|
2008-05-15 11:03:53 +02:00
|
|
|
of message content. Default is 1, turned on.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2008-11-29 09:48:22 +01:00
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>primary_paste_unselects</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. Causes the primary buffer to be cleared and the insertion
|
|
|
|
point to be repositioned when the middle mouse button is used
|
|
|
|
for pasting text. Default is 0, turned off.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
2008-05-15 11:03:53 +02:00
|
|
|
</varlistentry>
|
2006-11-06 11:14:58 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>respect_flowed_format</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
0 or 1. Respect format=flowed on text/plain message parts. This
|
|
|
|
will cause some mails to have long lines, but will fix some URLs
|
|
|
|
that would otherwise be wrapped. Default is 0, turned off.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2007-11-07 18:26:29 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>save_parts_readwrite</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Saves temporary files when opening attachment with write bit set.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>skip_ssl_cert_check</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Disables the verification of SSL certificates.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>statusbar_update_step</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Update stepping in progress bars.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-09-14 10:42:08 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>stripes_color_offset</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specify the value to use when creating alternately coloured lines in
|
|
|
|
GtkTreeView components. The smaller the value, the less visible the
|
|
|
|
difference in the alternating colours of the lines.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>textview_cursor_visible</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Display the cursor in the message view.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>thread_by_subject_max_age</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Number of days to include a message in a thread when using
|
|
|
|
<quote>Thread using subject in addition to standard headers</quote>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>toolbar_detachable</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-01 12:24:49 +02:00
|
|
|
Show handles in the toolbars.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2008-04-23 08:00:41 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>two_line_vertical</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Spread message list information over two lines when using the
|
|
|
|
three column layout.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-12-09 23:02:32 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>unsafe_ssl_certs</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Allows Claws to remember multiple SSL certificates for a given
|
|
|
|
server/port. This is disabled by default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2008-02-18 18:41:40 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>use_networkmanager</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Use NetworkManager to switch offline automatically. This is enabled
|
|
|
|
by default.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-09-14 10:42:08 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>use_stripes_everywhere</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enable alternately coloured lines in GtkTreeView components.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>use_stripes_in_summaries</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enable alternately coloured lines in the main window GtkTreeView
|
|
|
|
components, (Folder List and Message List). The only useful way to
|
|
|
|
use this option is to set it to 0 when use_stripes_everywhere is set
|
|
|
|
to 1.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2006-08-24 06:52:01 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><literal>utf8_instead_of_locale_for_broken_mail</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Use UTF-8 encoding for broken mails instead of current locale.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>warn_dnd</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2006-09-03 08:50:41 +02:00
|
|
|
Display a confirmation dialogue on drag 'n' drop of folders.
|
2006-08-24 06:52:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2005-11-20 10:41:20 +01:00
|
|
|
</variablelist>
|
2005-10-24 12:09:38 +02:00
|
|
|
</section>
|
2008-06-20 13:13:30 +02:00
|
|
|
<section id="adv_autofaces">
|
|
|
|
<title>Autofaces</title>
|
|
|
|
<para>
|
|
|
|
Claws Mail allows setting the Face and X-Face headers directly
|
|
|
|
from files, either globally for all defined accounts
|
|
|
|
or on a per-account basis. These files must be placed in the
|
|
|
|
<filename>~/.claws-mail/autofaces/</filename> directory.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
If they exist, the global Face and/or X-Face headers for all
|
|
|
|
accounts are taken from the <filename>face</filename> and/or
|
|
|
|
<filename>xface</filename> files respectively. In a similar
|
|
|
|
manner, Face and/or X-Face headers for a specific account can
|
2008-06-21 09:05:09 +02:00
|
|
|
be provided by <filename>face.</filename><emphasis>accountname</emphasis>
|
|
|
|
and/or <filename>xface.</filename><emphasis>accountname</emphasis>,
|
2008-06-20 13:13:30 +02:00
|
|
|
where <emphasis>accountname</emphasis> is the name of the account you
|
|
|
|
want this header to be associated with.
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
If the name of the account contains characters which may be unsuitable
|
|
|
|
for the underlying filesystem (including spaces) these are replaced by
|
|
|
|
underscores (<quote>_</quote>) when searching for the autofaces of
|
|
|
|
that account. For example, if your account is called
|
|
|
|
<quote><My Mail></quote>, the name for the X-Face filename for
|
|
|
|
that account would be
|
|
|
|
<filename>~/.claws-mail/autofaces/xface._My_Mail_</filename>.
|
|
|
|
Be aware that this feature doesn't check the content of the files,
|
|
|
|
or for duplication of headers, (most mailers, including Claws
|
|
|
|
Mail, will ignore duplicates and display the last one only).
|
|
|
|
</para>
|
|
|
|
</section>
|
2005-10-24 12:09:38 +02:00
|
|
|
</section>
|
2006-08-24 06:52:01 +02:00
|
|
|
|