Send Email

The Send Email component allows users to send emails—with or without attachments—via an orchestration pipeline. Users may wish to use this component to send email notifications upon any pipeline failures.

Some SMTP servers will not allow the Sender Address property to be different from the SMTP Username (for example, Outlook and Gmail). This means that whatever is shown in the SMTP Username property will be used as the value of the “From” when the email is sent, and the Sender Address property will be ignored. This is beyond our control.

Depending on your configuration, it is safest to assume that email is an unencrypted medium. Therefore, it is recommended to avoid including sensitive content in the email Message. Instead, it is recommended to provide trusted URLs through which such context could be securely accessed.

Depending on your SMTP server, you may need to set Enable SSL/TLS to Yes and Enable StartTLS to No, or the other way around. These properties are available when Authentication type is set to Username and password or Generic OAuth authentication.

Properties

Name · string · required

A human-readable name for the component.

To recipients · email address · required

Click + to add a recipient to send the email to, and then type the recipient’s email address into the field. Each recipient must be its own row.

Cc recipients · email address

Click + to add a recipient to send a carbon copy of the email to, and then type the recipient’s email address into the field. Each Cc recipient must be its own row.

Subject · string · required

A subject for the email.

Message · string · required

The contents of the email body.

To use variables in this field, type the name of the variable prefixed by the dollar symbol and surrounded by { } brackets, as follows: ${variable}. Once you type ${, a drop-down list of autocompleted suggested variables will appear. This list updates as you type; for example, if you type ${date, functions and variables containing date will be listed.

Sender address · email address · required

The email address from which the email is sent.

Reply address · email address

The address that will receive any recipient and/or Cc replies.

Authentication type · drop-down

Select the method used to authenticate with your SMTP server. The default is Username and password. The following authentication types are supported:

• Username and password: Authenticate with an SMTP username and password.
• Generic OAuth authentication: Authenticate with an OAuth access token.
• Azure OAuth authentication: Authenticate with Azure OAuth, using either your cloud platform credentials or custom credentials.

The authentication type you select determines which of the following properties are available.

Azure Credential Source · drop-down

Available when Authentication type is set to Azure OAuth authentication. Select the source of the Azure credentials used to authenticate with your SMTP server. The default is Cloud platform credentials. The following sources are supported:

• Cloud platform credentials: Use the Azure credentials from your cloud platform.
• Custom credentials: Enter a client ID, tenant ID, and secret key manually.

OAuth access token · drop-down

Available when Authentication type is set to Generic OAuth authentication. Choose the secret definition that represents your OAuth access token.

If you have not already saved your OAuth access token as a secret definition, click Add Secret to create one. Read Secrets and secret definitions for details about creating a secret definition.

SMTP username · string · required

The username for your SMTP client. This property is required for all authentication types.

Client ID · string · required

Available when Azure Credential Source is set to Custom credentials. The client ID of your Azure application.

Tenant ID · string · required

Available when Azure Credential Source is set to Custom credentials. The ID of your Azure tenant.

Secret key · drop-down · required

Available when Azure Credential Source is set to Custom credentials. Choose the secret definition that represents your Azure client secret.

If you have not already saved your client secret as a secret definition, click Add Secret to create one. Read Secrets and secret definitions for details about creating a secret definition.

SMTP password · drop-down · required

Available when Authentication type is set to Username and password. Choose the secret definition that represents your credentials for this connector.

If you have not already saved your credentials for this connector as a secret definition, click Add Secret to create a secret definition representing these credentials. Read Secrets and secret definitions for details about creating a secret definition.

SMTP hostname · string · required

Available when Authentication type is set to Username and password or Generic OAuth authentication. The host address for your SMTP server. For example, if you use Gmail, the SMTP hostname is smtp.gmail.com. Typically, an SMTP email server address can be found in the “account” or “settings” sections of the email client.

SMTP port · port number · required

Available when Authentication type is set to Username and password or Generic OAuth authentication. Set the port. The default port is 25.

Enable SSL/TLS · boolean · required

Available when Authentication type is set to Username and password or Generic OAuth authentication. Select whether to enable SSL/TLS encryption.

Enable StartTLS · boolean · required

Available when Authentication type is set to Username and password or Generic OAuth authentication. StartTLS is an email protocol command that directs an email server that an email client, including an email client running in a web browser, wants to turn an existing insecure connection into a secure one.

Attachment storage type · drop-down

Select the cloud storage location that hosts the file you want to attach. The default is S3. The following storage types are supported:

• S3
• Azure Blob Storage
• Google Cloud Storage

Access to the selected storage depends on valid credentials being available for that source: AWS for S3, Azure for Azure Blob Storage, or GCP for Google Cloud Storage. The credentials must have access to the relevant bucket, container, and path.

S3 attachment · file editor

Available when Attachment storage type is set to S3. Select the file you want to attach from the list of available S3 buckets, or enter the file path manually.

The URL must be formatted as follows. Maia adds the s3:// prefix automatically, so you don’t need to add it:

s3://<bucket>/<path>

Project and pipeline variables can also be used. This is particularly useful when using them in the URL, for example:

s3://${bucketName}/${path}.${filetype}

The file attachment is limited to one file and must not exceed 10 MB in size.

Azure Blob attachment · file editor

Available when Attachment storage type is set to Azure Blob Storage. Select the file you want to attach from the list of available Azure Blob Storage containers, or enter the file path manually.

The URL must be formatted as follows. Maia adds the azure:// prefix automatically, so you don’t need to add it:

azure://<account>/<container>/<path>

Project and pipeline variables can also be used. This is particularly useful when using them in the URL, for example:

azure://${account}/${containerName}/${path}.${filetype}

The file attachment is limited to one file and must not exceed 10 MB in size.

GCS attachment · file editor

Available when Attachment storage type is set to Google Cloud Storage. Select the file you want to attach from the list of available Google Cloud Storage buckets, or enter the file path manually.

The URL must be formatted as follows. Maia adds the gs:// prefix automatically, so you don’t need to add it:

gs://<bucket>/<path>

Project and pipeline variables can also be used. This is particularly useful when using them in the URL, for example:

gs://${bucketName}/${path}.${filetype}

The file attachment is limited to one file and must not exceed 10 MB in size.