← Back to plugin index

SMTP Email Server
Description
Connection parameters of an SMTP email server.
Type name
SmtpServer
Class
com.airlock.iam.core.misc.impl.email.SmtpServerConfig
May be used by
SMTP Email Service
Properties
Host (host)
Description
The host name or IP address of the SMTP server.
Attributes
String
Mandatory
Example
smtp
Example
mailer.company.com
Example
192.168.0.13
Port (port)
Description
The port number of the SMTP server.
Attributes
Integer
Optional
Default value
25
Protocol (protocol)
Description
Protocol to be used: SMTP or SMTPS (SMTP over SSL/TLS).
For SMTPS, the server certificate has to be in the JVM truststore (defined by the iam.web-server.https.truststore.file property in the instance.properties file, or via the -Djavax.net.ssl.trustStore java option).
Attributes
Enum
Optional
Default value
SMTP
Use STARTTLS (useStarttls)
Description

If enabled, STARTTLS is triggered by the client when using plain SMTP transport to switch to encrypted communication.

This setting isn't relevant when using SMTPS (SMTP over SSL/TLS), or when STARTTLS is enforced by the server.

Attributes
Boolean
Optional
Default value
false
Debug Logging (debugLogging)
Description

If enabled, the mail library logs the whole SMTP protocol output to stdout.

Attention: This might include the authentication details!

Attributes
Boolean
Optional
Default value
false
Authentication (authentication)
Description
Authentication mechanism used to authenticate at the SMTP server. This property is optional. If not set or empty, no authentication is performed when connecting to the mail server.
Attributes
Plugin-Link
Optional
Assignable plugins
SMTP Authentication With OAuth 2.0 Client Credentials Grant SMTP Authentication With Username/Password
Connection Timeout (connectionTimeout)
Description
The TCP connection timeout in milliseconds to set for all service connections made by this plugin. This property defines the time the client is waiting for an answer when trying to open a new TCP connection.
For SMTPS, a timeout of 7000ms is recommended.
Attributes
Integer
Optional
Default value
5000
Read Timeout (readTimeout)
Description
The TCP read timeout in milliseconds to set for all service connections made by this plugin. This property defines the time the client is waiting for an answer on an already established connection. Adjusting this property might be necessary if the server needs a long time to answer to a request, for example if sending an SMS to an external system can take a long time.

If left empty or not defined, the OS defaults are used (which may result in infinite timeouts in some cases).

Attributes
Integer
Optional
Default value
10000
YAML Template (with default values) 

type: SmtpServer
id: SmtpServer-xxxxxx
displayName: 
comment: 
properties:
  authentication:
  connectionTimeout: 5000
  debugLogging: false
  host:
  port: 25
  protocol: SMTP
  readTimeout: 10000
  useStarttls: false