A single XML initialization file that is loaded at startup controls Saké Mail. The initialization file is called "mail.ini", and it is located in the "config" directory of your Saké installation, so if you have a Windows machine with a Saké installation in "c:\sake", your configuration file will be located in "c:\sake\config\mail.ini". The Saké framework in general is also configured using another file called "general.ini" that sits next to the "mail.ini" file in the "config" directory. Configuration of the "general.ini" file is covered in the "Configuration" section of the Saké Administrator's Manual.

The initialization file consists of a number of entries that set certain properties at runtime. Each entry is structured as an XML tag as follows:

In order to modify a value, simply modify the contents of the "value" tag, the same way that you would edit an HTML tag. For example, to set the parameter "sake.mail.somesetting" to "12", simply change the above line to read:

Many settings are general Saké settings that can be configured in "mail.ini" to provide per-application control over settings. Any setting of the form "sake.somesetting", rather than "sake.mail.somesetting" is a general Saké setting. A list of general Saké settings and descriptions of their functions can be found here. A list of settings and descriptions of the entries that apply specifically to Saké Mail follows. Note that in addition to these simple settings, the "mail.ini" file also contains the configuration parameters for the extension beans that your Saké Mail application uses. More information on the extension bean mechanism can be found in the general Saké extension document, and information on the specific beans used in Saké Mail can be found in the Saké Mail extension document.

sake.mail.incomingserver
The name of the default incoming server. This option will force this installation to always use this server, and the user will not be presented with an option to specify the name of the server. This value takes precedence over the "sake.mail.incomingserverdefault" option.

sake.mail.incomingserverdefault
The name of the default incoming server. This option will be used as a default in the "Server" box on the login page, but setting it will not prevent users from changing the name of the server to anything that they like. In order to force users to use a particular server, you will need to use the "sake.mail.incomingserver" option. To set a default server, fill in the "value" field below.

sake.mail.smtpserver
The name of the default incoming server. This option will force this installation to always use this server, and the user will not be presented with an option to specify the name of the server. This value takes precedence over the "sake.mail.smtpserverdefault" option.

sake.mail.smtpserverdefault
The name of the default SMTP server. This option will be used as a default in the "SMTP Server" box on the message compose form, but setting it will not prevent users from changing the name of the server to anything that they like. In order to force users to use a particular server, you will need to use the "sake.mail.smtpserver" option.To set a default server, fill in the "value" field below.

sake.mail.allowfromaddress
Allow "From" address modification. If this line is set to "true", then users will have an extra line in their personal options page (t_options_personal) that will allow them to specify their email address. This address will be used in the "From" line in outbound mail. Most sites will not want to allow users to modify this line. If you do not allow your users to modify their "From" lines, then each user's email address will be generated automatically, based on the snippet "FROM_ADDRESS_DEFINITION" in the template "t_options_personal". If you have a particular format that you want for your addresses, modify the template.

sake.mail.domainstripmode
This is used to strip the specific machine name off of an address when generating outbound email addresses if sake.mail.allowfromaddress is set to "false". For instance, if a user logs in as the user "me" to the server "mail.mycompany.com", then the outbound address generated by default (if the definition snippet is not changed) will be "me@mail.mycompany.com". If you set this value to "smart", then it will strip the "mail" machine name from the above address, resulting in "me@mycompany.com". When set to "smart", Sake Mail will only trim machine names that look like they are problably the names of mail servers, such as "pop3", "pop", "imap", "mail", and "smtp". If you set this value to "always", then it will simply always strip the machine name from the outbound address. If you don't want this feature enabled at all, set this value to "off".

sake.mail.allowreplyaddress
This is similar to "sake.mail.allowfromaddress", but it controls the ability of users to modify their reply address. Most sites will want to allows users to specify any address that they like as a reply address, which will be added as an extra "Reply-to" header line in outbound messages, when present.

sake.mail.storeprotocol
Use this option to rig the incoming mail access method. If you set this option, then there will be no radio boxes for your users to select an access protocol. If you want to set a default, but leave the option open for your users to select a protocol, then edit the t_nf_login and t_f_login templates, and reposition the "checked" option, which sets the default option.

If you leave this value blank or comment out this option entirely, then the user will be presented with an option for how they would like to access their mail server. If you set this option, then you can choose from the following:

imap		Use IMAP to access the user's mail.
imapnofolders		Use IMAP with a server that does not support folder creation.
pop3		Use straight POP3, only one "INBOX" folder.
pop3local		Use POP3 with local storage.

