Configuration File Options and Syntax
The configuration file is a text file, with one statement per line. The following rules apply to the file:
a. Comments begin with a pound sign or number sign.
b. Statements are not case sensitive.
c. Spaces at the beginning and end of the line are ignored.
d. Line beginning with a slash is interpreted just like a command line.
e. Statement begins line, followed by white space (either tabs or spaces), followed by data. If data has spaces then it needs to begin with a single or double quote. Quotes can be embedded by escaping them with a backslash. Data ends at either the end of the line or a closing quote.
f. Only one of each statement is allowed in the configuration file, unless specifically noted as allowing multiple entries.
g. All configuration options will be overridden by options specified on the command line.
The default name of the file is archive.cfg. The location of the configuration file can be specified on the command line using the /c option (see above). Also, the /c option can specify the full path name of a configuration file. This gives you the ability to have multiple configurations.
The statements are not case sensitive.
Allowable statements for the configuration file are:
Statement | Multiple Allowed |
Description |
pmmailDirName | Specify the location of the PMMail directory. | |
accountDir | Yes | Specify the account directory(ies) to archive. |
accountName | Yes | Specify the full or partial account name(s). |
Filter Statements | ||
folderDir | Yes | Specify the folder directory(ies). |
folderName | Yes | Specify the full or partial folder name(s). |
NestedFolders [yes|no] | A position dependent option. If "yes" then all folder filters following this will match both the folder and all folders nested within it. If "no" then the folder filters will have to match exactly. This statement can appear multiple times in the configuration file. | |
fileAge | Specify the minimum age before a file will be archived. | |
dateCutOff | Specify the latest date (in YYYY/MM/DD) for a file to be archived. | |
messageDateCutoff | Specify the latest date (in YYYY/MM/DD) for a file to be archived. Use the message date instead of the saved date. | |
TimeCutOff | Specify the time together with the either the dateCutOff or messageDateCutoff for a file to be archived. This option cannot be used by itself. The time format must be hh:mm, although the colon is optional. | |
beginSubject | Yes | Specify the full or partial subject. If the subject has spaces then surround it with quotes. The subject must begin with this text. |
PartialSubject | Yes | Specify a partial subject. This text can appear anywhere within the subject. Again, if spaces are included surround the text with quotes. |
fromAddress | Yes | Specify the address from which the mail came. toAddress Yes Specify the address to which the mail was sent. fileSize In K, any file as big or bigger than the specified size will be archived. |
Miscellaneous Statements | ||
archiveFile | Specify the name of the archive file. Putting question marks in will
let the program create a sequential series of archives. See the description
of the archive file name earlier.
|
|
Delete | Flag to indicate that the files are to be removed after the archiving is completed. verbose Be noisy. See the options earlier. | |
Ouput [filename] | Send a copy of all output to the specified file. If no file specified then send output to file "archiv??.rpt". | |
Sort [option] | Specify Address book sort option. If this option is specified then the
address book will be sorted after all other operations (if any) are completed.
The option can be one of: name alias company If no option is specified then the default sort is by alias.
|
|
archiveDay Day of week | to archive the files. The day must be at least two (2) characters long for uniqueness. | |
allRequired | If present then all options need to be met before a file will be archived. If not present then any matching option will cause a file to be archived. | |
OriginalLocation | For restore operation only, restore files to their original locations instead of into the restore folder. |