Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc Delivery Services
  4. MSI OPM Installation and Configuration Guide
  5. OPM setup
  6. Configure the OPM plug-in for NDS
  7. Relay settings (OpmConfig | senderConfig | relayConfigs)

Relay settings (OpmConfig | senderConfig | relayConfigs)

Relay servers are SMTP mail servers provided by customers. The servers are configured to relay outbound emails for the 
OPM
 plug-in. The 
OPM
 plug-in supports up to three relay servers, using either Failover mode or Parallel mode. The user name and password values are encrypted in the 
OPMplugin.config
 file. For more information, see set-up-relay-authentication.
Each relay setting in the configuration file must match the corresponding settings in the relay server. To learn more about configuring relay servers, see the documentation for your email server. For example, for 
Microsoft Exchange Server
, see MS Technet.
XML Tag
Description
Comments
<isRelayEnabled>
Specifies whether the relay server is in use.
Values
:
true
: The relay server is in use.
false
: The relay server is not in use.
If you have three relay servers, by default, the first relay server value is set to 
true
. The other two relay servers are set to 
false
.
<hostName>
The relay host name or IP address of the relay server, such as
 mail1.xyzcorp.com
—
<port>
The port number set on the relay server to support relay activities for 
OPM
.
Default
: Default port is 
25
, or can be set to the new port 587, depending on the relay side configuration.
—
<order>
Specifies the order used by 
OPM
 to determine the failover order, when in Failover mode only.
Values
: 1 to 3, where 1 is the highest priority and 3 is the lowest priority.
The value of <order> must be unique among the relay servers. If you have three relay servers, only one can have the value of 1, 2, or 3.
<connections>
The number of concurrent connections that can be established to the current relay server.
Default
:
  • 100 (without attachments)
  • 30 (with attachments)
Range
: 1-1000
To achieve high throughput, 100 or more should be used. It should match the relay server setting. (This parameter greatly affects send throughput.)
<throttle>
Throughput limit set for the relay. 
0
: No limit. Otherwise, the maximum number of mails/second can be sent through this relay.
Default
: 20 (with attachments) 
This parameter greatly affects send throughput.
<isAuthNeeded>
Specifies whether the relay server requires authorization.
Values
:
true
: The relay server requires authentication
false
: The relay server does not need authentication.
If the value is 
true
, set the <authMode> value to one of the following modes: LOGIN, PLAIN, or NTLM. Must be one of the SMTP AUTH methods currently supported by the relay server.
<authMode>
Three most commonly used SMTP authentication modes are supported: LOGIN, PLAIN, and NTLM.
—
<encryptCredential>
Specifies whether the user name and password are encrypted.
Values
:
true
: The credential is encrypted.
false
: The credential is not encrypted.
When you modify the user name and password, set the value to 
false
 to type them in clear text and click 
Update
. After you've saved the username and password values, set <encryptCredential> to 
true
 and save your change to protect the credentials.The next time that the 
OPM
 plug-in loads the configuration file, the plug-in encrypts the values.
<username>
The user name of an email account on the relay server, in full email address format.
—
<password>
The password of an email account on relay server.
—