← Back to plugin index

Email SMS Gateway

Description
SMS gateway plugin that sends an email instead of an SMS message.

This plugin sends an email message with a configurable subject and the actual SMS message as body as email using the configured EmailService plugin.
The recipient of the email may depend on the target SMS message (see configuration properties).

Note that this plugin cannot only be used to use Email as channel instead of SMS but it also serves as integration plugin for SMS gateways that actually work this way (i.e. expect an email).

This plugin does neither support multi-sms-messages nor flash messages.

Type name
EmailSmsGateway
Class
com.airlock.iam.core.misc.impl.sms.EmailSmsGateway
May be used by
Properties
Email Service (emailService)
Description
The email service plugin used to send the email.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Mail Subject (mailSubject)
Description
The string used as subject.
Attributes
String
Optional
Example
Authentication Code
Example
-OMedusa
Recipient Template (recipientTemplate)
Description
A template string used to build the email recipient address given the normalized mobile phone number used.
The recipient address may contain the string "${phonenumber}", which will be replaced by the phone number passed to this plugin.
Attributes
String
Mandatory
Example
${phonenumber}@smsgate.myfirm.com
Example
admin@myfirm.com
International Prefix (internationalPrefix)
Description
Defines what prefix to use for international phone numbers. Possible values: "+", "00"
Attributes
String
Optional
Default value
+
Example
+
Example
00
Visible Phone Number Digits In Log (visiblePhoneNumberDigitsInLog)
Description

Defines the number of phone number digits visible in log statements.

Thus, if the value is zero, all digits are masked, if it is large enough, all digits are visible. If set to 3, for example, the logged number looks like ********965.

The default is 100, i.e. showing all digits.

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

type: EmailSmsGateway
id: EmailSmsGateway-xxxxxx
displayName: 
comment: 
properties:
  emailService:
  internationalPrefix: +
  mailSubject:
  recipientTemplate:
  visiblePhoneNumberDigitsInLog: 100