Previous Topic: Socket API Registry KeyNext Topic: Socket API Throttling


Notifications Registry Subkey

Note: Applicable only to emails captured by the NBA and Milter MTA agent.

For emails captured by the Milter MTA agent, you can set up the Socket API to allow policy engines to send email notifications to users when their emails are blocked or trigger a warning. To do this, you need to edit values in the following registry key:

HKEY_LOCAL_MACHINE\Software\ComputerAssociates\CA DataMinder
  \CurrentVersion\External Agent API\Notifications

The Notifications registry subkey contains these values:

AttachOriginalEmail

Type: REG_DWORD

Data: Defaults to 1. Specifies whether to attach the original email address to the notification email. If set to 1, the original email is attached; if set to zero, then it is not attached.

AuthType

Type: REG_SZ

Data: Defaults to None. This specifies which standard SMTP authentication type the Socket API uses to connect to the SMTP server. The following values are supported:

None

Plain

Login

NTLM

CRAM-MD5

We recommend you choose None for unauthenticated connections. However, your SMTP server must be configured to accept connections from the Socket API host machine.

We do not normally recommend Plain or Login authentication because under these protocols the logon password is sent as unencrypted plain text across the network.

NTLM and CRAM-MD5 authentication can be used to connect to SMTP servers on Windows and UNIX machines respectively. However, although these protocols do not send unencrypted logon credentials, you must still ensure that these credentials are protected.

If you use Plain, Login, NTLM or CRAM-MD5 authentication, you must also set up the UserID registry value—see UserID—to pass the logon account details to the SMTP server.

NotificationFromAddress

Type: REG_SZ

Data: Specifies the sender’s address that is shown in the From: field of an email notification. For example, you can set this to:

ComplianceTeam@unipraxis.com

SmtpDNSHostName

Type: REG_SZ

Data: This registry value is used to ensure that Socket API notification emails are not reprocessed needlessly by consecutive CA Data Protection email agents.

SmtpDNSHostName specifies a single DNS domain that is written to the email when it is generated by the Socket API. To use this registry value as intended:

  1. Set it to the same value (for example, UNIPRAXIS.COM) for all your email server agents.
  2. Include this value in the EnterpriseDNSList domain list for Exchange or Domino server agents, or the Milter MTA agent, the parameter enterprisedns-list=<domain list>.
  3. When any CA Data Protection server agent receives an email from the Socket API tagged as coming from UNIPRAXIS.COM, it knows that policy does not need to applied to this notification email and so does not process it.

For examples of how the equivalent registry value is used to prevent ‘repeat processing’ for the Exchange or Domino server agent, see Prevent repeat processing by server agents in multiple domains.

SmtpServer

Type: REG_SZ

Data: Specifies the name of the server hosting the SMTP service and, optionally, the SMTP port number. For example, you can set this value to your Exchange server (if it is configured to relay SMTP messages).

This registry value can also specify the TCP port used for communication between the Socket API and the SMTP server. If omitted, the port number defaults to 25. To specify a non-default port number, append the number to the server name, separated by a colon. For example:

unipraxis.com:25777

Important! If you change this registry value, you must restart the Socket API host machine for this change to take effect.

UserID

Type: REG_SZ

Data: Specifies a valid user account that the Socket API will use to log on to the SMTP server. This registry value is only required if the Socket API authentication method is not ‘None’ (this is specified by AuthType; see above).

If you need to specify the UserID registry value, you must also securely cache the password for this account. This password will be passed to the SMTP server with the user account name, if required by the authentication type. To cache the password, you run the WgnCred.exe utility on the Socket API host machine, where the component ID is:

EANotifications

You will need to supply this component ID as the <component identifier> if you run a WgnCred.exe command to set the full credentials.

More information:

Prevent Repeat Processing by Server Agents in Multiple Domains

Set Account Credentials with WgnCred.exe