1079 lines
37 KiB
XML
1079 lines
37 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<section id="ch_advanced">
|
|
<title>Advanced features</title>
|
|
<section id="adv_actions">
|
|
<title>Actions</title>
|
|
<para>
|
|
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
|
|
imagination. You can create and configure Actions via the
|
|
<quote>/Configuration/Actions...</quote> menu.
|
|
</para>
|
|
<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
|
|
actions. To do so, open the <quote>Configuration/Preferences</quote>
|
|
menu and select <quote>Toolbars/Main Window</quote>.
|
|
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.
|
|
</para>
|
|
<blockquote>
|
|
<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
|
|
url="http://www.claws-mail.org/tools.php"
|
|
>google_search.pl</ulink></emphasis>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</example>
|
|
</blockquote>
|
|
</section>
|
|
<section id="adv_templates">
|
|
<title>Templates</title>
|
|
<para>
|
|
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
|
|
user-contributed FAQ on the Claws Mail website <ulink
|
|
url="http://www.claws-mail.org/faq/"
|
|
>http://www.claws-mail.org/faq/</ulink>.
|
|
</para>
|
|
</section>
|
|
<section id="adv_processing">
|
|
<title>Processing</title>
|
|
<para>
|
|
Processing rules are the same as Filtering rules, except that they are
|
|
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.
|
|
</para><para>
|
|
Processing rules are accompanied by Pre-processing and Post-processing
|
|
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.
|
|
</para>
|
|
</section>
|
|
<section id="adv_colour_labels">
|
|
<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>
|
|
</section>
|
|
<section id="adv_tags">
|
|
<title>Tags</title>
|
|
<para>
|
|
Tags are short text notes which may be set on messages. They are useful
|
|
for classifying messages with your own words. These tags can be used
|
|
later to find the mails with Quick Search or to manage them with
|
|
filtering or processing rules, for example.
|
|
</para><para>
|
|
Tagged messages are displayed with a yellow background at the top of
|
|
the Message View. This line shows all tags associated with the
|
|
message. You can enable the "Tags" column in the Message List, so
|
|
tagged items can be seen without having to open the message.
|
|
</para><para>
|
|
Setting of tags is done by right-clicking on the message in the Message
|
|
List or by the corresponding option in Message menu. A panel with the
|
|
existing tags is shown and you can select some of them or just add a
|
|
new one. Removal of existing tags is also allowed, of course.
|
|
</para><para>
|
|
Once tags exist it's even easier, as the context menu allows you to
|
|
set and unset tags with just one click to the selected messages.
|
|
Mixed selections of tagged and untagged messages are allowed, and
|
|
Claws Mail is clever enough to do what you want to do in any case.
|
|
</para>
|
|
</section>
|
|
<section id="adv_ml_support">
|
|
<title>Mailing-List support</title>
|
|
<para>
|
|
Claws Mail offers mailing-list support from the
|
|
<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>
|
|
</section>
|
|
<section id="adv_plugins">
|
|
<title>Plugins</title>
|
|
<para>
|
|
Plugins are the mechanism for extending Claws Mail' capabilities.
|
|
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
|
|
Claws Mail you can simply write a plugin to achieve the task.
|
|
</para><para>
|
|
This is just an example of the possibilities. A good number of plugins
|
|
developed for Claws Mail already exist, and more are to come. The
|
|
<link linkend="ch_plugins">Extending Claws Mail section</link>
|
|
gives details of them.
|
|
</para>
|
|
</section>
|
|
<section id="deploying">
|
|
<title>Deploying Claws Mail</title>
|
|
<para>
|
|
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
|
|
designed to allow system administrators to deploy Claws Mail easily
|
|
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
|
|
and setting the various default parameters of a new Claws Mail
|
|
installation.
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
Start with a user who does not have a <filename class="directory"
|
|
>~/.claws-mail</filename> directory, ideally a new user.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Start Claws Mail and go through the wizard. The values you fill in
|
|
will be of no use for the future deployment, so you can click
|
|
next-next-next.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Once the wizard is finished and you have Claws Mail' main window
|
|
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>
|
|
If needed, and if the deployed Claws Mail will use MH folders, you
|
|
can create subdirectories in the mailbox.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Next, quit Claws Mail.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Now, edit the newly created wizard template file,
|
|
<filename>~/.claws-mail/accountrc.tmpl</filename>. In this file,
|
|
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
|
|
<filename>~/.claws-mail/accountrc</filename>, (which contains your
|
|
dummy account) and
|
|
<filename>~/.claws-mail/folderlist.xml</filename>, (so that the
|
|
folder tree will be correctly parsed for new users). Recursively copy
|
|
<filename class="directory">.claws-mail</filename> to
|
|
<filename class="directory">/etc/skel/</filename>; if the deployed
|
|
Claws Mail will use MH folders, also copy the created
|
|
<filename class="directory">Mail</filename> directory. chown all of
|
|
<filename class="directory">/etc/skel/.claws-mail</filename>
|
|
and <filename class="directory">/etc/skel/Mail</filename> to
|
|
<literal>root:root</literal> for security reasons.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Test! Create a new user, login as that user, run Claws Mail. If you
|
|
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>
|
|
</itemizedlist>
|
|
<para>
|
|
Here are the different variables of the <filename>accountrc.tmpl</filename>
|
|
file:
|
|
</para>
|
|
<variablelist>
|
|
<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>
|
|
</variablelist>
|
|
<para>
|
|
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:
|
|
</para>
|
|
<variablelist>
|
|
<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>
|
|
</variablelist>
|
|
<para>
|
|
Be sure not to use a variable before defining it.
|
|
</para>
|
|
</section>
|
|
<section id="adv_hidden">
|
|
<title>Hidden preferences</title>
|
|
<para>
|
|
There are a number of hidden preferences in Claws Mail, preferences
|
|
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
|
|
following, and change them while Claws Mail is not running, in
|
|
<filename>~/.claws-mail/clawsrc</filename>.
|
|
</para>
|
|
<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.php">Clawsker page</ulink>.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>address_search_wildcard</literal></term>
|
|
<listitem>
|
|
<para>
|
|
TAB-address completion in the Compose window and other GUI places will
|
|
match any part of the string ('1') or just the start of the string ('0').
|
|
Default value is '1'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>addressbook_use_editaddress_dialog</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Use a separate dialogue to edit a person's details if set to '1'
|
|
(default). '0' will use a form embedded in the addressbook's main
|
|
window.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>bold_unread</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Show unread messages in the message list of summary view using a
|
|
bold font when set to '1' (default). '0' will use normal font.
|
|
</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. It will
|
|
try to keep the memory usage below this value, but it will always use
|
|
the assigned amount of memory for speed gain. Default value is '4096'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>cache_min_keep_time</literal></term>
|
|
<listitem>
|
|
<para>
|
|
The minimum time in minutes to keep a folder cache in memory. Caches
|
|
more recent than this time will not be freed, even if the memory usage
|
|
is too high. You should probably set this value higher than your
|
|
mail check interval. Otherwise the cache will always be freed between
|
|
checks even if the folder is accessed on every check, which will cause
|
|
much disk I/O. Default value is '15'.
|
|
</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
|
|
if set to '1'. Default value is '0' (use markup).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>default_header_color</literal></term>
|
|
<term><literal>default_header_bgcolor</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Foreground and background colors to use for the Compose window's header
|
|
entry values. Default values are '#000000' (black) and '#f5f6be' (pale
|
|
yellow), respectively.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>diff_added_color</literal></term>
|
|
<term><literal>diff_deleted_color</literal></term>
|
|
<term><literal>diff_hunk_color</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Colors to use when displaying attachments in unified diff format.
|
|
Default values are '#008b8b' (dark cyan), '#6a5acd' (slate blue) and
|
|
'#a52a2a' (red brown) respectively.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>emphasis_color</literal></term>
|
|
<listitem>
|
|
<para>
|
|
The colour used for the X-Mailer line in Message View when its value
|
|
is Claws Mail. Default value is '#0000CF' (medium blue).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>enable_avatars</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Enables capture and/or rendering of internal avatars (Face and
|
|
also X-Face headers if built with compface support).
|
|
'0' disables both, '1' enables capture only, '2' enables rendering
|
|
only and '3' enables both. Default value is '3'.
|
|
</para>
|
|
<para>
|
|
Note that external plugins already providing these features may
|
|
disable partially or completely this to speed up process,
|
|
regardless of the configured value.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>enable_hscrollbar</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Enable the horizontal scrollbar in the message list of Summary View
|
|
if set to '1' (default). Set it to '0' to disable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>enable_swap_from</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Display the sender's email address in the To column of the
|
|
Sent folder instead of the recipient's when set to '1'.
|
|
Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>folder_search_wildcard</literal></term>
|
|
<listitem>
|
|
<para>
|
|
The type-ahead function in the Select Folder window will match any
|
|
part of the folder name ('1') or just the start of the folder
|
|
name ('0'). Default value is '1'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>folderview_vscrollbar_policy</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the policy of vertical scrollbar of Folder List:
|
|
'0' is always shown, '1' is automatic and '2' is always hidden.
|
|
Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>hide_timezone</literal></term>
|
|
<listitem>
|
|
<para>
|
|
If enabled ('1') the timezone in date headers is set to the
|
|
unknown timezone value, as specified in section 3 of the RFC
|
|
5322. Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>hover_timeout</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Time in milliseconds that will cause a folder tree to expand
|
|
when the mouse cursor is held over it during drag 'n' drop.
|
|
Default value is '500'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>live_dangerously</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Don't ask for confirmation before definitive deletion of emails when
|
|
set to '1'. Default value is '0'.
|
|
</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>
|
|
<term><literal>log_status_ok_color</literal></term>
|
|
<term><literal>log_status_nok_color</literal></term>
|
|
<term><literal>log_status_skip_color</literal></term>
|
|
<listitem>
|
|
<para>
|
|
The colours used in the log window. Default values are: '#af0000'
|
|
(dark red), '#000000' (black), '#00af00' (dark lime green),
|
|
'#0000ef' (blue), '#af0000' (dark red), '#00af00' (dark lime green),
|
|
'#0000af' (dark blue) and '#aa00aa' (dark magenta) respectively.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>master_passphrase_pbkdf2_rounds</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Number of rounds (or iterations) to use in PBKDF2 function when
|
|
computing next master passphrase key derivation. Currently stored master
|
|
passphrase KD is not affected by changing this preference.
|
|
Default value is '50000'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>msgview_date_format</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. Use the same user-defined date format in the Message
|
|
View as is used in the Message List. Default is '0', turned off.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>next_on_delete</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. Controls the message selection after deleting, moving, or
|
|
trashing a message. Default is '0', select previous message.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<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
|
|
<quote>Outgoing encoding</quote> option unless it is necessary. Turning
|
|
this option off forces the user-defined encoding to be used, regardless
|
|
of message content. Default is '1', turned on.
|
|
</para>
|
|
</listitem>
|
|
</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>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>qs_active_color</literal></term>
|
|
<term><literal>qs_active_bgcolor</literal></term>
|
|
<term><literal>qs_error_color</literal></term>
|
|
<term><literal>qs_error_bgcolor</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Foreground and background colors to use in the QuickSearch field when
|
|
the search is active and when there is a syntax error.
|
|
Default values are '#000000' (black), '#f5f6be' (pale yellow), '#000000'
|
|
(black), and '#ff7070' (pale red), respectively.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>respect_flowed_format</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. Respect <literal>format=flowed</literal> on
|
|
<literal>text/plain</literal> 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>
|
|
<varlistentry>
|
|
<term><literal>rewrite_first_from</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. This works around a limitation of some servers with
|
|
'overly-liberal parsers'. When this is turned on and the Content-
|
|
Transfer-Encoding is set to 8bit or 7bit, in a message body starting with
|
|
'From ' the 'From ' will become '=46rom ' and the Content-Transfer-Encoding
|
|
will be changed to Quoted-Printable. When it is turned off no such modification
|
|
will be made but it is very likely that an MTA will convert the 'From ' to
|
|
'>From '. See RFC 4155 for further details. Default value is '1', turned on.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>save_parts_readwrite</literal></term>
|
|
<listitem>
|
|
<para>
|
|
If set to '1' saves temporary files when opening attachments with
|
|
write bit set. Default value is '0', temporary files are read only.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>show_compose_margin</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. Adds margins to the message text area in the Compose window.
|
|
Default is '0', turned off.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>show_inline_attachments</literal></term>
|
|
<listitem>
|
|
<para>
|
|
'0' or '1'. Show inline attachments in MimeView.
|
|
Default is '1', turned on.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>skip_ssl_cert_check</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Disables the verification of SSL certificates when set to '1'.
|
|
Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>statusbar_update_step</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Update stepping in progress bars. Default value is '10'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>stripes_color_offset</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Specify the value to use when creating alternately coloured lines in
|
|
<literal>GtkTreeView</literal> components. The smaller the value, the
|
|
less visible the difference in the alternating colours of the lines.
|
|
Default value is '4000'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>summary_from_show</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Controls the data displayed in the From column in the Message List.
|
|
Default value '0' displays name, '1' displays address and '2' displays
|
|
both name and address.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>tags_color</literal></term>
|
|
<term><literal>tags_bgcolor</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Foreground and background colors to use when displaying tags.
|
|
Default values are '#000000' (black) and '#f5f6be' (pale yellow),
|
|
respectively.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>textview_cursor_visible</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Display the cursor in the message view when set to '1'.
|
|
Default value is '0'.
|
|
</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>.
|
|
Default value is '10'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>toolbar_detachable</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Show handles in the toolbars when set to '1'. Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>type_any_header</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Allows to type any header on the compose window header entries
|
|
when set to '1'. By default ('0') only the entries available
|
|
from the combobox can be selected.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>two_line_vertical</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Spread message list information over two lines when using the
|
|
three column layout when set to '1' (default). Set it to '0'
|
|
to use only one line.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>unsafe_ssl_certs</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Allows Claws Mail to remember multiple SSL certificates for a given
|
|
server/port when set to '1'. This is disabled by default ('0').
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>use_networkmanager</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Use NetworkManager to switch offline automatically. This is enabled
|
|
by default ('1'). Set it to '0' to ignore NetworkManager.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>use_stripes_everywhere</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Enable alternately coloured lines in <literal>GtkTreeView</literal>
|
|
components when set to '1' (default). Set it to '0' to disable them.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>use_stripes_in_summaries</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Enable alternately coloured lines in the main window
|
|
<literal>GtkTreeView</literal> components, (Folder List and Message
|
|
List). The only useful way to use this option is to set it to '0'
|
|
when <literal>use_stripes_everywhere</literal> is set to '1'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<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 when
|
|
set to '1'. Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>warn_dnd</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Display a confirmation dialogue on drag 'n' drop of folders when set
|
|
to '1' (default). Set to '0' to bypass this confirmation.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>warn_sending_many_recipients_num</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Display a confirmation dialogue when sending a message to a number
|
|
of recipients larger than the value of this preference. Set to '0'
|
|
to bypass this confirmation.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>zero_replacement_char</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Character to show in Folder List counter columns when a folder contains
|
|
no messages. Default value is '0'.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<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
|
|
be provided by <filename>face.</filename><emphasis>accountname</emphasis>
|
|
and/or <filename>xface.</filename><emphasis>accountname</emphasis>,
|
|
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>
|
|
</section>
|
|
|