Outlook Actions

Outlook Actions are used to interact with outlook e-mails

Actions

outlook.open

Create a new connection to Outlook.

Parameters:

account - Outlook account to log in

default_folder - Name of the mailbox to start reading (default='inbox')

Return:

current_folder - The current folder used to read the emails

email_client - Client connection to Outlook.

emails_count - emails_count - Return the total number of e-mails in the current_folder

Exceptions:

This action gives no exceptions.

outlook.find_attachments

Permit to return all attachments on the current e-mail or search a specific attachment by name

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

filter (optional) - Name or partial name of the attachment to look for (default=don't filter by name)

Return:

attachments - List with all attachments that satisfy the search

attachments_count - Number of attachments in message

Exceptions:

This action gives no exceptions.

outlook.get_current_email

Return the e-mail message on current position at e-mail client.

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

date - Date and time when message was sent

from - Text with name (if defined) and e-mail address of the message sender

from_address - Return only the e-mail address of the message sender

has_attachments - Boolean variable setting if e-mail message has attachments or not

attachments_count - Number of attachments in current e-mail

body - Content of e-mail message as plain text.

html_body - Content of e-mail message as HTML content

subject - Subject of the e-mail message

Exceptions:

This action gives no exceptions.

outlook.list_folders

Return a list of all folder available on connected e-mail account.

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

folders - List with the name of all folders of connected e-mail account

Exceptions:

This action gives no exceptions.

outlook.move_to

Move current message to another folder.

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

to_folder - Name of folder to move message to

message (optional)- Message to move to another folder (default=current message)

Return:

This action has no return

Exceptions:

This action gives no exceptions.

outlook.next_email

Return next e-mail on current mailbox

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

date - Date and time when message was sent

from - Text with name (if defined) and e-mail address of the message sender

from_address - Return only the e-mail address of the message sender

has_attachments - Boolean variable setting if e-mail message has attachments or not

attachments_count - Number of attachments in current e-mail

body - Content of e-mail message as plain text.

html_body - Content of e-mail message as HTML content

subject - Subject of the e-mail message

Exceptions:

This action gives no exceptions.

outlook.save_attachment

Save attach files to filesystem

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

file_path - Path to folder where attachments should be saved.

attach_name - Name or partial name of the attachment to look for (default=don't filter by name)

Return:

saved_files - List with complete file path, to saved files

Exceptions:

This action gives no exceptions.

outlook.search

Search for desired e-mail

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

search_filter - Search Filter to desired e-mail

Return:

emails_count - Return the total number of e-mails in the current_folder

Exceptions:

This action gives no exceptions.

outlook.search_unread

Search for unread e-mails

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

emails_count - Return the total number of unread e-mails

Exceptions:

This action gives no exceptions.

outlook.select_account

Select account to connect with

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

account - Outlook account to log in

folder - Select folder to start reading

Return:

current_folder - The current folder used to read the emails

emails_count - Return the total number of e-mails in the current_folder

Exceptions:

This action gives no exceptions.

outlook.select_folder

Select a e-mail folder to search for emails

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

folder - Select folder to start reading

Return:

current_folder - The current folder used to read the emails

emails_count - Return the total number of e-mails in the current_folder

Exceptions:

This action gives no exceptions.

outlook.previous_email

Return the previous e-mail on current mailbox

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

date - Date and time when message was sent

from - Text with name (if defined) and e-mail address of the message sender

from_address - Return only the e-mail address of the message sender

has_attachments - Boolean variable setting if e-mail message has attachments or not

attachments_count - Number of attachments in current e-mail

body - Content of e-mail message as plain text.

html_body - Content of e-mail message as HTML content

subject - Subject of the e-mail message

Exceptions:

This action gives no exceptions.

outlook.update_mailbox

Update e-mail information for current mailbox

Parameters:

email_client - Client connection to Outlook. Connections are created using outlook.open

Return:

emails_count - Return the total number of e-mails in the current_folder

Exceptions:

This action gives no exceptions.