Overview

You can access the MS Outlook features using the features provided by the Outlook library.

To use the Outlook library, the Outlook configurations must be completed in advance on the PC.
For the Outlook configurations, visit Microsoft Support or contact the IT department of your company.

The features provided by the Outlook library are as follows:

Mail sending: SendMail
Mail reception: GetMail, GetMailItem
Mail movement: MoveMail
Mail deletion: DeleteMail
Mail forwarding: ForwardMail
Mail export: ExportMail
Replying to mail: ReplyMail

Use Designer or File Explorer to refer to the samples for the Outlook library.

• On Designer: > Help > Sample > Sample > Outlook

• On File Explorer: C:\Users\user\AppData\Roaming\Brity RPA Designer\samples\Outlook

[Outlook sample project names and related activity cards]

• Other_Samples: DeleteMail, ExportMail, ForwardMail, GetMail, GetMailItem, MoveMail, ReplyMail, SendMail

Common Properties

MORE OPTIONS

MORE OPTIONS properties
Properties	Type	Required	Unit	Auto-setting	Description
On Error	Combination box	N	-	N	Specify an action to carry out when an error occurs at the time of execution. - If not specified: Output errors and exit the task. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project. If a handler is specified: Call the specified handler.

DESCRIPTION

DESCRIPTION properties
Properties	Type	Required	Unit	Auto-setting	Description
DESCRIPTION	Text	N	-	N	Enter the description for the activity card. The description entered in the DESCRIPTION field is used as the description of the activity. A representative value will be displayed in the absence of the DESCRIPTION input.

GetMail

Overview

This activity card fetches the list of mail messages that match specified conditions from the mailbox of a specific mail account.

Application procedures

In the [Output] Mails field, enter the variable to store the fetched mail list.
In the Account field, enter the account to fetch the mail list.
In the Mail Folder field, enter the name of the Outlook mailbox to fetch the mail list.
In the Max Count field, enter the maximum number of the mail messages to fetch.
Set the INPUT and FILTER properties to specify required values and search conditions.

Card properties

GetMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Output] Mails	Variable	Y	-	Y	Specify a variable to store the list of mail messages. (Default: 'this.MailItemList')
N	Account	Text	Y	-	Y	Enter the account to fetch the mail messages.
N	Mail Folder	Text	Y	-	Y	Enter the name of the Outlook mailbox to fetch the mail list.
N	Max Count	Number	Y	-	Y	Enter the number of messages to fetch. If set to “0,” the list of all mail messages will be fetched.
N	Mark As Read	Toggle button	N	-	Y	Specify whether to set the fetched mail messages as read.
N	Unread Messages	Toggle button	N	-	Y	Specify whether to search for unopened messages only.
N	Ignore HTML	Toggle button	N	-	Y	Specify whether to exclude HTML tags in the mail body.
N	Recent First	Toggle button	N	-	Y	Specify whether to search recently received messages first.
N	[FILTER] Sender	Text	N	-	Y	Search messages from a specific sender.
N	[FILTER] Title	Text	N	-	N	Search message titles that include the specified keyword.
N	[FILTER] Body	Text	N	-	N	Search messages that include the keyword in the content.
N	[FILTER] Start Time	Text	N	-	N	Search messages received after the start time.
N	[FILTER} End Time	Text	N	-	N	Search messages received before the end time.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

In the Inbox of the Outlook account, "sample@samsung.com," search for the latest five messages sent by "sample@samsung.com" and display the content of the first message in a message box.

GetMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_GetMail

Used variables

MailItemList = An array variable to store the fetched mail messages.

Used properties

[Output] Mails = this.MailItemList
Account = 'sample@samsung.com'
Mail Folder = 'Inbox'
Max Count = 5
Mark As Read = Off
Unread Messages = Off
Ignore HTML = Off
Recent First = On
Sender = 'sample@samsung.com'

Related/Similar activities

GetMailItem

Overview

This activity card fetches information, including the body content, recipient, and attachment, from the list of mail messages fetched with the GetMail activity card.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Output] Result field, enter the variable to store the fetched mail data.
In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.
Set the Mail Field property to select the mail data, such as the body content, recipient, and attachment, to fetch.
To select the attachment, in the Path field, enter the path to download the attachment file.

Card output properties

Property	Type	Additional comments	Description	Example
Result	String	-	Returns the information of the imported mail. ※ Mail information is determined by Mail Field.	<html><p>contents</p></html>

Property

Type

Additional comments

Description

Example

Result

String

Returns the information of the imported mail.

※ Mail information is determined by Mail Field.

<html><p>contents</p></html>

Card input properties

GetMailItem card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Variable	Y	-	Y	Enter the variable that stores the mail list fetched with the GetMail activity card.
N	Mail Field	Combination box	N	-	Y	Specify mail data items. ※ Mail data items - Body, Recipients, Attachments
N	[INPUT] Path	Text	N	-	N	Enter the path to download the attachment file. It is required only when "Attachment" was selected in the [INPUT] Mail Field property.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

