[Email] Send Message
Q100015: [Email] Send Message
Send an email message via the specified SMTP server.
| Parameter | In/Out | Description | Other Info |
|---|---|---|---|
| SMTP connection | In | SMTP connection information. | Connection type: sysSMTP |
| To email | In | The email address to send to, with multiple addresses separated by comma. Email addresses should be in either plain inbox-host format '@', or must be in fully quoted displayname format '"Lastname, Firstname username@example.com"'. | |
| From email | In | The email address the message should appear to come from. Note that only a singular sending address is allowed. If this is not specified, the module will default to the From or SendAs setting if it is defined in the SMTP Connection. | |
| Subject | In | The subject line of the email message. While this value can be blank, it is not recommended. | |
| Message body header | In | The header text or CSS styling to insert above the message body. | |
| Message | In | The body of the email message. While this value can be blank, it is not recommended. | |
| Message body footer | In | The footer text to insert below the message body, usually used for automatic signature lines, or disclaimer text. | |
| File source | In | A file, or list of files, as a fully qualified pathname(s), to attach to the email message. | |
| Priority | In | Choices: Low, Normal, HighWhat priority level should the email message be sent as? |
Default: Normal |
| Log output level | In | Choices: Minimal, VerboseThe level of execution detail you want to appear in the log. |
Default: Minimal |
| Message Digest | Out | The message digest of a successfully composed message. | |
| Message Sent | Out | The UTC date/time the successfully composed message was sent. |
(Italics = required parameters)
Notes
The module [Email] Send Message does exactly what you are already probably thinking it does. It allows us to send email messages. The SMTP Connection parameter is a defined SMTP Server that you can either supply all the manual properties for. Or the easier way is to setup a centralized connection in the JobServer Connections configuration.
You can send a single email to multiple recipients at once by adding all the email addresses to the To Email field. When doing so, all the recipients will see each others addresses in the To field for the email message. When sending to multiple addresses, you separate each address with a comma.
Last Updated:
10/3/2023 1:06:49 AM