CreateProcessInstanceFromIncomingMailWithVariables

Description

This ActionHandler starts a process instance from every unread email from a folder from a mailbox. 3 process variables with the receiver, the subject and the body of the corresponding email are stored in the respective instance.


Class

com.dooris.bpm.actionhandler.CreateProcessInstanceFromIncomingMailWithVariables

Webservice name

ProcessInstanceManager

Webservice method

createProcessInstancesByHandler

Parameter

In the parameter field, the first thing is the ActionHandler class, separated with a comma (,) followed by the rest of the parameters. These are separated with a semicolon (;).

Parameter name

Default value

Description

Valid examples

Parameter name

Default value

Description

Valid examples

email

 

The email of the mailbox.

 

password

 

The password used to access the desired email account.

 

port

 

This provides information on the port corresponding to the email address and the host. Frequently used ports are: 110 Pop 995 Pop including encryption 143 IMAP 993 IMAP with encryption

 

host

 

e.g., pop3.gmail.com or imap.gmail.com (very often this will entail either pop or pop3 or IMAP. SMTP is far less common!).

An IMAP mailbox will be necessary if moving all emails to other folders. The kind of protocol to use is dependent on the mailbox being employed.

If both common protocols are supported by the web service, then IMAP should be selected as the preferred protocol.

Basically, a separate mailbox should be used for each timer and process definition in order to ensure that the timer functions consistently.

 

folder​

 

The folder of the mailbox, where the timer looks for unread emails.

 

processdefinition

 

This parameter specifies the process definition from which an instance is to be started.

 

subjectName

 

Name of the variable, where the subject of the email is stored.

 

bodyName

 

Name of the variable, where the text of the email is stored.

 

fromName

 

Name of the variable, where the sender of the email is stored.

 

 

Example:

Parameter: com.dooris.bpm.actionhandler.CreateProcessInstanceFromIncomingMailWithVariables,email;password;port;host;folder;processDefinition;subjectName;bodyName;fromName

 

Dependencies

Timer: https://tim-doc.atlassian.net/wiki/spaces/eng/pages/228561696