SMTP Valve

Delivers a mail-message.

Use this valve to send html/plain messages via SMTP.

Prerequisites

Before using this valve the module must be configured and deployed.

Configuration

Valve name: SendBySmtp | SmtpSender

Name Description Default value Mandatory Expanded

Name	Description	Default value
`smtp_destination`	ID of the internal SMTP client used to talk with the SMTP backend.	`"default"`
`username_parameter`	Only used for logging and events.	`"{{{request.User-Name}}}"`
`message_parameter`	Parameter containing the mail message. Deprecated	N/A
`message_template`	Path to a message template file. This template always trumps `message_parameter`. The text in the template is expandable. See Message Template example	N/A
`subject_parameter`	Parameter containing the mail subject.	N/A
`mail_from_parameter`	Parameter containing the FROM email address.	N/A
`mail_to_parameter`	Parameter containing the TO email address.	N/A
`mail_cc_parameter`	Parameter containing the CC email address.	N/A
`mail_bcc_parameter`	Parameter containing the BCC email address.	N/A
`remove_prefixes`	Array containing prefixes to be removed from email addresses.	N/A

smtp_destination

ID of the internal SMTP client used to talk with the SMTP backend.

"default"

username_parameter

Only used for logging and events.

"{{{request.User-Name}}}"

message_parameter

Parameter containing the mail message. Deprecated

N/A

message_template

Path to a message template file. This template always trumps message_parameter. The text in the template is expandable. See Message Template example

N/A

subject_parameter

Parameter containing the mail subject.

N/A

mail_from_parameter

Parameter containing the FROM email address.

N/A

mail_to_parameter

Parameter containing the TO email address.

N/A

mail_cc_parameter

Parameter containing the CC email address.

N/A

mail_bcc_parameter

Parameter containing the BCC email address.

N/A

remove_prefixes

Array containing prefixes to be removed from email addresses.

N/A

{
    "name": "SmtpSender",
    "enabled": true,
    "config": {
        "smtp_destination": "default",
        "username_parameter": "{{{request.username}}}",
        "subject_parameter": "My Subject",
        "message_template": "C:\\Windows\\Templates\\mail_template.txt",
        "mail_to_parameter": "{{{item.mail}}}",
        "mail_from_parameter": "noreply@mycompany.com",
        "mail_cc_parameter": "admin@mycompany.com",
        "remove_prefixes": ["SMTP:","sip:"]
    }
}

Message Template example

Property expansion is supported. All available item and exports properties can be used in the template. In the example below the item property generated_otp_value is generated prior in the pipe.

<html>
<body>
Your one time password is <b>{{item.generated_otp_value}}</b>
</body>
</html>

PreviousVoice Valve NextEntraID