RPA.Email.Exchange

Connect to Exchange account

Arguments

Argument	Type	Default value	Description
username	str		account username
password	str		account password
autodiscover	bool	True	use autodiscover or set it off
access_type	str	DELEGATE
server	str	None	required for configuration options
primary_smtp_address	str	None	by default set to username, but can be set to be different than username

param username:	account username
param password:	account password
param autodiscover:
	use autodiscover or set it off
param accesstype:
	default "DELEGATE", other option "IMPERSONATION"
param server:	required for configuration options
param primary_smtp_address:
	by default set to username, but can be set to be different than username

Create email folder

Arguments

Argument	Type	Default value	Description
folder_name	str	None	name for the new folder
parent_folder	str	None	name for the parent folder, by default INBOX

param folder_name:
	name for the new folder
param parent_folder:
	name for the parent folder, by default INBOX
return:	True if operation was successful, False if not

Delete email folder

Arguments

Argument	Type	Default value	Description
folder_name	str	None	current folder name
parent_folder	str	None	name for the parent folder, by default INBOX

param folder_name:
	current folder name
param parent_folder:
	name for the parent folder, by default INBOX
return:	True if operation was successful, False if not

Empty email folder of all items

Arguments

Argument	Type	Default value	Description
folder_name	str	None	current folder name
parent_folder	str	None	name for the parent folder, by default INBOX
delete_sub_folders	bool	False	delete sub folders or not, by default False

param folder_name:
	current folder name
param parent_folder:
	name for the parent folder, by default INBOX
param delete_sub_folders:
	delete sub folders or not, by default False
return:	True if operation was successful, False if not

List messages in the account inbox. Order by descending received time.

Arguments

Argument	Type	Default value	Description
folder_name	str	None
count	int	100	number of messages to list

List messages in the account inbox. Order by descending received time.

param count:	number of messages to list

Move message(s) from source folder to target folder

Arguments

Argument	Type	Default value	Description
criterion	str		move messages matching this criterion
source	str	None	source folder
target	str	None	target folder
contains	bool	False	if matching should be done using contains matching and not equals matching, default False is means equals matching

param criterion:
	move messages matching this criterion
param source:	source folder
param target:	target folder
param contains:	if matching should be done using contains matching and not equals matching, default False is means equals matching
return:	boolean result of operation, True if 1+ items were moved else False

Criterion examples:

• subject:my message subject
• body:something in body
• sender:sender@domain.com

Rename email folder

Arguments

Argument	Type	Default value	Description
oldname	str	None	current folder name
newname	str	None	new name for the folder
parent_folder	str	None	name for the parent folder, by default INBOX

param oldname:	current folder name
param newname:	new name for the folder
param parent_folder:
	name for the parent folder, by default INBOX
return:	True if operation was successful, False if not

Keyword for sending message through connected Exchange account.

Arguments

Argument	Type	Default value	Description
recipients	str		list of email addresses, defaults to []
subject	str		message subject, defaults to ""
body	str		message body, defaults to ""
attachments	str	None	list of filepaths to attach, defaults to []
html	bool	False	if message content is in HTML, default False
images	str	None	list of filepaths for inline use, defaults to []
cc	str	None	list of email addresses, defaults to []
bcc	str	None	list of email addresses, defaults to []
save	bool	False	is sent message saved to Sent messages folder or not, defaults to False

param recipients:
	list of email addresses, defaults to []
param subject:	message subject, defaults to ""
param body:	message body, defaults to ""
param attachments:
	list of filepaths to attach, defaults to []
param html:	if message content is in HTML, default False
param images:	list of filepaths for inline use, defaults to []
param cc:	list of email addresses, defaults to []
param bcc:	list of email addresses, defaults to []
param save:	is sent message saved to Sent messages folder or not, defaults to False

Email addresses can be prefixed with ex: to indicate an Exchange account address.

Recipients is a required parameter.

Wait for email matching criterion to arrive into INBOX.

Arguments

Argument	Type	Default value	Description
criterion	str		wait for message matching criterion
timeout	float	5.0	total time in seconds to wait for email, defaults to 5.0
interval	float	1.0	time in seconds for new check, defaults to 1.0
contains	bool	False	if matching should be done using contains matching and not equals matching, default False is means equals matching

param criterion:
	wait for message matching criterion
param timeout:	total time in seconds to wait for email, defaults to 5.0
param interval:	time in seconds for new check, defaults to 1.0
param contains:	if matching should be done using contains matching and not equals matching, default False is means equals matching
return:	list of messages