Veritas Enterprise Vault™ Setting up SMTP Archiving

About X-Kvs X-Headers

This section describes the special Enterprise Vault X-Headers that third-party applications or MTAs can add to messages to override policy and target settings. These X-Headers begin with "X-Kvs". Enterprise Vault recognizes and processes "X-Kvs" headers, so you do not need to add these to the X-Header list in the policy properties.

If a message contains multiple instances of the same X-Header, Enterprise Vault uses the first one only, and ignores the others.

As with X-Headers that you add to the X-Header list in the policy, Enterprise Vault treats the names and values of these special X-Headers as case sensitive.

X-Kvs-ArchiveId provides the ID of the archive in which to store the message. For example: X-Kvs-ArchiveId: 160EEB78D4253BE40AA8EBEBA09C7DFEE1210000evserver1.

This header can be used to identify a different archive from the one that is configured for the target address in the message.

For example, a message is sent to the target address journal1@example.com, and the archive configured for that target address is journal1. If X-Kvs-ArchiveId is added to the message, Enterprise Vault stores the message in the archive identified in the X-Header, rather than journal1.

You can use the Enterprise Vault X-Header, X-Kvs-IndexData, to do the following:

The header value is specified using XML. The XML element and attribute names and values are treated as case sensitive.

The following X-Kvs-IndexData example adds the X-Header, X-ExampleCorp-Dept, with multiple values:

X-Kvs-IndexData: <ARCHIVED_ITEM version="1.0"><PROPSET NAME="EVXHDR">
<PROP NAME=" X-ExampleCorp-Dept RESULTS="true" SEARCH="true">
<VALUE>Sales</VALUE><VALUE>Marketing</VALUE></PROP></PROPSET>
</ARCHIVED_ITEM>

Enterprise Vault adds X-Headers to the reserved index property set, EVXHDR. If you add other custom index properties, then you should specify a different property set for these properties. Suitable property set names for custom index properties would be your company name or the application name. The following property set names are reserved:

In the following example, X-Kvs-IndexData is used to add two custom index properties, Dept and Region, to a message:

X-Kvs-IndexData: <ARCHIVED_ITEM version="1.0"><PROPSET NAME="ChatApp">
<PROP NAME="Dept" type="string" RESULTS="true" SEARCH="true">Sales</PROP>
<PROP NAME="Region" type="string" RESULTS="true" SEARCH="true">EMEA</PROP>
</PROPSET></ARCHIVED_ITEM>

In this example, the application name, ChatApp, is used as the property set name for the two custom index properties.

The first property, ChatApp.Dept, has the value "Sales". The property is searchable and retrievable.

The second property, ChatApp.Region, has the value "EMEA". This property is also searchable and retrievable.

The following example uses X-Kvs-IndexData to add the custom index property, ChatApp.Region, with multiple values:

X-Kvs-IndexData: <ARCHIVED_ITEM version="1.0"><PROPSET NAME="ChatApp">
<PROP NAME="Region" type="string" RESULTS="true" SEARCH="true">
<VALUE>USA</VALUE><VALUE>EMEA</VALUE><VALUE>ASIA</VALUE></PROP>
</PROPSET></ARCHIVED_ITEM>

In this example, the ChatApp.Region property has the values, "USA", "EMEA", and "ASIA". The property is searchable and retrievable.

It is advisable to reduce the header size as much as possible. If the default values for attributes are required, you can omit the attributes from the header. Table: Default values for XML attributes lists the default values for the XML attributes.

In the previous example, the default values for SEARCH and type attributes are required, so you can omit these attributes:

X-Kvs-IndexData: <ARCHIVED_ITEM version="1.0"><PROPSET NAME="ChatApp">
<PROP NAME="Region" RESULTS="true"><VALUE>USA</VALUE><VALUE>EMEA</VALUE>
<VALUE>ASIA</VALUE></PROP></PROPSET></ARCHIVED_ITEM>

When searching for a custom index property that has been added using X-Kvs-IndexData, you specify the property in the form property_set_name.property_name, for example ChatApp.Region.

When searching for an X-Header that has been added using X-Kvs-IndexData, you specify the X-Header in the form EVXHDR.X-Header_name, for example EVXHDR.X-ExampleCorp-Dept.

See Searching archives for messages with specific X-Headers.

X-Kvs-MessageType identifies the type of the message. For example: X-Kvs-MessageType: Bloomberg.

This header is used to override the value of the Vault.MsgType property that Enterprise Vault assigns to the message when it is archived. By default, if a message is archived using SMTP Archiving, Enterprise Vault assigns the value SMTP.Mail to the Vault.MsgType property.

The value of the Vault.MsgType property can be used in search applications, such as Discovery Accelerator, to filter the messages to search. If, for example, SMTP Archiving is used to archive Bloomberg messages, then the message type needs to be identified as Bloomberg. If the message type is not set to Bloomberg, the messages will not be included in Discovery Accelerator searches of Bloomberg messages.

X-Kvs-OriginalLocation identifies the location in the content source to set for the message. Original location refers to the folder in the content source where the message resides. This could be set to the name of a top-level folder, or a folder path. For example: X-Kvs-OriginalLocation: CompanyA\ProductB\CustomerC.

You can add this X-Header to a message to specify a different archive folder for the message. If a message contains the example X-Header shown above, and the target archive type can contain folders, then the task would store the message in the following location:

Top-level folder: CompanyA

Subfolder: ProductB

Subfolder: CustomerC

If the folder structure does not exist, the task creates the folders when it stores the message.

This X-Header is only effective if the target archive type can contain folders.

In SMTP Journaling and Selective SMTP Journaling, the SMTP Archiving task archives messages in the Inbox, if the archive type can contain folders. If the message contains an X-Kvs-OriginalLocation header, and the archive can contain folders, then the task stores the message in the location indicated in the X-Header instead of the Inbox.

Typically the type of archives used for SMTP Mailbox Journaling can contain folders; for example, Exchange mailbox, or Internet mail archives. The task stores messages in the Inbox, or Sent Items folder, or both, depending on whether a target address is the sender, recipient, or both. If the message contains an X-Kvs-OriginalLocation header, then the task stores the message in the location indicated in the X-Header instead of the Inbox or Sent Items folders.

X-Kvs-RetentionCategory provides the ID of the retention category to assign to the message. For example: X-Kvs-RetentionCategory: 1505EB2CDB9C6AA44B30335E4A785F98C1b10000evserver1.

This header can be used to identify a different retention category from the one that is configured for the target address in the message.

For example, a message is sent to the target address journal1@example.com, and the retention category configured for that target address is 7years. If X-Kvs-RetentionCategory is added to the message, Enterprise Vault applies the retention category identified in the X-Header, rather than 7years.