SMTP Email Service
Description
Email sending service supporting SMIME signed and encrypted emails.
May be used by
Email Identity Verification Step Email Notification Task Report Mailer Task Email Event Subscriber (Adminapp) Email Change Verification Step Email OTP Transaction Approval Step Email OTP Authentication Step Email Notifier Vasco Letter Generator Email SMS Gateway Email Event Subscriber (Loginapp) Self Reg Users Reminder Task Email Verification Step Email Notification Step Token Activation On Delivery Strategy Flow-based Password Reset Email Otp Authenticator Send Email Link Step Legacy Email OTP Authentication Step
Properties
Email Servers (
emailServers) Description
List of servers that can be used to send an email.
An email is generally sent using the last known working server. Initially, the first server in the list is used. If a server fails, an automatic failover to the next server is triggered. If the end of the list is reached, a rollover to the beginning of the list occurs. The failover process is repeated until all servers have been tried at most once.
An email is generally sent using the last known working server. Initially, the first server in the list is used. If a server fails, an automatic failover to the next server is triggered. If the end of the list is reached, a rollover to the beginning of the list occurs. The failover process is repeated until all servers have been tried at most once.
Attributes
Plugin-List
Mandatory
Assignable plugins
From Address (
fromAddress) Description
The from-address of the email being sent when handling an event.
Attributes
String
Mandatory
Example
airlock@yourcompany.com
Example
authserver@intranet.net
Content Transfer Encoding (
contentTransferEncoding) Description
The Content-Transfer-Encoding for emails being sent. If none is set, the default algorithm to detect it automatically will be applied.
Attributes
String
Optional
Suggested values
base64, quoted-printable, 7bit, 8bit, binary, uuencode
Content Charset (
contentCharset) Description
The character set used for the mail body.
Attributes
String
Optional
Default value
UTF-8
Allowed values
UTF-8, ISO-8859-1, UTF-16, UTF-16BE, UTF-16LE, US-ASCII, ISO-8859-15
Enable Smime Sign (
enableSmimeSign) Description
If set to
TRUE, sign the emails using SMIME. Attributes
Boolean
Optional
Default value
false
Keystore File (
keystoreFile) Description
The file name of the Java keystore used for SMIME operations. It must contain the private key and a certificate. This is only used if the SMIME is used.
Note: If the keystore file name is relative, it is loaded relative to the current directory of the JVM process.
Note: If the keystore file name is relative, it is loaded relative to the current directory of the JVM process.
Attributes
File/Path
Optional
Keystore Password (
keystorePassword) Description
The password used to read the keystore. This is only used if SMIME is used.
Attributes
String
Optional
Sensitive
Key Alias (
keyAlias) Description
The keystore alias of the private key used for SMIME signing. If the alias is not set, the first matching key is selected.
Attributes
String
Optional
Example
signingKey
Example
mykey
Key Password (
keyPassword) Description
The password needed to access the private key used for SMIME signing.
Attributes
String
Optional
Sensitive
Enable Smime Encryption (
enableSmimeEncryption) Description
If set to
TRUE, emails are sent encrypted using SMIME. Attributes
Boolean
Optional
Default value
false
Encryption Error Message (
encryptionErrorMessage) Description
The error message to be sent to those recipients that do not have a certificate, i.e., that can not decrypt the encrypted message.
Only needed when encryption is enabled.
Attributes
String
Optional
Encryption Algorithm (
encryptionAlgorithm) Description
The encryption algorithm as provided by org.bouncycastle.mail.smime.SMIMEEnvelopedGenerator.
Only needed when encryption is enabled.
Attributes
String
Optional
Default value
AES256_CBC
Allowed values
DES_EDE3_CBC, RC2_CBC, IDEA_CBC, CAST5_CBC, AES128_CBC, AES192_CBC, AES256_CBC, CAMELLIA128_CBC, CAMELLIA192_CBC, CAMELLIA256_CBC, SEED_CBC, DES_EDE3_WRAP, AES128_WRAP, AES256_WRAP, CAMELLIA128_WRAP, CAMELLIA192_WRAP, CAMELLIA256_WRAP, SEED_WRAP, ECDH_SHA1KDF
Email Certificate Provider (
emailCertificateProvider) Description
The Certificate Provider is used to load the certificate given an email address.
Only needed when encryption is enabled.
Attributes
Plugin-Link
Optional
Assignable plugins
Recipient Whitelist (
recipientWhitelist) Description
A list of regular expressions to only send emails to certain recipients. If this property is not set, all emails will be sent. If at least one regular expression is defined, only emails matching one of the regular expressions will be sent.
Attributes
RegEx-List
Optional
YAML Template (with default values)
type: SmtpEmailService
id: SmtpEmailService-xxxxxx
displayName:
comment:
properties:
contentCharset: UTF-8
contentTransferEncoding:
emailCertificateProvider:
emailServers:
enableSmimeEncryption: false
enableSmimeSign: false
encryptionAlgorithm: AES256_CBC
encryptionErrorMessage:
fromAddress:
keyAlias:
keyPassword:
keystoreFile:
keystorePassword:
recipientWhitelist: