Previous Topic: Engine ParametersNext Topic: File Handling Parameters


Email General Parameters

These parameters can be used to configure any type of email import operation. They cover such areas as how Event Import handles sender and recipient addresses, how it identifies internal emails, whether a single imported email generates separate events for each internal sender and recipient, and how it determines the capture date for each imported event.

EMail.IgnoreAPMAuditMails

Defaults to No. This parameter specifies whether Event Import and Import Policy ignore iConsole audit emails. The syntax is:

EMail.IgnoreAPMAuditMails=Yes or No

If set to:

Yes, audit emails generated by the iConsole are ignored by Import Policy and Event Import. This ensures that policy is not applied to audit emails.

No, iConsole audit emails are imported in the same way as all other e‑mails.

EMail.InternalAddrPattern

This parameter specifies an address pattern that identifies e‑mails as ‘internal’. The syntax is:

EMail.InternalAddrPattern=<address pattern>

For outgoing e‑mails, Event Import checks the recipient address; for incoming e‑mails, it checks the sender address. If the e‑mail address matches the address pattern specified here, Event Import flags the e‑mail as ‘internal’. You can then explicitly search for these internal emails in the iConsole or Data Management console.

A single Event Import operation can include multiple instances of this parameter, with each instance specifying a different way of identifying internal addresses. For example, you can specify separate address patterns for the SMTP, X.400 and EX formats (EX is the format used internally by Microsoft Outlook). The examples below show how you could use three instances of this parameter to flag all e‑mails sent internally within the Unipraxis organization in the UK:

EX: EMail.InternalAddrPattern=ex:/o=unipraxis/ou=uk

SMTP: EMail.InternalAddrPattern=unipraxis.co.uk

X.400: EMail.InternalAddrPattern=c=uk;p=Unipraxis

The mechanism used by Event Import to match email addresses against specified patterns is the same as that used by CA DataMinder to match email addresses against lists of addresses defined in the capture control triggers of a user policy. For details, see the Administration console online help; search the index for ‘email addresses: matching addresses to policy lists’.

This parameter is similar to the ‘Internal emails’ setting in the user policy, which also defines the address patterns that identify an e‑mail as internal. (Find this setting policy in the System Settings\Definitions folder). This policy setting is used to flag internal emails captured directly by capture or control triggers.

Note: We strongly recommend that you only use this parameter within a configuration file. This prevents potential problems caused by spaces within the address pattern string.

Note: This parameter cannot be used with Import Policy.

EMail.SenderAddrIncludeFilter

This parameter specifies an address pattern that determines whether to import an email or not. The syntax is:

EMail.SenderAddrIncludeFilter=<address pattern>

Sender addresses that match the address pattern specified here are imported. For example, you can use this parameter to only import emails where the sender email is internal to your organization.

As with EMail.InternalAddrPattern (see above), a single Event Import operation can include multiple instances of this parameter, with each instance specifying a different way of identifying sender addresses.

Note: We strongly recommend that you only use this parameter within a configuration file. This prevents potential problems caused by spaces within the address pattern string.

EMail.SenderAddrExcludeFilter

This parameter specifies an address pattern that determines whether to exclude an email from the import job. The syntax is:

EMail.SenderAddrExcludeFilter=<address pattern>

Sender addresses that match the address pattern specified here are not imported.

As with EMail.InternalAddrPattern (see above), a single Event Import operation can include multiple instances of this parameter, with each instance specifying a different way of identifying sender addresses.

Note: We strongly recommend that you only use this parameter within a configuration file. This prevents potential problems caused by spaces within the address pattern string.

EMail.EventDateFromEMail

Defaults to Yes. This parameter specifies where the capture date assigned to imported events is set from. The syntax is:

EMail.EventDateFromEMail=Yes or No

If this parameter is set to:

Yes, the timestamp reflects the time and date in the email. It is based on the delivery time or time sent. If the e‑mail does not contain the delivery time or time sent, Event Import sets the timestamp to the time of import.

No, the timestamp reflects the time of import.

EMail.StoreMessageClass

Defaults to Yes. This parameter specifies whether CA DataMinder extracts and stores the message class of imported emails. It applies to MSG, EVF, PST, EAS, EXCH and NSF import operations. The syntax is:

EMail.StoreMessageClass=Yes or No

If this parameter is set to:

Yes

CA DataMinder stores message classes for imported email events. For example, if an imported email has an IPM.Note.Fax message class, this is stored as an attribute of the event. In the Data Management console, this allows reviewers to search for or, more importantly, exclude from searches specific categories of email such as delivery receipts or meeting requests.

For Outlook emails, only ‘non-standard’ message classes are stored. The ‘standard’ message class is defined as ‘IPM.Note’; nearly all Outlook emails have this message class. To avoid burdening the CMS database with unnecessary data, the message class is not stored when it is simply ‘IPM.Note’.

No

CA DataMinder does not store message classes for imported emails.

Note: This import parameter is similar to the Store Email Class in the user policy. This setting stores the message class for captured emails. Find this setting in the System Settings policy folder.

Note: This parameter cannot be used with Import Policy.

Email.MessageClassFilterIncludePattern

This parameter has no default value. Reviewers can use this parameter to only import specific categories of email. The syntax is:

Email.MessageClassFilterIncludePattern=<message class>

For example, if a reviewer only wanted to import appointment notification e‑mails, the syntax would be:

Email.MessageClassFilterIncludePattern=IPM.Note.Appointment

A single import.ini file can include multiple instances of this parameter, with each instance specifying a different pattern.

Email.MessageClassFilterExcludePattern

This parameter has no default value. Reviewers can use this parameter to exclude specific categories of email from the import operation. The syntax is:

Email.MessageClassFilterExcludePattern=<message class>

For example, a reviewer may want to exclude all faxes. In this case, the syntax would be:

Email.MessageClassFilterExcludePattern=IPM.*.Fax

A single import.ini file can include multiple instances of this parameter, with each instance specifying a different pattern.

Email.MoveToFailedFolderOnHubTimeout

Defaults to Yes. This parameter specifies how CA DataMinder handles emails that could not be imported because the policy engine hub timeout expired (see the GlobalEventTimeoutSeconds hub registry value). The parameter syntax is:

Email.MoveToFailedFolderOnHubTimeout=Yes or No

If set to:

No

CA DataMinder does not move the email to the ‘failure' folder, as specified by MSExch.FailedMailboxFolder. The email remains in the user’s Exchange mailbox. If the import operation is running in continuous mode, Event Import will continue trying to import the email.

Yes

The email will be moved to the ‘failure' folder.

More information:

Example Import Configuration File