FME Flow: 2024.1

Email

The Email external action receives messages and delivers emails via the SMTP protocol.

The Email external action has two output ports. The success port (✔) can send a message if the email is delivered successfully. The failure port (x) can send a message if the delivery fails.

Note  Email servers may have maximum connection limitations. When an Email external action sends multiple emails to the same server in quick succession, this limitation may cause emails to be dropped. To fix this issue, adjust the MAX_WORKER_THREADS parameter in the email.properties file, located in <FMEFlowDir>/Server/config/subscribers, to a value at or below the corresponding value of the email server. For example, if the email server's connection limit is 20, lower MAX_WORKER_THREADS from 100 (default) to 20.
Note  When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

Parameters

Note  See also Working with Parameters in Automations Workflows.
Tip  To test that your parameters work as expected, click Validate.
  • SMTP Server: Mail exchange server domain name or IP address used for sending email.
    • Tip  To auto-populate some fields for common SMTP servers, click Load Template.
    Provider Server
    Gmail smtp.gmail.com
    Outlook smtp.live.com
    Office 365 smtp.office365.com
    Yahoo Mail smtp.mail.yahoo.com
    Mail.com smtp.mail.com
    AOL Mail smtp.aol.com
    Zoho Mail smtp.zoho.com
    Yandex smtp.yandex.com
  • SMTP Server Port: Mail exchange TCP port used for sending email. If Connection Security (below) is SSL/TLS, specify port 465. If StartTLS or None, specify port 587.
  • SMTP Account (optional): If the SMTP server requires authentication, this is the user name.
  • SMTP Password (optional): If the SMTP server requires authentication, this is the user password.
  • Connection Security: The encryption mechanism used for the connection.
    • SSL/TLS: The connection uses Transport Layer Security (TLS), formerly Secure Sockets Layer (SSL), supported by most common SMTP email servers.
    • StartTLS: An SSL/TLS connection with the email server is initiated using the STARTTLS command.
    • None: The connection is unencrypted.
  • Email To, Email Cc (optional), Email Bcc (optional): Corresponds to the To, CC, and BCC fields, respectively, in standard email messages. Separate multiple recipients with commas. For example: recipientOne@example.com,recipientTwo@example.com,recipientThree@example.com
  • Email From: Corresponds to the "From" field in standard email messages. If users reply to the notification email, it is directed to this address.
  • Email Subject: Corresponds to the "Subject" field in standard email messages.
  • Email Format: The format of the email. Options are Plain Text, HTML, or Rich Text.
  • Email Attachment (optional): Path to the source file to attach to the email.
  • Email Body (optional): The message body to use for delivery.
  • Client ID (optional): For open authorization (OAuth) as a registered application with the Microsoft identity platform, specify the Application (client) ID. The client ID is created when configuring an Azure Active Directory tenant.
    • Note  A client secret is not required.

Output Attributes

See Also

Tip  To view the output attributes from upstream components, click Show Upstream Attributes.
Attribute Description
time Event time
source Event type
error.type

(Failure port only) Error type:

  • InvalidMessage: An error occurred while configuring this component, such as missing or malformed values.
  • DeadLetter: An error occured while connecting to an external resource. Examples may include connection issues, invalid credentials, or generic external resource exceptions.
error.message (Failure port only) Error message

Retry

  • Retry on failure: If checked, the automation attempts to run the action again if the initial attempt results in a failure to connect to the specified external resource for message delivery. The manner in which these retries are conducted is based on the remaining settings.
  • Use custom retry settings: If checked, the remaining retry settings are configurable. If not checked, they are set to the FME Flow default values.
  • Number of attempts: Maximum number of retries, if the action continues to fail.
  • Wait between attempts: Time to wait between retries. In conjunction with Backoff multiplier (below), the specified value is the wait time for the first retry.
  • Backoff multiplier: Factor by which to increase Wait between attempts on successive retries. For example, a value of 2.0 doubles the wait time for the next retry.
  • Randomization factor: Percentage by which to introduce randomness to Wait between attempts. For example, if Wait between attempts is 100 Seconds, and Randomization factor is 25, the wait time for each retry is randomly selected between 75 and 125 seconds.
  • Maximum wait between attempts: Maximum wait time between retries. In conjunction with Backoff multiplier, the specified value is the upper limit for wait time.