Skip to content

Email Actions ​

General ​

send ​

Sends an email via an SMTP transporter using the provided credentials and message fields.

Returns: true when the message is accepted by the SMTP server.

ParameterTypeRequiredDefaultDescription
hoststring✓—SMTP server hostname or IP address.
portnumber✓—SMTP server port (e.g. 465, 587).
secureboolean—Use TLS for the connection. True for port 465, false for STARTTLS.
userstring✓—SMTP authentication username.
passstring✓—SMTP authentication password.
fromstring✓—Sender email address.
tostring | string[]✓—Recipient email address or list of addresses.
ccstring | string[]—Carbon copy recipient email address or list.
bccstring | string[]—Blind carbon copy recipient email address or list.
subjectstring✓—Email subject line.
textstring—Plain-text body of the email.
htmlstring—HTML body of the email (takes precedence over text for HTML-capable clients).
attachmentsany—File attachments to include with the email.
yaml
# Send a plain-text and HTML email with an optional file attachment
- group: email
  name: send
  params:
    host: '{{ smtpHost }}'
    port: 587
    secure: false
    user: '{{ smtpUser }}'
    pass: '{{ smtpPass }}'
    from: 'sender@example.com'
    to: 'recipient@example.com'
    subject: 'Daily Report — Sales Pipeline'
    text: 'Pipeline run completed. See attached report for details.'
    html: '<strong>Pipeline run completed.</strong>'

Released under the Apache License 2.0.