EmailRelay <SMTPServer> XML block

The EmailRelay <SMTPServer> XML block contains attributes that the HCL Compass EmailRelay server uses to determine how to communicate with your SMTP Email server. It also contains parameters that your SMTP Email server requires.

<SMTPServer>
    <server keyfile="" password="" port="465" protocol="smtp" retries="3" servername="smtp.your_server.com" use_ssl="yes" username=""/> 
			<properties>
					<!--Add any additional properties you need to apply based on your email server -->
					<!--See http://www.oracle.com/technetwork/java/javamail/ for available properties -->
					<property key="mail.smtps.connectiontimeout" val="120000"/>
					<property key="mail.smtps.timeout" val="120000"/>
					<property key="mail.smtps.sendpartial" val="yes"/>
					<property key="mail.smtps.debug" val="false"/>
			</properties>
</SMTPServer>

These default <property> attribute values can be modified or removed, or an additional value can be added. See your SMTP Email server for special properties that you might use.

Table 1. `<server>` XML block attributes
Attribute name	Description
`keyfile`	Contains the key-file name that has the key to decrypt the user password that is stored in the `password` attribute. Important: If you change the value of this attribute, such as the file name or directory path, you must also change the physical key file.
`password`	Contains the encrypted password of your SMTP Email user. Note: You cannot change the value of this attribute. The value is automatically generated based on the parameter that you pass to the `-smtppassword` argument in the cqemailrelay.pl script. The value contained in the password attribute is encrypted, and is tied to the key.
`port`	Contains the SMTP Email server port to use to connect to the SMTP Email server. The default value of this attribute is set to `25`. Otherwise, the value of this attribute is based on the value of the `-smtpport` attribute.
`protocol`	Contains the SMTP protocol to use to communicate with the SMTP Email server. Typically the value is `smtp` or `smtps`. The value of this attribute is the determined based on the value that is specified in the `-usessl` attribute. If the value of `-usessl` is yes, then smtps is used, otherwise smtp is used.
`retries`	Contains an integer larger than -1. This value is the number of attempts to retry a failed connection with the SMTP Email server. The default value is `3`. If you experience communication problems between EmailRelay and your SMTP Email server, increase the value of this attribute.
`servername`	Contains the SMTP Email server name or IP that EmailRelay uses to connect to the SMTP Email server. The value of this attribute is based on the value of the `-smtpserver` attribute.
`use_ssl`	Contains a string value of `yes` or `no`. This value is used to establish a secure socket communication between EmailRelay server and your SMTP Email server. The value of this attribute is based on the value of the `-usessl` attribute.
`username`	Contains the SMTP Email server user name to use when EmailRelay connects to the SMTP Email server. Attention: Note: You cannot change the value of this attribute. It is based on the value of the `password` attribute and the value that is contained in the key file that is stored in the `keyfile` attribute.

Table 2. <properties> XML block attributes
Attribute name	Description
`key`	Contains the key part of an SMTP property key that is passed by the EmailRelay server to the SMTP Email server.
`value`	Contains the value part of an SMTP property key that is passed by the EmailRelay server to the SMTP Email server.