Keywords
Email Keyword
The purpose of the email extension is to send emails to people during a consultation. Using the extension keywords you can set a subject, a content and recipients of the email. Consultation results can be included in the content of the email and the extension will automatically send the email to the specified users. The following keywords can be used:
| Keyword | Explanation | ||
|---|---|---|---|
| EXTENSION - EMAIL - SUBJECT | The subject of the email. | ||
| EXTENSION - EMAIL - TO | The receiver(s) of the email, comma separated. This field can contain a value reference, too. | ||
| EXTENSION - EMAIL - CC | The carbon copy receiver(s) of the email, comma separated. This field can contain a value reference, too. | ||
| EXTENSION - EMAIL - BCC | The blind carbon copy receiver(s) of the email, comma separated. This field can contain a value reference, too. | ||
| EXTENSION - EMAIL - BODY | The body / contents of the email. | ||
| EXTENSION - EMAIL - SUCCESS_MESSAGE_TEXT | This text will be displayed to the user if the mail was successfully sent. | ||
| EXTENSION - EMAIL - ERROR_MESSAGE_TEXT | This text will be displayed to the user if sending the email failed. | ||
| EXTENSION - EMAIL - DUPLICATE_MESSAGE_TEXT | This text will be displayed to the user if an email with the exact same data was already sent. It will not be sent again. | ||
| EXTENSION - EMAIL - USE - CC | Set this variable to ‘Yes’ to use the value from EXTENSION - EMAIL - CC. | ||
| EXTENSION - EMAIL - USE - BCC | Set this variable to ‘Yes’ to use the value from EXTENSION - EMAIL - BCC. | ||
| EXTENSION - EMAIL - USE - BODY_IS_HTML | Set this variable to ‘Yes’ to indicate that the value from EXTENSION - EMAIL - BODY is in HTML format. Any other value will indicate a plain text body. | ||
| EXTENSION - EMAIL - USE - READ_RECEIPT | Set this variable to ‘Yes’ to add a header to the email that requests a read receipt, i.e. a notification to the sender that the recipient has read the email. | ||
| EXTENSION - EMAIL - ATTACHMENT - FILE | Use this multivalue qualitative variable to specify the list of file pointers that you want to attach in the email. The document generation has to happen before the email keywords are reached, otherwise no document can be attached. The Document Keywords of the document extension can create filepointers to generic documents. See the Generate Bookmark Keyword to attach a bookmark instead. |
||
| EXTENSION - EMAIL - TRIGGER | Set this variable to ‘Send’ to trigger the Match Email Extension to actually send the email. | ||
| EXTENSION - EMAIL - ACTION SUMMARY | This variable needs to be added in a DISPLAY keyword after the TRIGGER keyword:
This will make sure the applicable value (i.e. SUCCESS_MESSAGE_TEXT, ERROR_MESSAGE_TEXT, or DUPLICATE_MESSAGE_TEXT) will be shown to the user. |
||
| EXTENSION - EMAIL - FROM | Deprecated. The sender of the email. The sender of the email should be set under "Server administration > Configuration properties". Under "Mail Properties" the sender's email should be entered. | ||
| EXTENSION - EMAIL - USE - ATTACHMENT_X (X = 1, 2 or 3) | Deprecated. See EXTENSION - EMAIL - ATTACHMENT - FILE. Set this variable to ‘Yes’ to indicate to include attachment 1, 2 or 3. | ||
| EXTENSION - EMAIL - ATTACHMENT_TEMPLATE_X (X = 1, 2 or 3) | Deprecated. See EXTENSION - EMAIL - ATTACHMENT - FILE. The name of the template to use for attachment 1, 2 or 3. | ||
| EXTENSION - EMAIL - ATTACHMENT_FILENAME_X (X = 1, 2 or 3) | Deprecated. See EXTENSION - EMAIL - ATTACHMENT - FILE. The name of the file of attachment 1, 2 or 3 in the email. | ||
| EXTENSION - EMAIL - ATTACHMENT - BOOKMARK | Deprecated. See EXTENSION - EMAIL - ATTACHMENT - FILE. If it is set to "Yes", it will attach a bookmark with the consultation state to the email, if it is no is like this keyword is not present, it ill not do anything. | ||
| EXTENSION - EMAIL - ATTACHMENT - BOOKMARK NAME | Deprecated. See EXTENSION - EMAIL - ATTACHMENT - FILE. Sets the name of the bookmark file attached to the email in case is is there. |
Example
| Keyword | Value |
|---|---|
| EXTENSION - EMAIL - SUBJECT | This is how to send a mail with the Email Extension |
| EXTENSION - EMAIL - TO | John.Doe@E-mail.com |
| EXTENSION - EMAIL - CC | Jane.Doe@E-mail.com |
| EXTENSION - EMAIL - BCC | VALUE(Other people that need to receive the mail) |
| EXTENSION - EMAIL - BODY | Dear person(s),
Here is the email that has been sent by Match. Kind regards, |
| EXTENSION - EMAIL - SUCCESS_MESSAGE_TEXT | Email has been successfully sent. |
| EXTENSION - EMAIL - ERROR_MESSAGE_TEXT | Email has failed to send. |
| EXTENSION - EMAIL - DUPLICATE_MESSAGE_TEXT | An email with exactly the same contents has already been sent. The mail has not been sent again. |
| EXTENSION - EMAIL - USE - BODY_IS_HTML | Yes |
| EXTENSION - EMAIL - USE _ CC | Yes |
| EXTENSION - EMAIL - USE - BCC | No |
| EXTENSION - EMAIL - ATTACHMENT - FILE | mydocument.pdf |
| EXTENSION - EMAIL - TRIGGER | Send |
| DISPLAY | VALUE(EXTENSION - EMAIL - ACTION SUMMARY) |