SMTP binding spec

Detailed documentation on the SMTP binding component

Component format

To setup SMTP binding create a component of type bindings.smtp. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: smtp
  namespace: default
spec:
  type: bindings.smtp
  version: v1
  metadata:
  - name: host
    value: "smtp host"
  - name: port
    value: "smtp port"
  - name: user
    value: "username"
  - name: password
    value: "password"
  - name: skipTLSVerify
    value: true|false
  - name: emailFrom
    value: "sender@example.com"
  - name: emailTo
    value: "receiver@example.com"
  - name: emailCC
    value: "cc@example.com"
  - name: emailBCC
    value: "bcc@example.com"
  - name: subject
    value: "subject"
  - name: priority
    value: "[value 1-5]"

Spec metadata fields

Field Required Binding support Details Example
host Y Output The host where your SMTP server runs "smtphost"
port Y Output The port your SMTP server listens on "9999"
user Y Output The user to authenticate against the SMTP server "user"
password Y Output The password of the user "password"
skipTLSVerify N Output If set to true, the SMPT server’s TLS certificate will not be verified. Defaults to "false" "true", "false"
emailFrom N Output If set, this specifies the email address of the sender. See also "me@example.com"
emailTo N Output If set, this specifies the email address of the receiver. See also "me@example.com"
emailCc N Output If set, this specifies the email address to CC in. See also "me@example.com"
emailBcc N Output If set, this specifies email address to BCC in. See also "me@example.com"
subject N Output If set, this specifies the subject of the email message. See also "subject of mail"
priority N Output If set, this specifies the priority (X-Priority) of the email message, from 1 (lowest) to 5 (highest) (default value: 3). See also "1"

Binding support

This component supports output binding with the following operations:

  • create

Example request

You can specify any of the following optional metadata properties with each request:

  • emailFrom
  • emailTo
  • emailCC
  • emailBCC
  • subject
  • priority

When sending an email, the metadata in the configuration and in the request is combined. The combined set of metadata must contain at least the emailFrom, emailTo and subject fields.

The emailTo, emailCC and emailBCC fields can contain multiple email addresses separated by a semicolon.

Example:

{
  "operation": "create",
  "metadata": {
    "emailTo": "dapr-smtp-binding@example.net",
    "emailCC": "cc1@example.net; cc2@example.net",
    "subject": "Email subject",
    "priority: "1"
  },
  "data": "Testing Dapr SMTP Binding"
}

The emailTo, emailCC and emailBCC fields can contain multiple email addresses separated by a semicolon.


Last modified October 15, 2021 : Fix typo (#1850) (5fb93fd)