STEP

Send email

This email step allows you send an email through a self defined SMTP server

Specification

server

Required

object
A map containing the configuratino of your SMTP server.
server.host

Required

string
The host where your SMTP server is available.
server.port

Required

integer
The port the server is accessible on.
server.username

Required

string
The username used for authentication into the server.
server.password

Required

string
The password used for authentication into the server.
server.tls
Optional
boolean
Should the Transport Layer Security protocol be used?
from

Required

string
The email address you would like the email to come from.
to

Required

string
The email address(es) you would like the email to be sent to.
cc
Optional
string
The email address(es) you would like the email to be cc'd to.
bcc
Optional
string
The email address(es) you would like the email to be bcc'd to.
subject
Optional
string
The subject line you would like to include in the email.
body
Optional
object
A map with the configration for the body of the email.
body.html
Optional
string
The HTML you would like to send in the body of the email
body.text
Optional
string
Text for a plain text version of the email
timeoutSeconds
Optional
integer

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.