Activities

• Connect to Exchange
• Disconnect from Exchange
• Copy Item
• Create and Send E-mail
• Create Appointment
• Create Contact Group
• Create Draft E-mail
• Create Task
• Delete Item
• Forward E-mail
• Get Appointments
• Get Contact Groups
• Get Contacts
• Get E-mail
• Get Mailbox
• Move Item
• Reply to E-mail
• Set As Out Of Office
• Update E-mail

Connect to Exchange

This activity makes a connection to an Exchange Server's account, providing an Output that can be used as Input for other Exchange related activities (e.g. Get Email, Get Contact, Create Task).

Activity Parameters

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

Parameters:

• Email Address (text box editor type) (type: string): the activity will connect to this e-mail account, on the Exchange Server.
• Exchange URL (text box editor type) (type: string): the Exchange URL of the desired exchange server (e.g. https://exchange.domain.com/ews). If this parameter is specified, then the Email Address parameter is not needed. If Email Address and Exchange URL parameters are not specified, then only the activities under the Administration folder can be used.
• Exchange Version (combo box control) (type: string): the exchange server's version, which can be selected from a dropdown list. Flowster Studio provides the following versions: Exchange 2007 SP1, Exchange 2010, Exchange 2010 SP1, Exchange 2010 SP2, Exchange 2013, Exchange 2013 SP1, Exchange 2016.
• Password (password box editor type) (type: string): the password used to logon to the Exchange server. If left empty, it will connect by using the default credentials of the currently logged in user.
• Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the remote computer. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
• Server Name (text box editor type) (type: string): the name or the IP of the Exchange Server where the activity should connect.
• Username (text box editor type) (type: string): the username used to log on to Exchange server.

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 Exchange category.
  
  

 

Disconnect from Exchange Server

This activity disconnects the specified Exchange Server.

Activity Parameters

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

Parameters:

• Connection (text box editor type): the mailbox connection. The output from Connect to Mailbox activity should be used as Input for this parameter.

Copy Item

This activity copies an item to another folder on the specified Exchange Server.

Activity Parameters

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

Filters:

• Location (combo box editor type) (type: string): the mailbox folder where the item will be copied. The default value is set to the Inbox folder.

Parameters:

• Item ID (text box editor) (type: string): the ID of the item to be copied. An output from the Get activities can be used as Input (e.g. Get Email).
  
  

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

• Output status  (type: boolean): outputs the result status. If the file was moved successfully then TRUE, otherwise FALSE.

Execution: the activity will create a copy of the given item into the given location. In our example, it will create a copy of an e-mail into the Drafts folder.

Create and Send E-Mail

This activity creates and sends an email message to one or more recipients.

Activity Parameters

The Create and Send E-mail activity parameters can be provided by manual inserted values or via IN arguments or variables:

Addresses:

• Bcc (text box editor type) (type: string): the "Bcc" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• CC (text box editor type) (type: string): the "Cc" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• To (text box editor type) (type: string): the "To" email address.

Message:

• Content (text box editor type) (type: string): the content of the email.
• File Attachments (file browser and text box editor type) (type: string): attach the file(s) that will be sent with the email, by clicking the  button and selecting the desired file with the Add button:
  
• 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:

• Connection (text box editor type): the mailbox connection. The output from Connect to Mailbox activity should be used as Input for this parameter.
• Content Formatted (text box editor type) (type: string): the input content to be send as the e-mail's 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 Content parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable and will use it as the e-mail's body.
  
  

Create Appointment

This activity creates new appointment.

Activity Parameters

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

Parameters:

• Body (text box editor type) (type: string): the details about the appointment.
• Subject (text box editor type) (type: string): the subject of the appointment.
• Start (calendar control) (type: string): the start time of the appointment. The required format is "dd/MM/yyyy hh:mm:ss".
• End (calendar control) (type: string): the end time of the appointment. The required format is "dd/MM/yyyy hh:mm:ss".
• Required Attendees (text box editor type) (type: string): the comma separated list of email addresses. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• Is All Day event (text box editor type) (type: string): whether the appointment is an all-day event or not.

Create Contact Group (Valid only for Exchange Exchange2010 or later versions)

This activity creates new contact group.

Activity Parameters

The Create Contact Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Display Name (text box editor type) (type: string): the name of the contact group.
• Members (text box editor type) (type: string): the list of members associated with contact group. Comma separated list of email addresses (for example, "demo@fmrp.intern,support@flowster.de").

Execution: the activity will create a new contact group for the account where the activity is connected to.

The contact group can be seen in the user's People tab:

Create Draft E-Mail

This activity creates an email which will be sent to the Drafts folder.

Activity Parameters

The Create Draft E-mail activity parameters can be provided by manual inserted values or via IN arguments or variables:

Addresses:

• Bcc (text box editor type) (type: string): the "Bcc" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• CC (text box editor type) (type: string): the "Cc" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• To (text box editor type) (type: string): the "To" email address.

Message:

• Content (text box editor type) (type: string): the content of the email.
• File Attachments (file browser and text box editor type) (type: string): attach the file(s) that will be sent with the email, by clicking the  button and selecting the desired file with the Add button:
  
• 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:

• Connection (text box editor type): the mailbox connection. The output from Connect to Mailbox activity should be used as Input for this parameter.
• Content Formatted (text box editor type) (type: string): the input content to be saved as the draft's body content 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 Content parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable.
  
  

Create Task

This activity creates a new task.

Activity Parameters

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

Parameters:

• Body (text box editor type) (type: string): the details about the task.
• Due date (calendar control) (type: string): the date and the time the task is due to. The required format is "dd/MM/yyyy hh:mm:ss".
• Importance (combo box control) (type: string): the importance of the task: High, Low or Normal. 
• Subject (text box editor type) (type: string): the subject of the task.

Delete Item

This activity deletes an item.

Activity Parameters

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

Parameters:

• ID (text box editor type) (type: string): the ID of the item to be deleted. An output from the Get activities can be used as Input (e.g. Get Email).
• Move to Deleted Items (combo box control) (type: string): whether to move the deleted item to the "Deleted Items" folder or remove it permanently.

Execution: the activity will delete the given item from the account where the activity is connected to.

Forward E-Mail

This activity forwards email messages.

Activity Parameters

The Forward E-mail activity parameters can be provided by manual inserted values or via IN arguments or variables:

Addresses:

• Bcc (text box editor type) (type: string): the "Bcc" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").

Parameters:

• Body Prefix (text box editor type) (type: string): the prefix that will be prepended to the original message's body when the reply is created.
• Body Prefix Formatted (text box editor type) (type: string): the input content to be sent as the forward email's body content 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 Body Prefix parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable.
• CC (text box editor type) (type: string): the "CC" email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• ID (text box editor type) (type: string): the ID of the existing e-mail message to forward to. An output from the Get activities can be used as Input (e.g. Get Email).
• To (text box editor type) (type: string): the "To email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
  
  

Get Appointments

This activity gets the appointments on the specified Exchange Server.

Activity Parameters

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

Parameters:

• Search Folder (text box editor type) (type: string): the folder in which to search the item. In our example, the activity will search for appointments e-mails in the Inbox folder.
• Start (calendar control) (type: string): the start time of the appointment. The required format is "dd/MM/yyyy hh:mm:ss".
• End (calendar control) (type: string): the end time of the appointment. The required format is "dd/MM/yyyy hh:mm:ss".

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

• Output  (type: collection<collection<string>>): outputs a collection of folders and their properties. To use the elements of the collection, use Get Element From Collection activity.
• Output Count  (type: int32): outputs the counter for the emails found.
• Output ID  (type: string): outputs the ID of the first mail found with the specified filter.

Get Contact Groups

This activity finds all contact groups on the specified Exchange Server mailbox.

Activity Parameters

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

Parameters:

• Connection  (type: object): the Connect to Exchange activity output.

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

• Output  (type: collection<collection<string>>): outputs a collection of folders and their contact groups. To use the elements of the collection, use Get Element From Collection activity.

Execution: the activity will search and return a collection with all the Contact Groups defined for the account where the activity is connected to.

In order to read the Output variable (in our example the variable name is FoldersCollection), there will be used a For Each and a Get Element From Collection activity:

The For Each is used to extract a collection from another collection, the variable being of type Collection<Of Collection<Of String>>. The extracted Collection<Of String> will be assigned to the Iterator variable.

The Get Element From Collection activity will take the Iterator as the Collection Input, extracting the String's value from it.

Get Contacts

This activity gets all the contacts for the mailbox on the specified Exchange Server.

Activity Parameters

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

Parameters:

• Connection  (type: object): the Connect to Exchange activity output.

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

• Output  (type: collection<collection<string>>): outputs a collection of folders and their contacts. To use the elements of the collection, use Get Element From Collection activity.

Execution: the activity will check and return all objects of type Contact for the account where the activity is connected to.

In order to read the Output variable (in our example the variable name is FoldersCollection), there will be used a For Each and a Get Element From Collection activity:

The For Each is used to extract a collection from another collection, the variable being of type Collection<Of Collection<Of String>>. The extracted Collection<Of String> will be assigned to the Iterator variable.

The Get Element From Collection activity will take the Iterator as the Collection Input, extracting the String's value from it.

Get Email

This activity retrieves specific filtered e-mails from a given Exchange Server, with their ID, Subject, Date Time and Content.

The activity's main filter is the mailbox Location (by default it will be set to Inbox), followed by Start and End dates and Subject.

Activity Parameters

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

Filters:

• Location (combo box control) (type: string): the Mailbox folder where the items will be searched for. The default value is set to the "Inbox" folder. In the image below it can be seen an email configuration for a Demo account:

Parameters:

• Attachments Path (folder selector 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 this directory with the email's subject as Name, where the attachments will be copied.
• Connection (text box editor) (type: string): the output from the Connect to Exchange Server activity.
• Search Sub-folders (text box editor type) (type: boolean): indicates whether to search in sub-folders. If set to "False", it will search only in the parent location (e.g. Inbox). If set to "True", it will search in the sub-folders located under the parent location.
• Start Date (calendar control) (type: string): the date since when the e-mails should be searched. The required format is "dd/MM/yyyy hh:mm:ss".
• End Date (calendar control) (type: string): the date until the e-mails should be searched. The required format is "dd/MM/yyyy hh:mm:ss".
• Subject Filter (text box editor type) (type: string): the filter for the email subject. The activity will search e-mails with the given subject, between the given dates (Start and End dates).

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

• Output  (type: collection<collection<string>>): outputs a collection of folders and their properties.
• Output Count  (type: int32): outputs the counter for the emails found.
• Output ID  (type: string): outputs the ID of the first mail found with the specified filter.

Get Mailbox

This activity gets the mailbox on the specified Exchange Server.

Activity Parameters

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

Parameters:

• Connection  (type: object): the output of the Connect to Exchange activity.

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

• Output  (type: collection<collection<string>>): outputs a collection of folders and their properties. To use the elements of the collection, use Get Element From Collection activity.
  
  

Execution: the activity will extract the main information regarding the mailbox for the user where the activity is connected to (for example Folders, Subfolders, E-mails, Tasks etc.):

In order to read the Output variable (in our example the variable name is FoldersCollection), there will be used a For Each and a Get Element From Collection activity:

The For Each is used to extract a collection from another collection, the variable being of type Collection<Of Collection<Of String>>. The extracted Collection<Of String> will be assigned to the Iterator variable.

The Get Element From Collection activity will take the Iterator as the Collection Input, extracting the String's value from it.

Move Item

This activity moves an item to another folder on the specified Exchange Server.

Activity Parameters

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

Parameters:

• Location (combo box control) (type: string): the mailbox folder where the item will be moved. The default value is set to the Inbox folder.

Parameters:

• Item ID (text box editor) (type: string): the id of the item to be moved. An output from the Get activities can be used as Input (e.g. Get Email). In our example the parameter is bound to the Output ID variable from the Get Email activity, which contains the ID of the first found e-mail.

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

• Output Status (type: boolean): outputs the result status. If the file was moved successfully then TRUE, otherwise FALSE.

Execution: the activity will move the given item into the new location. 

Reply To E-Mail

This activity replies to email messages.

Activity Parameters

The Reply to E-mail activity parameters can be provided by manual inserted values or via IN arguments or variables:

Addresses:

• Bcc (text box editor type) (type: string): comma separated email addresses.

Parameters:

• Body Prefix (text box editor type) (type: string): the prefix that will be prepended to the original message's body when the reply is created.
• Body Prefix Formatted (text box editor type) (type: string): the input content to be sent as the reply's body content 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 Body Prefix parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable.
• CC (text box editor) (type: string): comma separated email addresses.
• ID (text box editor type) (type: string): the id of the existing e-mail message to reply to. An output from the Get activities can be used as Input (e.g. Get Email).
• Reply to All (combo box control) (type: string): bind to a variable containing the encrypted password for the remote computer. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).

Set As Out Of Office

This activity sets an email address as out of office for a determined period of time.

Activity Parameters

The Set As Out Of Office activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Email Address (text box editor type) (type: string): the email address which will be set as out of office.
• End Time (text box editor type) (type: string): the end time of the out of office period. expected format is "dd/MM/yyyy HH:mm:ss".
• External Audience (combo box control type) (type: string): set whether senders from outside the user's organization will receive OutOfOffice reply emails. Values: All | Known | None
• External Reply (text box editor type) (type: string): the email body that will be sent to the recipients outside the organization, only used if the "External Audience" parameter is different than "None".
• Internal Reply (text box editor type) (type: string): the email body that will be sent to the recipients inside the organization.
• Start Time (text box editor type) (type: string): the end time of the out of office period. expected format is "dd/MM/yyyy HH:mm:ss". If left blank, the value is the current time of the execution.

Execution: the activity will set the given e-mail address as out of office, with the specified Start and End Date and Time.

Update Email

This activity updates the specified email.

Activity Parameters

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

Addresses:

• Bcc (text box editor type) (type: string): the "Bcc" new email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• CC (text box editor type) (type: string): the "Cc" new email address. For multiple email addresses, separate them with comma (e.g. "mail1@demo.com,mail2@demo.com").
• To (text box editor type) (type: string): the "To" new email address.

Message:

• Content (text box editor type) (type: string): the content of the new email.
• File Attachments (file browser and text box editor type) (type: string): attach the new file(s) that will be sent with the email, by clicking the  button and selecting the desired file with the Add button:
  
• Priority (combo box control) (type: string): the new priority of the message: High, Low or Normal.
• Subject (text box editor type) (type: string): the new email subject.

Parameters:

• Connection (text box editor type): the mailbox connection. The output from Connect to Mailbox activity should be used as Input for this parameter.
• Content Formatted (text box editor type) (type: string): the input content to be updated as the email's body content 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 Content parameter. For example, the $using:DemoString syntax will take the value stored in the DemoString variable.
• ID (text box editor type) (type: string): the id of the existing e-mail message to be updated. An output from the Get activities can be used as Input (e.g. Get Email).