Introduction
- The MailFragment element is used to specify the content, format and recipients of e-mail notifications.
- In addition mail server connection settings are used from JS7 - Job Resources
MailFragment
Attributes
The MailFragment element supports the following attributes:
| Attribute | Usage | Description |
|---|---|---|
name | Required | Unique name of the fragment. |
job_resources | Required | A list of JS7 - Job Resources that specify mail server connection settings. |
content_type | Optional | Content type of the e-mail. Possible values:
Default: |
charset | Optional | Charset of the e-mail. Default: |
encoding | Optional | Encoding of the e-mail. Possible values:
Default: |
priority | Optional | Priority of the e-mail. Possible values:
Default: |
Attributes from Job Resources
The following settings are required to be provided by one of the Job Resources that are assigned a MailFragment:
| Attribute | Usage | Description |
|---|---|---|
mail.smtp.host | Required | Host name or IP address of the mail server. |
mail.smtp.port | Required | The port number for SMTP access to the mail server. |
Optional settings include - but are not limited to - settings specific for your mail server, e.g. for authentication:
| Attribute | Usage | Description |
|---|---|---|
mail.smtp.timeout | Optional | Socket read timeout for mail server connection. |
mail.smtp.connectiontimeout | Optional | Socket connection timeout for mail server. |
mail.smtp.user | Optional | User name for the account that sends e-mail. |
mail.smtp.password | Optional | Password for the account that sends e-mail. |
mail.smtp.ssl.protocols | Optional | Specifies the TLS protocol version, e.g. TLSv1, TLSv1.1, TLSv1.2, should an SSL connection be used |
Basically any settings with the prefix mail.smtp. can be assigned a Job Resource that is used with the MailFragment. JS7 makes use of JavaMail, therefore find a list of available settings e.g. from https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html.
Additional optional settings include settings specific for the E-Mail addresses:
| Attribute | Usage | Description |
|---|---|---|
from | Optional | E-mail address of the account that sends e-mail. |
from_name | Optional | Name for the E-mail address of the account that sends e-mail. |
to | Optional | E-mail address of the recipient(s) of a notification e-mail. |
cc | Optional | E-mail address of the recipient(s) of a carbon copy notification e-mail. |
bcc | Optional | E-mail address of recipient(s) of a blind carbon copy notification e-mail. |
Elements
The following elements are nested inside the MailFragment element:
| Element | Element description | Description |
|---|---|---|
MessageRef | Required, only once inside of the MailFragment element | Body of an e-mail notification that is provided by the referenced Message element. |
Subject | Required, only once inside of the MailFragment element | Subject of an e-mail notification. |
From | Optional or only once inside of the MailFragment element | E-mail address of the account that sends e-mail. |
To | Optional or only once inside of the MailFragment element | E-mail address of the recipient(s) of a notification e-mail. |
CC | Optional or only once inside of the MailFragment element | E-mail address of the recipient(s) of a carbon copy notification e-mail. |
BCC | Optional or only once inside of the MailFragment element | E-mail address of recipient(s) of a blind carbon copy notification e-mail. |
Subject
Subject of an e-mail notification.
The Subject can contain Monitor Variables.
MessageRef
The Message element referenced specifies the body of an e-mail notification.
The Message can contain Monitor Variables.
Overview
Content Tools