Mithril "Fixup" Configuration

The Mithril POP and IMAP proxy configuration files should each contain a section marked "fixup" which indicates options for outgoing message markup. This markup includes message decryption and signature verification; also, an additional message part is included explaining the actions in text, html, and machine readable format.

Interpreted Options

Some options in this section are "interpreted." This means that variables inside them are expanded from a dictionary. A variable expansion is indicated by a dollar sign ('$') followed by the variable name, which consists of alphanumeric characters and underscore ('_'). The end of the variable name is indicated either by a non-valid character or by wrapping the name in curly braces ('{' and '}'). Example:

The variable "user" can be expanded by $user. 
If backed against valid characters, such as "foo", the 
form ${user}foo can be used.

The following variables are defined for the interpreted options:

$user
The login name of the user viewing the message.
$folder
The folder in which the message is held.
$msglink
A URL pointing to more detailed information on the message.
$msgid
The RFC822 Message-ID of the viewed message.

Available Options

The following keys may be found in the "fixup" sections of the IMAP and POP proxy configuration files:

S/MIME signing
This key indicates that the decryption/verification information should be included as a signed S/MIME message. A value of 1 indicates that it should be signed, zero indicates that it should not. Default: 0
NOTE: If S/MIME initialization fails (missing key, certificate, etc), the proxy will continue to function with this option turned off.
S/MIME cert
This key specifies a file containing the certificate which will be used in the S/MIME message. This key has no effect if S/MIME signing is turned off. Default: none
S/MIME key
This key specifies a file containing the key which will be used in the S/MIME message. If this option is not present, the contents of the "S/MIME cert" key will be used. This key has no effect if S/MIME signing is turned off. Default: none
S/MIME from
This key indicates the "From" address to be used in the S/MIME signed message. If this option is not present, the address will be deduced from the certificate used. This key has no effect if S/MIME signing is turned off. Default: none
header text
This key specifies the header to the markup description that is suitable for use in a text/plain MIME part. The value of this key will be interpreted. Note that use of the CRLF convention is not required; carriage returns will be added if not present. Default:
The following is a summary of the encryption services provided
for this message.  For further details, please visit:
$msglink
header html
This key specifies the header to the markup description that is suitable for use in a text/html MIME part. The value of this key will be interpreted. Note that use of the CRLF convention is not required; carriage returns will be added if not present. Default:
<p>The following is a summary of the encryption services provided 
for this message. For further details, please click
<A HREF="$msglink">here</A>.
empty text
This key specifies the markup description which will be used when no markup description is available (i.e., no actions were performed). It should be suitable for use in a text/plain MIME part. The value of this key will be interpreted. Note that use of the CRLF convention is not required; carriage returns will be added if not present. Default:
Warning! This message was neither signed nor encrypted. It may
have been read in transit by unauthorized parties, and there is
no guarantee of the sender's actual identity.
empty html
This key specifies the markup description which will be used when no markup description is available (i.e., no actions were performed). It should be suitable for use in a text/html MIME part. The value of this key will be interpreted. Note that use of the CRLF convention is not required; carriage returns will be added if not present. Default:
<h1><font color="#ff0000">Warning!</font></h1>
<p>This message was neither signed nor encrypted. It may
have been read in transit by unauthorized parties, and there is
no guarantee of the sender's actual identity.
message URL
This key specifies a URL at which more information about the cryptographic information can be found. It is used if the message contains an RFC822 Message-ID field (to uniquely identify the message at the destination link). The URL must take parameters in the following form: url/user/folder/message-id where user, folder, and message-id are filled in for the message. Default: http://localhost
login url
This key specifies a URL at which more information about the cryptographic information can be found. It is used if the message does not contain a Message-ID field (the user will be forced to login and view the message him/herself). Default: http://localhost
cryptdesc
This key specifies text to be used as a MIME Content-Description field and as the subject of the RFC822 message (if S/MIME signing is being used) that holds the cryptographic operations. Default: Cryptographic Operations
cryptdesc text
This key specifies text to be used as a MIME Content-Description field of the text version of the cryptographic operations. Default: Cryptographic Operations (TEXT)
cryptdesc html
This key specifies text to be used as a MIME Content-Description field of the HTML version of the cryptographic operations. Default: Cryptographic Operations (HTML)
This key specifies text to be used as a MIME Content-Description field of the Machine Readable version of the cryptographic operations. Default: Cryptographic Operations (Machine Readable)