GetMailItems 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_GetMail

See the “Example of utilization” provided for the GetMail activity card.

Related/Similar activities

GetMail

SendMail

Overview

This activity card sends mail messages via Outlook.

Application procedures

In the MAIL property fields, enter the sender, recipient, CC, and BCC, and then specify the message subject, body content, and attachment path.

Card properties

SendMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[MAIL] Sender	Text	Y	-	Y	Enter the email address of the sender. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] Receivers	Text	Y	-	Y	Enter the email address of the recipient. (You can enter multiple recipients by separating each entry with a semicolon. The same applies to the CCs and BCCs fields.) Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] CCs	Text	N	-	Y	Enter the email address of the CCs. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] BCCs	Text	N	-	Y	Enter the email address of the BCCs. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] Subject	Text	N	-	Y	Enter the title of the email. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] Body	Text	N	-	Y	Enter the body of the email. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] Attachments	Text	N	-	Y	Enter the path for the attachment file. (Use semicolon [;] as the separator to add multiple attachment files.) Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] File Size(MB)	Number	Y	MB	Y	Enter the attachment file size. (Default: 20 MB) The allowed attachment file sizes may vary depending on the recipient's mail server configurations. Delete the sample value that is provided by default and enter the actual value.
N	[MAIL] Is HTML	Toggle button	N	-	Y	Specify whether to use the HTML format.
Y	MORE OPTIONS	-	-	-	-	Common property of the Outlook library.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Send an email message titled “Sample Title” to “sample@samsung.com” through Outlook.

SendMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_SendMail

Used variables

None

Used properties

Sender = 'sample@samsung.com'
Receiver = 'sample@samsung.com'
CCs = ''
BCCs = ''
Subject = 'Sample Title'
Body = 'Sample Body Text'
File Size (MB) = 20
Is HTML = Off

Related/Similar activities

ForwardMail, ReplyMail

MoveMail

Overview

This activity card moves received messages to other mail folders within Outlook.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.
In the Mail Folder field, enter the name of the mail folder to move the messages.

Card properties

MoveMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Script	Y	-	N	Enter the variable that stores the mail list fetched with the GetMail activity card.
N	[INPUT] Mail Folder	Variable	Y	-	N	Enter the name of the Outlook mailbox to move the messages.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Fetch a specific mail message from Outlook and move it to the specified mailbox.

MoveMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_MoveMail

Used variables

MailItemList = Variable that stores the mail list of the mailbox
MoveTo = Variable that stores the name of the mailbox to move the messages

Used properties

Mail Item = this.MailItemList[0]
Mail Folder = this.MoveTo

Related/Similar activities

DeleteMail, ExportMail

DeleteMail

Overview

This activity card deletes mail messages received on Outlook.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.

Card properties

DeleteMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Script	Y	-	N	Enter the variable that stores the mail list fetched with the GetMail activity card.
Y	MORE OPTIONS	-	-	-	-	Common property of the Outlook library.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Read the list of mail messages to delete from Outlook and delete them if “1” is entered in the InputBox.

DeleteMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_DeleteMail

Used variables

MailItemList = Variable that stores the mail list of the mailbox

Used properties

[Input] Mail Item = this.MailItemList[0]

Related/Similar activities

MoveMail, ExportMail

ForwardMail

Overview

This activity card forwards mail messages received on Outlook.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.
In the MAIL properties fields, enter the mail addresses of the recipients/CCs/BCCs. (One or more addresses must be entered.)

Card properties

ForwardMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Script	Y	-	N	Enter the variable that stores the mail list fetched with the GetMail activity card.
N	[MAIL] Receivers	Text	Y	-	-	Enter the recipient mail address to forward the mail message.
N	[MAIL] CCs	Text	N	-	-	Enter the CC addresses for the forwarded mail message.
N	[MAIL] BCCs	Text	N	-	-	Enter the BCC addresses for the forwarded mail message.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Read the list of mail messages to forward from Outlook and forward them if “1” is entered in the InputBox.

EorwardMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_ForwardMail

Used variables

MailItemList = Variable that stores the mail list of the mailbox
ForwardTo = Variable that stores the email addresses to forward the messages

Used properties

[Input] Mail Item = this.MailItemList[0]
[MAIL] Receivers = this.ForwardTo

Related/Similar activities

SendMail, ReplyMail

ExportMail

Overview

This activity card exports mail messages received on Outlook and saves them as “.mht,” “msg,” or “.txt” files.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.
Set the Extension property to select the file format to save the exported messages.
In the Path field, enter the path and file name to save the exported file.

Card properties

ExportMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Script	Y	-	N	Enter the variable that stores the mail list fetched with the GetMail activity card.
N	[INPUT] Extension	Combination box	N	-	Y	Select the file extension for saving the mail message. ※ File formats - .mht, .msg, .txt
N	[INPUT] Path	Text	Y	-	N	Enter path and file name to save the message.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Read the list of mail messages to export from Outlook and save the messages as “.mht” files in the specified path (C:\tempmail).

ExportMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_ExportMail

Used variables

MailItemList = Variable that stores the mail list of the mailbox

Used properties

[Input] Mail Item = this.MailItemList[0]
Extension = .mht
Path = 'C:\\tempmail'

Related/Similar activities

MoveMail, DeleteMail

ReplyMail

Overview

This activity card replies to a mail message received on Outlook.

Application procedures

This feature can be used only after fetching the list of mail messages with the GetMail activity card.

In the [Input] Mail Item field, enter the variable that stores the mail list fetched by the GetMail activity card.
In the File Size (MB) field, enter the maximum attachment file size allowed for the message.
In the MAIL property fields, enter the recipients/CCs/BCCs mail addresses and specify the message subject, body content, and attachment path.

Card properties

ReplyMail card properties
Common	Properties	Type	Required	Unit	Auto-setting	Description
N	[Input] Mail Item	Script	Y	-	N	Enter the variable that stores the mail list fetched with the GetMail activity card.
N	[MAIL] Receivers	Text	Y	-	N	Enter the recipient’s email address to send the reply.
N	[MAIL] CCs	Text	N	-	N	Enter the CC email address to send the reply.
N	[MAIL] BCCs	Text	N	-	N	Enter the BCC email address to send the reply.
N	[MAIL] Subject	Text	N	-	N	Enter the subject of the email.
N	[MAIL] Attachments	Text	N	-	N	Enter path and name of the file to attach to the reply.
N	[MAIL] Body	Text	N	-	N	Enter the body content of the reply message.
N	File Size (MB)	Number	Y	MB	N	Enter the maximum attachment file size allowed for the message.
Y	MORE OPTIONS	-	-	-	-	Common property of the Outlook library.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Read the mail messages to reply from Outlook and send replies if “1” is entered in the InputBox.

ReplyMail 활용 예시

Sample file

Menu > Help > Sample > Sample > Outlook > Other_Samples > P_OutLook_ReplyMail

Used variables

MailItemList = Variable that stores the mail list of the mailbox

Used properties

[Input] Mail Item = this.MailItemList[0]
Receivers = this.MailItemList[0].Sender
CCs = this.MailItemList[0].To + ';' + this.MailItemList[0].CC
Subject = 'Re: ' + this.MailItemList[0].Subject

Related/Similar activities

SendMail, ForwardMail

SyncMail

Overview

This activity card asks you to immediately send and receive mail that has not yet been sent/received. It immediately initiates the relevant operation to the external server to which the Outlook account is connected. The Outlook program's Synchronize User pop-up window may appear.

Application procedure

If you plan to use it with the SendMail, ForwardMail, and ReplyMail activity cards, the SyncMail card must be placed behind them.

If you plan to use it with a GetMail activity card, the SyncMail card must be placed in front of it.

The SyncMail card serves to immediately start the Outlook program sending/receiving mail waiting on the local PC and does not participate in the mail processing task of an external mail server. Therefore, even if the operation of the SyncMail card is completed, the operation on the connected external mail server may be in progress.

In this case, the mail receiving operation of the GetMail card immediately after the SyncMail operation may not reflect the latest state.

Use a Delay card with an appropriate time between SyncMail and GetMail.

In the Account field, enter the account address of the Outlook program to be used in the SyncMail activity card. Outlook settings must be in working order.
In the Wait Sync Complete Time field, enter the number of seconds to wait for the Outlook program to start and complete the synchronization task. Note that completing the Outlook program synchronization task does not mean that the mail processing task in the external mail server has been completed.
In the Enable/disable Ignore Time field, set whether the entire process fails when the sync operation time expires. If enabled, the synchronization does not complete within the given period; the entire process will fail.

Card properties

Common	Properties	Type	Required	unit	Auto-settings	Description
N	Account	Message	Y	-	Y	Enter the account address of the Outlook program you want to synchronize mail with. The initially entered value is an example, so delete it and enter it.
N	Wait Sync Complete Time	Number	Y	Sec	Y	Enter the amount of time to wait for the Outlook program to complete the synchronization initiation process. Note that this is not the time the external mail server completes processing.
N	Ignore Timeout	Toggle Button	N	-	N	Set whether to continue the card's operation when the synchronization starts processing completion time of the Outlook program expires. If this property is enabled, the execution of the process is not interrupted.
Y	MORE OPTIONS	-	-	-	-	Common property of the Outlook library.
Y	DESCRIPTION	-	-	-	-	Common property of the Outlook library.

Example of utilization

Send the desired mail to sample@samsung.com through Outlook, receive the latest mail from the mail server again, and print the subject of the mail to the message box.

Sample file

· Menu > Help > Samples > Sample > Outlook > Outlook_Samples > P_OutLook_SyncMail

Used Variables

· MailItemList : Variable to store the list of mails in the mailbox.

Used properties

· Account = sample@samsung.com
· Wait Sync Complete Time = 5
· Ignore Timeout = off

Related/Similar activities

SendMail, GetMail, ReplyMail