Email Integration

Use the email integration to send email messages with a message step or to prompt for user input in an input step.

integration "email" "my_email_app" {
smtp_host = "smtp.gmail.com"
from = "flowpipe@bluth.com"
smtp_username = "flowpipe@bluth.com"
smtp_password = "Shfakes87y98324509i"
}

To prompt for input via email in an input step, you must create an email integration, add it to a notifier, and then configure your input step to send to the notifier.

For input steps to work properly with your email integration, make sure you set your Base URL to an address that the recipient can route to. You can set the base URL via the FLOWPIPE_BASE_URL environment variable, the base_url workspace argument, or pass it via the --base-url argument to the flowpipe server command.

Arguments

ArgumentTypeOptional?Description
fromStringRequiredThe email address from which to send messages. This value should be considered a default; if a notifier or an input step specifies a from it will override this value.
smtp_hostStringRequiredThe SMTP host to send messages to.
bccList<String>OptionalThe email recipients to blind carbon copy (BCC) messages to. This value should be considered a default; if a notifier or an input step specifies a bcc it will override this value.
ccList<String>OptionalThe email recipients to carbon copy (CC) messages to. This value should be considered a default; if a notifier or an input step specifies a cc it will override this value.
smtp_portStringOptionalThe TCP port to connect to when sending messages via SMTP. Defaults to 25.
smtp_passwordStringOptionalPassword when using authenticated SMTP/SMTPS.
smtp_tlsStringOptionalTLS negotiation options. Values are required (only use SMTPS/TLS), off (only use SMTP), or auto (prefer SMTPS, fallback to SMTP). The default is auto.
smtp_usernameStringOptionalUsername when using authenticated SMTP/SMTPS.
smtps_portStringOptionalThe TCP port to connect to when sending messages via SMTPS. Defaults to 587.
subjectStringOptionalThe email subject. This value should be considered a default; if a notifier or an input step specifies a subject it will override this value.
toList<String>OptionalThe email recipients to send messages to. This value should be considered a default; if a notifier or an input step specifies a to it will override this value.
titleStringOptionalDisplay title for the integration.

Attributes (Read-Only)

AttributeTypeDescription
request_urlStringThe URL to where email responses will be sent.