Email

Label: :IA_Function
Property: type: Email
Inherits from: Function

The Email Function sends an email to the given recipients. Requires mail server to be configured in the config.json.

Parameters

Key Description Default value Possible values
message Message of the email '' string
subject Subject of the email '' string
to Recipient(s) for the email Administrator email address Comma separated list or an array of recipients email addresses
cc CC(s) for the email '' Comma separated list or an array of recipients email addresses
bcc BCC(s) for the email '' Comma separated list or an array of recipients email addresses
attachments * List of files to be sent as attachments to the email. Specifications here null Array of objects
SMTPServer a key of the SMTPServers in config file '' string

* Sending files from the server is not permitted (ex: path: '/path/to/local/file').

Outgoing triggers

Type: success

Occurrence: when email was sent succesfully

The success trigger receives an object with user and data properties.

  • The user property contains information about the user, extracted from the API response.
  • The data property contains the response from the email transporter, extracted from the API response. This can be used to get information about the sent email, such as the messageId.

Example data object:

{
    "accepted": [
        "recipient@example.com"
    ],
    "rejected": [],
    "envelopeTime": 25,
    "messageTime": 62,
    "messageSize": 391,
    "response": "250 2.0.0 OK  1600000000  some.server.com",
    "envelope": {
        "from": "sender@example.com",
        "to": [
            "recipient@example.com"
        ]
    },
    "messageId": "<12345678-abcd-1234-abcd-1234567890ab@example.com>"
}