===== CreateProcessInstanceFromIncomingMailWithVariables =====

==== Description ====

This timer starts a process instance from every unread e-mail from a folder from a mailbox. In this case, 3 process variables with the receiver, the subject and the body of the corresponding e-mail are stored in the respective instance.

----


==== Class ====

<code>
com.dooris.bpm.actionhandler.CreateProcessInstanceFromIncomingMailWithVariables
</code>

----

==== Event Type ====

any


==== Webservice Name ====

<code>
ProcessInstanceManager
</code>

==== Webservice Method ====

<code>
createProcessInstancesByHandler
</code>

----

===== Parameters =====

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


==== email ====

login of the email of the mailbox

==== password ====

The password used to access the desired e-mail account

==== port ====

This provides information on the port corresponding to the e-mail 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 mail box will be necessary if moving all e-mails to other folders. The kind of protocol to use is dependent on the mail box being employed. If both common protocols are supported by the web service, then IMAP should be selected as preferred protocol.

<note important> It is highly recommended to use a separate mail box for each timer and process definition.</note>

==== folder​ ====

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

==== processdefinition ====

This parameter determines the process definition an instance should be started of

==== 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

{{  :software:tim:actionhandler:createprocessinstancefromincomingmailwithvariables.png?direct&  }}

----


==== Dependencies ====

__Timer__: [[:en:software:tim:timer:createprocessinstancesbyhandler|createProcessInstancesByHandler]]