If you have trouble understanding how the action works, check the descriptions: Application, Setter, Conditional execution, Component parameters
Basic information
Category: Email
Available from version: 1.0.5
Description
The task sends e-mails according to a predefined template (specified via the path to a file on the server or the name of the template in the process configuration). It has predefined tags, e.g. searching for e-mails on the basis of a role identifier or automatically inserting values into the template between the "@" and "@" tags. The application has the possibility to attach a document from the process as an attachment in an email. The configuration of the mail server can be found in the system configuration section (Mailbox configuration). As of version 1.0.11, it is possible to save the content of a sent e-mail as a document in the PlusWorkflow system.
Configuration parameters
| Parameter name | From version | Description | Parameter type | Default value | Field type | Notes and restrictions |
|---|---|---|---|---|---|---|
| Mailbox * | 1.0.49 | Mailbox defined in the system configuration | Text | Value list | ||
| Template source * | 1.0.7 | Storage location of the email template to be sent | Text | Value list | ||
| Template path * | 1.0.7 | Provide a direct path to the file on the server | Text | Editable field | Html template, which can contain special tags to be replaced with the corresponding values. See table Tab_2. | |
| Template name * | 1.0.7 | Name of the template from the process configuration | Text | Editable field | Html template, which can contain special tags to be replaced with the corresponding values. See table Tab_2. | |
| Subject * | 1.0.5 | Email subject | Text | Editable field | May include template tags - possible use of "@" tags e.g. "@processname@" See table Tab_2. | |
| To | 1.0.5 | List of e-mail addresses to send the message to | Text array | Editable field | Supports multiple emails given after "," or ";". Possibility to use email tags. See table Tab_1. | |
| Copy | 1.0.5 | Optional parameter. List of addresses to send a copy of the email | Text array | Editable field | Supports multiple emails given after "," or ";". Possibility to use email tags. See table Tab_1. | |
| Hidden copy | 1.0.5 | Optional parameter. List of addresses to send a blind copy of the email | Text array | Editable field | Supports multiple emails given after "," or ";". Possibility to use email tags. See table Tab_1. | |
| The name of the variable | 1.0.5 | Optional parameter. The name of a variable in the template between the @ and @ characters. | Text array | Value list | Parameter useful when you want to use one template on several processes and map tags that are not present in the current process. | |
| The value of the variable | 1.0.5 | Optional parameter. The value to be inserted in place of the variable name in the template | Text array | Editable field | ||
| One message to everyone * | 1.0.5 | Sends one email to several addressees. If NO, each addressee is treated separately and gets a separate email. | Logical | YES | ||
| Feedback - Successful sending | 1.0.5 | Optional parameter. Returns a list of email addresses that have been successfully sent | Variable | Editable field | ||
| Feedback - Failed sending | 1.0.5 | Optional parameter. Returns a list of "To" email addresses that have not been successfully sent | Variable | Editable field | ||
| Comment * | 1.0.5 | Adds commentary on sent and unsent emails for recipients on the "To" list | Logical | YES | ||
| Attachments * | 1.0.7 | Adds process documents to emails as attachments | Logical | NO | ||
| Source * | 1.0.33 | Selection of the method by which documents to be sent in attachments are to be found. Possible values:
| Text | Editable field | ||
| File ids * | 1.0.33 | Parameter needed to select the files you want to send in attachments | Text array | Value list | ||
| Document class | 1.0.7 | Optional parameter. When the value is empty, it adds all documents from the process to the mail (if this option is enabled), otherwise it adds only documents from the selected document classes | Text array | Value list | The order of document classes matters when adding attachments. That is, documents from class1 are added first then from class2 etc. | |
| Filter by document name | 1.0.28 | A regular expression that filters documents from a selected class for sending in an e-mail attachment | Text array | Editable field | A blank field will result in the retrieval of all documents from the selected class. Examples: file name: IMG5822996601453555121.pdf regular expressions that will find this file:
| |
| Prefix | 1.0.11 | Prefixes added to the name of the uploaded file from the selected document classes. | Text array | Editable field | E.g. When the document has the name "fact0001.pdf", and the prefix parameter has been set to the value "invoice-", the attachment named "invoice-fact0001.pdf" will come in the email. If the parameter is not set, the document will be added without the prefix, | |
| Save email * | 1.0.11 | Saves the sent message as a new html document | Logical | NO | This option allows you to save the generated email content as an html document added to the archive. | |
| Document name * | 1.0.11 | Name of the new document | Text | Editable field | File name. You can specify it without extension, in which case it will add ".html" by default. | |
| Document description | 1.0.11 | Document description. If it is empty, then the class name will be written in the description | Text | Editable field | The name of the html document created with the email content. | |
| Document class * | 1.0.11 | The name of the class to which to write the email | Text | Value list | List of document class selections from the current system. | |
| Attach to the process * | 1.0.11 | Attaches a new document to an existing process | Logical | YES | ||
| Email header * | 1.0.11 | Adds an email header to the body of the message | Logical | NO | Adds an optional default header to the document with information From Whom, To Whom, the subject of the message and a list of attachments. See email header template | |
| Email header template | 1.0.11 | Path to custom HTML template containing email header tags | Text | Editable field | Path to custom html template with email information. Possibility to use special tags See table Tab_3. For blank value the default template provided with the plugin is used See Default email header template | |
| Save as new version of the document * | 1.0.11 | Saves as new version of document when index values match with document already in archive | Logical | NO | ||
| 1.0.11 | The name of the index from the class to which we are saving the email content | Text array | Value list | Selection list after selecting the class of document to be saved. | ||
| Index value | 1.0.11 | The value that will be stored in the index when saving the email content documents | Text array | Editable field |
Configuration example
Change log
1.0.5
- Added component
1.0.7
- Adding the ability to attach files to emails
1.0.11
- Adding a prefix to attachments
- Support for saving email content
- Improving the order of attaching attachments to emails
1.0.14
- Fix a bug when building email addresses when the parameter value is empty.
1.0.16 (applicable documentation)
- Sending an encrypted attachment (decryption during sending)
- Improve logs on failure and success of sending messages
1.0.49
- Added a new "Mailbox" parameter
1.0.62
- Added ability to use @@rows@@ and @@end_rows@@ tags
Add Comment