Skip to Content

Configuring the SMTP adapter

BMC recommends that you do not include unused elements in the adapter configuration because they might cause errors.

Adapter type: ro-adapter-smtp_vv.rr.nn

Default adapter name: SMTPAdapter

To configure the SMTP adapter, see Configuring base adapters.

The following table describes the adapter configuration elements for the SMTP adapter that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column.

 Configuration node elements for the SMTP adapter

Warning

Note

The SMTP mail adapter supports the following message formats for the content of an email:

  • Plain text
  • HTML
  • XML

The following figure shows an XML template of the adapter configuration for the SMTP adapter.

XML template of the SMTP adapter configuration

<config>
 <target></target>
 <port></port>
 <authenticate></authenticate>
 <user-name></user-name>
 <password encryption-type=""></password>
 <javamail-debug></javamail-debug>
 <disable-mail-interaction></disable-mail-interaction>
 <starttls></starttls>
 <max-attachment-size></max-attachment-size>
 <file-name-filter>
   <file-name></file-name>
   <file-name></file-name>
 </file-name-filter>
 <file-type-filter>
   <file-type></file-type>
   <file-type></file-type>
 </file-type-filter>
 <use-ssl-certificate></use-ssl-certificate>
 <allow-unsigned-certificate></allow-unsigned-certificate>
 <install-certificate></install-certificate>
 <passphrase></passphrase>
 <character-set></character-set>
 <secure-protocols></secure-protocols>
</config>

The following figure shows an XML sample of the SMTP adapter configuration.

XML sample of the SMTP adapter configuration

<config>
 <target>smtp.runbox.com</target>
 <authenticate>true</authenticate>
 <user-name>user1</user-name>
 <password encryption-type="Plain">1234</password>
 <port>26</port>
 <character-set>UTF-8</character-set>
 <secure-protocols>TLSv1,TLSv1.1,TLSv1.2</secure-protocols>
</config>

The following figure shows an XML sample of the SMTP adapter configuration with <max-attachment-size>.

XML sample of the SMTP adapter configuration with <max-attachment-size>

<config>
 <target>smtp.runbox.com</target>
 <port>26</port>
 <max-attachment-size>1</max-attachment-size>
</config>

The following figure shows an XML sample of the SMTP adapter configuration with the <content-type> element.

XML sample of the SMTP adapter configuration with the <content-type> element

<config>
 <target>smtp.gmail.com</target>
 <port>25</port>
 <authenticate>true</authenticate>
 <user-name>emailaccount@gmail.com</user-name>
 <password encryption-type="Plain">XXXXX</password>
 <javamail-debug>false</javamail-debug>
 <max-attachment-size>10</max-attachment-size>
 <use-ssl-certificate>true</use-ssl-certificate>
 <allow-unsigned-certificate>false</allow-unsigned-certificate>
 <install-certificate>false</install-certificate>
 <passphrase>changeit</passphrase>
 <character-set>UTF-8</character-set>
 <content-type>text/plain</content-type>
</config>

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Warning

Note

You must be using TrueSight Orchestration Platform version 8.1 or later to use this encryption attribute.

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Warning

Note

You must be using TrueSight Orchestration version 8.1 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.

  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 21.02