Handler - AutoMailSender
AutoMailSender handler generates and sends an automatic email message comprising the information you define in the parent attribute's metadata.
In order to send email, you must configure all the mail.transport settings in the platform settings.
AutoMailSender handler is mainly used for process and workflow management, sending notifications when something happens.
AutoMailSender handler sends an email when the defined triggering conditions are met - by default, every time the attribute value changes, but different conditions can be configured with Send once, Send if attribute has value and Do not check for change metadatas. For example, a mail can be sent only once when a new data card is created, or whenever an existing attribute value changes. With attribute metadata, you can define what information the mail contains - for example, a default mail subject - as well as the recipient and sender email addresses. In addition, in metadata you can also denote attributes whose values you want to include from the parent data card into the mail.
It is also possible to insert folder metadata that will add recipients to emails sent from data cards in that folder. You can use the following folder metadata:
automail_recipient [email address]automail_recipient_[attribute_code] [email address]
The first code defines an email recipient address that will be used for all attributes which have an AutoMailSender handler inside the folder. The code in the second example defines an email recipient address that will be used only for the specified attribute in that folder (the attribute naturally needs to have an AutoMailSender handler). The latter code can be used when the same folder has data cards from different templates that have an AutoMailsender configured. This way you can configure the recipient to be added only to emails sent from data cards of a dedicated template. The folder metadata never overrides any other AutoMailSender handler settings, it is used in addition to them.
The following tables provide information on the attribute settings and metadata requirements for AutoMailSender handler. Compulsory metadata is provided in the Required attribute metadata table, including proposals for possible metadata values. Accordingly, optional metadata is presented in the Optional attribute metadata table.
Table 1. Attribute Settings
| Handler name | Datatype |
|---|---|
| AutoMailSender | Any |
Table 2. Required Attribute Metadata
| Name | Value | Description |
|---|---|---|
| Sender email address | [email addresses] |
Sender's email address. If you want to insert several senders for the email, denote them each in an own row. This setting is not required, if |
| Recipient email address | [email addresses] |
Recipient's email address. If you want to insert several recipients into the email, denote them each in an own row. This setting is not required, if |
| Mail subject | [email addresses] |
Subject displayed in the email subject field. |
$attribute_code$ |
You can include the keyword $attribute_code$ in a header, subject, and footer metadata, to add any attribute value from the same template to the mail section in question. |
|
$name$ |
You can include the keyword $name$ in the header, subject, body and footer metadata, to include the data card name automatically in the mail section in question. |
|
$template$ |
You can include the keyword $template$ in the header, subject, body and footer metadata, to include the template name automatically in the mail section in question. |
|
$value$ |
You can include the keyword $value$ in the header, subject, body and footer metadata, to add the attribute value of this attribute automatically to the mail section in question. |
|
$from$ |
You can include the keyword $from$ in the header, subject, body and footer metadata, to add the sender of this mail to the mail section in question. |
Example: With AutoMailSender you can generate an automatic message text to be sent when conditions you define in the attribute metadata are met. You may want to, for example, receive an automatic alert every time when your company car owner changes. For that purpose, you include an AutoMailSender in the attribute Owner and use the following Header metadata value:
"Data card $name$ on the template $template$ has been changed on $change_date$. The new value in the field Owner is $value$"
"Data card Volkswagen Passat 1.6 Firstline on the template Car has been changed on 24.5.2004. The new value in the field Owner is JOHN SMITH."
Table 3. Optional Attribute Metadata
| Name | Value | Description |
|---|---|---|
Mail header |
[Dear Mr.] |
Header before the message body.
|
Mail body |
[Body text] |
Message body.
|
Mail footer |
[With kind regards, ] |
Footer after the message body.
|
Send if attribute has value |
[attribute_code] |
Message is sent only if the attribute with given code has a value. Only attributes from the data card itself are allowed. Value from reference is no supported even though the attribute selector allows to select one. If multiple
Note: |
Send once |
on/off (send_once) |
If set to on, the mail is sent only once for each data card. If the (For backward compatibility, value |
Sender(s) from attribute |
[attribute_code] |
Email addresses that are data card values. Values can be on this template or on a template that is linked to this template. The path to the attribute is defined as follows:
If there are more than one Example (send a message from a specific support group):
This setting is required, if sender metadata is not defined. |
Recipient(s) from attribute |
[attribute_code] |
Email addresses that are data card values. Values can be on this template or on a template that is linked to this template. The path to the attribute is defined as follows:
If there are more than one Example (send a report to the project manager of a client company):
This setting is required, if recipient metadata is not defined. |
CC recipient email address |
Recipient's email address. | Email addresses that are shown in CC-field. |
CC recipient(s) from attribute |
[attribute_code] |
Email addresses that are shown in CC-field. Values can be on this template or on a template that is linked to this template. The path to the attribute is defined as follows:
If there are more than one Example (send a report to the project manager of a client company):
|
BCC recipient email address |
Recipient's email address. | Email addresses that should not be shown to other recipients. |
BCC recipient(s) from attribute |
[attribute_code] |
Email addresses that should not be shown to other recipients. Values can be on this template or on a template that is linked to this template. The path to the attribute is defined as follows:
If there are more than one Example (send a report to the project manager of a client company):
|
Do not check for change |
on/off (do_not_check_for_change) |
If set to on, mail will be sent even if the attribute value does not change. (For backward compatibility, value |
Mail format |
[text/html | text/plain] | Defaults to text/html. The content type of the mail is defined by this meta data. Some special handlers may require text/plain. |
Attachment |
[text/html | text/plain] | Attachments to be sent automatically are defined here. The value should be either a name of a file that has been uploaded to the upload directory, or a reference in the following format: "$attributeCode:anotherAttributeCode$. An example: the template that has the auto mail sender handler has also a file upload handler with the attribute code "attachment_files". Now if the auto mail sender handler's attachment metadata value is set to "$attachment_files$", the auto mail sender handler will attach to the mail all the files that have been uploaded to the file upload handler attachment_files. |
Table of Contents