sake.mail.localquota
The maximum disk quota per user. Only used for the pop3 with local storage option. User accounts may occasionally exceed this quota by a small amount, since there is no way to determine the exact size of a given message before it is actually downloaded from a POP3 server. Sake Mail handles this by downloading the message first and then checking quota. If a message pushes the user over quota then Sake Mail will not download any new messages. Quotas are specified in megabytes. Specifying a blank quota will shut the quota management feature off entirely and user accounts will be limited in size only by available disk space. Fractional values, such as "2.5" are allowed, if you think that you need that much precision.

sake.mail.linewrapwidth
The width that lines will be wrapped to in output.Sometimes careless people will send messages in plain text with the entire contents of the message on one line. We can't stop people from being rude, so Sake Mail will wrap lines in plain-text message parts as a last-ditch effort to make messages readable. The idea is to only wrap lines if they really, really need it. Set this to something wider than you would normally expect people to format messages, so that you won't end up accidentally wrapping lines that shouldn't be wrapped. This value defaults to 90.

sake.mail.multipartsize
The maximum size allowed for multipart form submissions. This specifically applies to Sake Mail when users are trying to upload message attachments. This value is in bytes.

sake.mail.outbox
sake.mail.draftbox
sake.mail.trashbox
The names of the folders to use. Setting the names of the trash and sent boxes will change the actual physical folders that are used for those functions. The display names, that is, the names of the folders as they are actually displayed to the user at runtime, are configured in the template "t_folders" as snippets. This is so that the display names can be changed from template set to template set.

IMAP options. If either of the following two options is set, then the "Mail Server" options page will not be available to IMAP users, so that these values will override user settings. Normally the user is allowed to configure these settings as options, since different users might connect to different IMAP servers that have different requirements. You should only set these if you have an installation of Sake Mail that is associated with a single specific IMAP server and you want to configure how the server is accessed.

sake.mail.folderprefix
The first item is the prefix used when accessing folders on IMAP servers. This option helps when using the Cyrus IMAP server, which uses a prefix "INBOX".

sake.mail.subscribedonly
The second option specifies whether to only display folders that are listed as "subscribed". This option helps when using the UW IMAP server, which will display all files in given root directory, rather than just mail folders, unless you have this option set. This option defaults to "false".

sake.mail.localfolders
Local folder support. Use this to disable local folder storage for "pop3" and "imapnofolders" modes. Normally, these modes will simulate the existence of the system folders, Trash, Sent Items, and Drafts, by creating local folders on the file system of the HTTP server. In some cases, this is not the desired behavior. Setting this option to "false" will inhibit messages from being stored in any of these folders when sending messages, deleting messages, or saving message drafts. This flag will automatically disable folder operations in message lists, but will otherwise have no effect on the user interface. If you set up an installation that uses either "pop3" or "imapnofolders" modes exclusively and you have this option set to "false", then you should be sure to manually remove the "Folders" item from your left-hand menus, and remove the "Save" button from your "t_compose" template.

sake.mail.addressdirectories
Which address directories to use. This value should be set to "private", "public", or "both", depending on whether you want users to have a private directory available in the "Addresses" option, a public directory, or both. If you specify "private" or "both", then you must have a backend bean of the type "sake.mail.addresses" configured. If you specify "public" or "both", then you must have a backend bean of the type "sake.mail.publicaddresses" configured. The default value for this is "private". Normally if you are using "public" or "both" then you will configure the LDAP backend bean for "sake.mail.publicaddresses" and connect it to an LDAP server containing a global address book.

sake.mail.options.*
These are the options that are used as the defaults when a new user logs in that has no options configured. If you would like to force any option to a given value for all users, rather than simply setting a default, then set the option in the "sake.mail.force.options" name space. For instance, if you set "sake.mail.force.options.messagesperpage" to "20", then all users will have the option forced to 20, no matter what they configure in their options. We suggest that you remove forced option from your user inteface entirely, to avoid confusing users.

sake.mail.options.messagesperpage
The number of messages to display on one page.

sake.mail.options.sortstyle
The default sorting style. Pick from:

date		sort in forward date order
dateback		sort in backward date order
subject		sort in subject order
subjectback		sort subjects backwards
from		sort on the From line
fromback		sort backwards on the From line
size		sort on the message size
sizeback		sort on the message size, backwards

 

sake.mail.options.deletedownload
Whether or not to delete mail from the server as it is downloaded. Only used for the pop3local protocol.

 

sake.mail.options.deleteproxy
Whether or not to proxy deletes through to the server when using the 'pop3local' protocol. If this is set to "true" then messages that are deleted from the local folders will also be deleted from the server, if they still exist on the server.

 

sake.mail.options.quotemessages
Whether or not to quote messages when replying and forwarding.

 

sake.mail.options.quoteprefix
The default prefix to use when quoting messages.

 

sake.mail.options.saveoutgoing
Whether or not to save outgoing messages.

 

sake.mail.options.savedeleted
Whether or not to save deleted messages.