MailFaces - Option File Syntax

MailFaces currently reads all it's runtime options from a file that is specified at startup. By default, this file is named faces.opt.

There is a dialog built into MailFaces to modify this file. Use Options -> Edit Options to bring up a very simple editor or you can use your favorite text editor in another window. After saving the modified file, you can use the Options -> Refresh Options button to have MailFaces reread the Options file and use the new Options for subsequent processing.

The File -> Reset can also be used to restart processing with the new options.

File Syntax

Comments

The options file can have comments anywhere in the file. The comments can either C++ style comments such as:
   // Comment that extends to the end of the line
or old C style comments such as:
   /* This comment starts with "/*";
  it can extend over multiple lines
  and it ends with */

Keywords

The first string on the line is the Option keyword. The case of the keyword is unimportant but, of course, it has to be spelled correctly.

Value

The 2nd string on the line is the value that the keyword is to be set to. If the value contains blanks or non alphanumeric characters, it should be enclosed in quotes ("). Most keyword only have one value and all values are concatenated together to make one value. The following keywords are exceptions and have multiple values all included on the same line. (Select, SelectAfter, KillSelect, MailServer)

Examples

Sample Icons

Some sample icons are distributed for use with MailFaces. Some of these are used in the distributed faces.opt file.

Options - Index

Option Syntax

AudioSupport
Specifies whether Audio sounds are to be supported. Specified as "true" or "false".

CacheDirectory
Turns on image caching and specifies the directory where the Cache will be maintained. This can be either a relative filename like "cache" or an absolute name like "c:\\mailfaces\\cache". Note that Window users must use "\\" to specify the "\" path separator.

CacheExpire
Specifies the number of days since being last used, before being eligible for deletion from the Cache. If the Options--Cache Expire option is selected from the Menubar, any cache entry that has not been used in this number of days, will be deleted.

Debug
Specifies whether Debug output is to be produced. Specified as "true" or "false".

DebugFile
Specifies the file name where Debug output should be written. This can be either a relative filename like "debug.log" or an absolute name like "c:\\log\\mailfaces.log". Note that Window users must use "\\" to specify the "\" path separator.

DefaultAudioURL
Specifies the URL location of the ".au" audio file that will be used for all mail that does not have a more specific Audio file specified in the "Select" statement.

DefaultImageURL
Specifies the URL location of the image that will be used for all Mail that cannot be identified by a Select statement or by the PIcon DataBase search.

BuildImageURL
Specifies the URL location of a background image used when neither the SelectList or PIcon database gets a match. Instead of using the DefaultImageURL, we will build a special unique image from a background image and the From header

DelayTime
Specifies the time (in seconds) to delay before checking the Mail server for more mail.

DelayTimeLong
Specifies a longer time (in seconds) to delay before checking the Mail server for more mail. This longer delay time can be selected at run time from the Options menu. It is designed for users that have dial-up attachments to the MailServer for times when you don't want to keep the connection active.

HelpURL
Specifies the URL for the MailFaces Help information.

Include
Specifies a filename for a nested Option file. The Options will be read from the Included file and then the rest of the options will be read from the current file. Files can be nested to any depth.

Log
If specified as "true" than a Log file will be written for important events that occur while running MailFaces.

LogFile
Specifies a filename for the Log file. The default is "faces.log" in the current directly.

KillImageURL
Specifies the URL for used for any mail that matches a KillSelect Statement.

KillSelect
Specifies the criteria for a mail message being considered a "Kill" candidate. Unsolicited e-mail is becoming more of a problem for many users. The MailFaces support for Kill files is intended to help isolate potential "Junk e-mail" so that it can be deleted at the server without the wasted time and effort to download it and read it with your mail client.

In conjunction with the Include statement, it will be possible to have a common "Kill File" for known producers of "Junk e-mail"

The KillSelect parameter has multiple parameters all of which must be included on the same line. There also can be multiple KillSelect statements. See the Select statement for additional information. The parameters of the KillSelect statement are:

Header name
The name of the Mail Header field that will be used for selection. (e.g. "reply-to"
Match Expression
The match expresion can be a quoted string that is matched against the lower case Header field. For example, the following will match if the mail header contains the string slip.net:
  KillSelect from	"slip.net" 
Or it can be a Regular Expression. A Regular expression is specified by preceeding the expresion with "RE". For Example:
  KillSelect from	RE ".*@.*slip\\.net" 
If the match string or Regular Expression matches the contents of the Header field, then this Select statement will be considered a Kill candidate.

Much of the SPAM that one gets can be identified by the fact that it is not addressed directly to the user. In other words, the users email address is not in the "to:" or "cc:" headers. So there is a special syntax for identifing mail that is not addressed to a specified email address.
  KillSelect notto  "me@mysystem.com" 
However you should note that in addition to being the case for most SPAM, this is also true of most email that is being sent because you are on a mailing list and also for email where you are on the "bcc" list (Blind Carbon Copy). So you should be sure if you use this that any mailing list that you are on have specific Select statements earlier in the Options file. If you are likely to be on the bcc: list for email, then you want to be sure to have Select statements for the "from" address. For example: in my case, most of the bcc: mail that I get is from people that I work with so I have a Select statement for the company mail address.

Image URL
This optionally specifies the image that will be used to to represent this mail message. If not specified, the KillImageURL statement will be used.
Optional keyword "AutoDelete"
If this is specified then e-mail will automatically be deleted from the server (With no warning, so be sure your Regular Experession is correct!)

MailServer
Specify the Login information for the Mail Server. You can have multiple MailServer statements. The format is:
  MailServer type hostname username password
where:

NamedSelect

NoMailURL
Specifies the URL of the image that will be displayed when there is no mail in the Mailbox.
Example
NoMailURL "file:/c:/mailfaces/images/nomail.gif"

PIconDBDomainOnly
If specified as "true", then only the Domain name will be looked up in the PIconDB Database. In conjunction with the Cache feature, this will result in much better performance because the Domain image file will often be found in your cache. If specified as "false", then the user@domainname will be looked up in the cache, and if not found then the user@domainname will be looked up in the PIconDB Database and if still not found then the domain name will be looked up in the PIconDB database. The default is true

PIconDB
Specifies the PIcon Database access information. If you want to search more than one database, you would use multiplePIconDBstatements. The format is:
  PIconDB url dbnames [PROXY ProxyHost ProxyPort]
where:

Example of single database, using PIconDBDomainOnly

  PIconDB   "http://www.cs.indiana.edu:800/piconsearch" "users+domains"
  PIconDBDomainOnly true

Example of multiple databases, with Proxy and without PIconDBDomainOnly

  PIconDB "http://dilbert.com/cgi-bin/piconsearch" "users"
  PIconDB "http://www.cs.indiana.edu:800/piconsearch" "users+domains" PROXY gateway.dilbert.com  8000
  PIconDBDomainOnly false

PIconDefer
PIconDefer statements are used to defer the use of PiconDB icons until after it checks the SelectAfter statements for more specific icons

PIconIgnore
PIconIgnore statements are used to ignore specific PiconDB icons

Select

SelectAfter

SendMailHost
This specifies the mailServer that is used to send outgoing mail. It is usually the same as the Mailserver. Currently this is only required if you are using the SMS facility to send SMS messages via EMail.
Example:
SendMailHost  mail.cruzio.com

ShowMaxPIcons
This specifies the number of PIcons that will be displayed on the screen. If you have more, a scrollbar will be used to display the additional PIcons. The default is 10.

ShowMinPIcons
This specifies the minimum number of PIcons that will be displayed on the screen. This controls the minimum width of the window. The default is 4.

SMSEmail
This specifies an email address for the cellular company that is providing the Short Message Service (SMS). You need to contact your cellular provider to determine this. If your provider is Cingular and you want an SMS message sent to your cellphone, then you specify your cellphone number and mobile.mycingular.net. For example:
  SMSEmail "8315551234@obile.mycingular.net"

Version
Specifies the MailFaces Version that this Options file is designed to support. This is used to support upgrades of the Options file for new versions of MailFaces
Example:
Version 1.2

[ Index | Overview | Install | Options | Usage | Notes ]