Previous Topic: Quarantine Manager Log FilesNext Topic: Email Release Procedure


Quarantine Manager Registry Values

To configure how the Quarantine Manager processes e‑mails released from quarantine and how it interacts with the CMS database, you must edit values in the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\ComputerAssociates\CA DataMinder
    \CurrentVersion\Quarantine Manager

Within this registry key, the registry values you need to edit are:

MapiEmailServerName

Type: REG_SZ

Data: Set this value to the Exchange Client Access Server (CAS role) that can access the mailbox of the MapiEmailID user account.

Note: For the Exchange 2013 Server, this value must be entered in the guid@domain format. For example, set this value as F5FA2827-5978-43cd-8FA8-E07BC3BB5591@contoso.com and Autodiscover Node as Response/Account/Protocol/Server (EXCH).

MapiProxyServerName

Type: REG_SZ

Data: Set this value to the standard FQDN. You need not specify http:// or https:// while setting this value. This is a mandatory setting and must be configured for Exchange 2013 only.

For example, use the following values:

MapiProxyServerName: e2013cas.contoso.com
Autodiscover Node:  Response/Account/Protocol/Server (EXPR) 2.
MapiRPCAuthMethod

Type: REG_SZ

Data: Set this value to configure the authentication type to be used at the RPC/TCP layer. This setting must be configured for Exchange 2013 only. The following values are supported:

NEGOTIATE

WINNT

NONE

Default: WINNT

MapiHTTPAuthMethod

Type: REG_SZ

Data: Set this value to configure the authentication type to be used at the RPC/HTTP layer. This setting must be configured for Exchange 2013 only. The following values are supported:

NEGOTIATE

NTLM

Default: NTLM

Note: If you enter invalid values or do not enter any value for MapiRPCAuthMethod and MapiHTTPAuthMethod settings, default values are set internally and the log is updated.

MapiEmailID

Type: REG_SZ

Data: Set this value to the Exchange mailbox you want to use. You need only specify the mailbox; do not include the domain prefix. For example, set this value to ‘QMuser’ not ‘Unipraxis\QMuser’.

The Quarantine Manager will use this mailbox to send emails released from quarantine on to their intended recipients.

NotesEmailServerName

Type: REG_SZ

Data: Set this value to the name of the Domino Server hosting the mailbox of the NotesEmailID user account (see below).

NotesEmailID

Type: REG_SZ

Data: Set this value to the Domino mailbox (that is, the NSF file) you want to use. The Quarantine Manager will use this user account to send emails released from quarantine on to their intended recipients.

You need to specify the path to the NSF file relative to the Data folder on the Domino server. Paths are not case-sensitive and the .nsf suffix is optional. For example:

mail\unipraxis\qmuser.nsf

You must also cache the password for the Notes ‘Current User’ on the Quarantine Manager host server. Use wgncred.exe to do this.

SmtpEmailServerName

Only required for Sendmail, Postfix, and IIS SMTP integrations.

Type: REG_SZ

Data: Specifies the name of an SMTP server that you want to use for sending emails released from quarantine. For example, this may be a Sendmail or Postfix server.

This registry value can also specify the TCP port used for communication between the Quarantine Manager 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
SmtpEmailID

Only required for Sendmail, Postfix, and IIS SMTP integrations.

Type: REG_SZ

Data: Set this value to the user account that the Quarantine Manager will use to log on to the Sendmail or Postfix server. This registry value is only required if the Quarantine Manager authentication method is not ‘None’ (as specified by SmtpAuthType; see below).

The Quarantine Manager will use this user account to send emails released from quarantine on to their intended recipients.

If you do need to specify an SmtpEmailID user account, you must cache this user’s password using wgncred.exe.

If the SmtpAuthType is set to NTLM and the Windows Mail server is set to use 'Integrated Windows Authentication' then you need only supply the username rather than qualify it with a domain. That is, 'qmgr' not 'unipraxis\qmgr'.

SmtpAuthType

Only required for Sendmail, Postfix, and IIS SMTP integrations.

Type: REG_SZ

Data: Defaults to None. This specifies which standard SMTP authentication type the Quarantine Manager uses to connect to the Sendmail or Postfix server. The following values are supported:

None

Plain

Login

NTLM

CRAM-MD5

We recommend you choose None for unauthenticated connections. However, your Sendmail or Postfix server must be configured to accept connections from the Quarantine Manager 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 Sendmail or Postfix 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 set up the SmtpEmailID registry value to pass the logon account details to the SMTP server. You must also use Wgncred.exe to cache the password.

ActiveOnStartup

Type: REG_SZ

Data: Defaults to 1. In a multiple Quarantine Manager environment, this value determines which Quarantine Manager is active on startup.

To specify a standby Quarantine Manager, set this value to zero. To specify the active Quarantine Manager, set this value to 1.

MaxRetryAttempts

Type: REG_DWORD

Data: Defaults to 5 attempts. This is the number of times the Quarantine Manager tries to resend a released email.

ReleaseTime_Mins

Type: REG_DWORD

Data: Defaults to zero minutes. This specifies how long an e‑mail is held in quarantine before it is automatically released. The zero minute default means that emails are kept in quarantine indefinitely.

SleepTime_Secs

Type: REG_DWORD

Data: Defaults to 30 seconds. This is how long the Quarantine Manager waits between querying the CMS for e‑mails released from quarantine. Increasing this interval reduces the impact that the Quarantine Manager has on database performance at the cost of a longer delay before a message can be sent on to its intended recipients.

SaveMessages

Type: REG_DWORD

Data: Defaults to 0. After the Quarantine Manager sends a released email on to its intended recipients, it is deleted from the mailbox. Set this to 1 to retain the email after it has been sent.

LogLevel

Type: REG_DWORD

Data: Defaults to 2. This setting determines the level of logging for the Quarantine Manager’s own log file (general operational details are recorded in the CA Data Protection Activity log). For example, you can configure the Quarantine Manager to only log errors or warning system messages.

Log entries are written to the wgnqmgr_<date>.log file, where <date> is the date and time when the log file was created; the file is located in CA's \data\log subfolder of the Windows All Users profile. The supported logging levels are:

1 Errors only

2 Errors and warnings

3 Errors and warnings, plus informational and status messages

Note: Setting LogLevel=3 will cause the log file to grow extremely rapidly. This level of logging is provided for testing and diagnostic purposes, for example, it shows storage and retrieval on every resource item.

LogMaxNumFiles

Type: REG_DWORD

Data: Defaults to 10. This specifies the maximum number of log files. When the maximum number of log files exists and the maximum size of the latest is reached (see below), the oldest log file is deleted to enable a new one to be created. Log entries are written to a wgnqmgr_<date>.log file, where <date> is the date and time when the log file was created

LogMaxSizeBytes

Type: REG_SZ

Data: Defaults to 1,000,000. This specifies the maximum size for each log file. When the current log file reaches its maximum size, the Quarantine Manager creates a new log file. Log entries are written to a wgnqmgr_<date>.log file, where <date> is the date and time when the log file was created.

LogFilePath

Type: REG_SZ

Data: Defaults to empty. This specifies the folder you want to write log files to. If the path is not defined, the log file is saved to CA's \data\log subfolder of the Windows All Users profile on the machine hosting the Quarantine Manager. The QM domain user must have write access to the specified folder.

More information:

Notes Servers: Set Credentials

SMTP Servers: Set Credentials

Specify a QM Domain User