Setting up the SMTP archiving configuration file

You must set up an SMTP archiving configuration file to provide information to the SMTP archiving process.

The SMTP archiving configuration file includes the following information:

The configuration file must be located in the Enterprise Vault installation folder, typically C:\Program Files\Enterprise Vault. A skeleton configuration file, EvSmtpArchiveConfig.ini, is installed when you install the SMTP archiving components.

The file is in INI format, with several sections that contain key=value entries:

[SectionName]
key=value
key=value
...
[SectionName]
key=value
key=value
...

Edit the skeleton configuration file, or create a new one. Use a plain text editor such as Notepad, and save the file as a Unicode file. You specify the name of the configuration file when you run SMTP archiving.

Note the following:

Table: Entries in the SMTP archiving configuration file lists the possible entries in the SMTP archiving configuration file.

Table: Entries in the SMTP archiving configuration file

Section

Entry

Required?

Description

Server

Specify one server section per file.

Name=servername

Yes

Specifies the name of the virtual server to which SMTP archiving binds. This is the name assigned to the server in IIS Manager, where the default server has the name "Default SMTP Virtual Server". In general, these names are not unique, but the name of the server to use for SMTP archiving must be unique.

Priority=n

Optional

Determines when the SMTP archiving process is started in relation to other processes registered against the server. If this entry is absent the default is 32767 (the lowest priority), as no other processes are started after SMTP archiving.

NonDeliveryFolder=folderpath

Optional

Identifies a folder in which to save messages for unrecognized domains (those not specified in this file). If you do not specify this folder, messages for unrecognized domains are lost.

If you specify a folder path you must create the non-delivery folder in the holding area.

DiskFullRetryLimit=n

Optional

Specifies the number of retry attempts for a message that was not saved because the disk was full. The default value is -1, which means that there is no upper limit.

DefaultIndexingLevel=Brief, Medium, Full, or SiteDefault

Optional

Specifies the default indexing level to set for the archive points on auto-enabled mailbox folders. This value is effective for any domains for which an indexing level is not set explicitly. The default is Full, which enables you to search for phrases in the message content.

SiteDefault takes its value from the Enterprise Vault Site Settings.

Domain

You can specify multiple domain sections in the file.

Name=domainname

Yes

Specifies the name of an SMTP domain. Messages addressed to this domain are held for archiving.

Path=folderpath

Yes

Specifies the path to the domain root folder in the holding area.

You must create the domain root folder in the holding area.

AutoEnableMbxFolders=False or True

Optional

If set to True, forces SMTP archiving to do as follows:

  • Create appropriate mailbox subfolders under the domain root folder automatically.

  • Add an archive point on the mailbox folder.

If set to False (the default), you must create the mailbox folders and archive points under the domain root folder manually. When a mailbox folder does not exist, then messages are either saved in the non-delivery folder or, if you have not specified that folder, they are lost.

NonDeliveryFolder=folderpath

Optional

Specifies a path for a folder in which to save messages in the following situations:

  • Message cannot be saved in the mailbox subfolder, because of a folder access error (such as disk full or access denied).

  • The mailbox subfolder does not exist and AutoEnableMbxFolders is not set to True.

If you specify a folder path you must create the non-delivery folder in the holding area.

IndexingLevel=Brief, Medium, Full, or SiteDefault

Optional

Specifies the indexing level to set for archive points on auto-enabled mailbox folders for the domain. The default is Full, which enables you to search for phrases in the message content.

SiteDefault takes its value from the Enterprise Vault Site Settings.

Note:

Enterprise Vault does not index custom SMTP headers (X-headers) with the exception of "x-KVS-MessageType", which Compliance Accelerator uses to enable searches on Instant, Bloomberg, and Exchange messages.

More Information

Setting up the holding area

Setting up the holding area

Setting up the holding area

Setting up the holding area