Activities

Connect to Mailbox
Disconnect from Mailbox
Get Emails
Send Email

Connect to Mailbox

This activity connects to the specified Mailbox, by using IMAP or POP3 protocols.

Activity Parameters

The Connect to Mailbox activity parameters can be provided by manual inserted values or via IN arguments or variables:

Authentication:

Host (text box editor type) (type: string): the mailbox host IP. For example, if properly configured, the Exchange Server's IP can be used (for Exchange and IMAP4 options need to be enabled on the mail server).
Password (password box editor type) (type: string): the mailbox username's password.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
Port (text box editor type) (type: string): the mailbox port number.
Protocol (combo box type) (type: string): the protocol which will be used for connection. The available options are IMAP and POP3.
Use SSL (combo box type) (type string): specify whether to use SSL or not
Username (text box editor type) (type: string): the username for mailbox authentication. If left empty, windows session credentials are used.

The Read Only Output variable are the possible output values that the activity will provide:

Connection (type: object): outputs a Mailbox connection. The Output of this activity should be used as Input for all Connection parameters used for all activities placed under Email category..

Execution: the activity will create a connection to the given server, using the provided IP, Port and credentials.

POP3 connection example - by using a Gmail account and allow retrieving the desired emails each time the Get Emails activity will be executed:

insert pop.gmail.com for the gmail's host
insert port 995
select POP3 for the protocol
select Yes for SSL
insert the username in the full mail address format, e.g. demouser@gmail.com
- insert recent: in front of the username. This command will return by default all the emails from the last 30 days (the emails will be filtered when using the Get Emails activity)
- this command is mandatory to be used, in our google account connection example, so that the mails will be retrieved when a Get Emails activity will be executed second time
- if recent: is not used, then when the activity will be executed again, no email will be found, regardless of the used filters.
insert the password for the given user.

Disconnect from Mailbox

This activity disconnects the specified Mailbox.

Activity Parameters

The Disconnect from Mailbox activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: object): the output from the Connect to Mailbox activity.

Get Emails

This activity gets all the emails by the specified filters.

Activity Parameters

The Get Emails activity parameters can be provided by manual inserted values or via IN arguments or variables:

Filters:

CC Contains (text box editor type) (type: string): filter by the email CC addresses. For multiple addresses, separate them with comma ( , ) (e.g. "mail1@server1.com,mail2@server2.com").
From Contains (text box editor type) (type: string): filter by the email From addresses. For multiple addresses, separate them with comma ( , ) (e.g. "mail1@server1.com,mail2@server2.com").
To Contains (text box editor type) (type: string): filter by the email To addresses. For multiple addresses, separate them with comma ( , ) (e.g. "mail1@server1.com,mail2@server2.com").
Subject Contains (text box editor type) (type: string): filter by the email Subject.
Text Contains (text box editor type) (type: string): filter by the email Text.
Start Date (calendar control) (type: string): filter by the email Start date.
End Date (calendar control) (type: string): filter by the email End date.
Has Attachments (combo box control) (type: string): whether the email has attachments or not. Flowster Studio provides True (with attachments), False (without attachments) and Any as options.

Parameters:

Attachments Path (folder selection window and also text box editor): the path where the attachments will be downloaded. If left empty, the attachments won't be downloaded. The activity will create new sub-folders in the selected directory with the email's subject as Name.
Connection (text box editor type) (type: object): the output from the Connect to Mailbox activity.

SMTP Filters:

Location (text box editor type) (type: string): the Mailbox folder where the emails will be searched for. Flowster Studio provides Inbox, Drafts, Sent Items and Deleted Items as options.
Mark as Read (combo box control) (type: string): whether to mark the retrieved emails as Read or not after being processed.
State (combo box control) (type: string): the state of the retrieved email. Flowster Studio provides Read (there will be checked only the Read emails), Unread (there will be checked only the Unread emails) and Any as options.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<dictionary<string,string>>): outputs a collection of mails and their properties.To use the elements of the collection, use Get Element From Collection activity.
Output Rows Count (type: int32): outputs the number of unread mails found on the specified Mailbox.

Execution: depending on the given input parameters, the activity will check the mailbox and will retrieve all e-mails that match the conditions. In our example, the activity will search for:

e-mails between 01.01.2016 and 29.02.2016
e-mails in the Inbox folder
e-mails with the "Manual Shutdown - STATUS" subject
e-mails sent to demo@fmrp,intern
e-mails with status Unread
e-mails with or without attachments
e-mails will not be marked as Read

A full example of using this activity with all fields can be seen below:

Send Email

This activity sends an email according to certain specifications.

Activity Parameters

The Send Email activity parameters can be provided by manual inserted values or via IN arguments or variables:

Addresses:

Bcc (text box editor type) (type: string): comma ( , ) or semicolon ( ; ) separated email addresses (e.g. "mail1@server1.com,mail2@server2.com" or "mail1@server1.com;mail2@server2.com" or "mail1@server1.com,mail2@server2.com;mail3@server3.com")
Cc (text box editor type) (type: string): comma ( , ) or semicolon ( ; ) separated email addresses (e.g. "mail1@server1.com,mail2@server2.com" or "mail1@server1.com;mail2@server2.com" or "mail1@server1.com,mail2@server2.com;mail3@server3.com")
From (text box editor type) (type: string): the "From" Email Address.
To (text box editor type) (type: string): the "To" email address.

Authentication:

Host (text box editor type) (type: string): the mailbox host IP. The Exchange Server IP can be also used, as seen in the screenshot above.
Password (password box editor type) (type: string): the password of the provided username.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
Port (text box editor type) (type: string): the mailbox port number. For Exchange, the default port 25 can be used.
Secure (combo box control) (type: string): False or True, for SSL enabling/disabling.
Username (text box editor type) (type: string): the username for mailbox authentication. If left empty, windows session credentials are used.

Message:

Content (text box editor type) (type: string): the content of the email.
File Attachment (file browser and text box editor type) (type: string): single file that will be sent with the email.
File Attachments (collection editor, file browser and text box editor type) (type: string): multiple files that will be sent with the email.
Priority (combo box control) (type: string): the priority of the message: High, Low or Normal.
Subject (text box editor type) (type: string): the email subject.

Parameters:

Content Formatted (text box editor type) (type: string): the input content to be send as the email's Content (Body) if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Input String parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable and will send it as the e-mail's body (content).

Execution: the activity will send an e-mail to the provided address(es), with the given information (Subject, Content, Priority, Attachment(s)).

Browser not supported