Email actions help you to perform various actions on your mail account.
An Email protocol is a process by which an email client accesses the information contained in an email account.
The email protocols available in BQ platform are :
IMAP
POP3
SMTP
Suppose you wish to verify that a particular subject exists in a specific folder.
Structure :
setMailConnection <parameters>
setCurrentFolder <parameters>
verifySubjectExists <parameters>
Â
Action | Parameters | Example Usage |
|---|---|---|
copyLinkWithText
To copy the link text (mentioned in Parameter 2) from message content of the mail having subject (mentioned in Parameter 1) in variable name (mentioned in parameter 3). This is useful in situations like checking if user received the correct registration link or not. The link with text can be copied in a variable and compared with the expected value. | Param 1 : Subject of the mail | Example:
Copies the link text www.bqurious.com from message content in mail having subject Welcome to bqurious in variable name MSGCONTENT |
copyMessageCount
To copy the total number of messages in variable (mentioned in Parameter 1). | Param 1 : Variable name to store the message count | Example:
Copies the total number of messages in variable name MSGCOUNT |
copyUnreadMessageCount
To copy the total number of unread messages in variable (mentioned in Parameter 1). | Param 1 : Variable name to store the unread message count | Example:
Copies the total number of unread messages in variable name UNREADMSGCOUNT |
copyMessageWithSubject
To copy the message from the mail having subject (mentioned in Parameter 1) in variable name (mentioned in parameter 2). | Param 1 : Subject of the mail | Example:
Copies the message from the mail having subject Welcome to bqurious in variable name MSGCONTENT |
copyUrlAtIndex
To copy the URL, from the mail body with subject (mentioned in parameter 1), at index (index mentioned in parameter 3) into the variable (mentioned in parameter 2). | Param 1 : Subject of the mail | Example:
Copies url at index 2 from the mail body with subject HELLO into variable bqVar |
copyValueFromMailSubject
To store the value between left boundary (mentioned in parameter 3) and right boundary (mentioned in parameter 4) of subject (mentioned in parameter 1) into variable (mentioned in parameter 2). | Param 1 : Subject of the mail | Example:
Copies the value between the left boundary ‘Case :’ and right boundary (not provided in this case) from subject New Case : in variable caseNumber |
replyToEmail
To reply an email identified with subject (mentioned in Parameter 2) with connection string (mentioned in Parameter 1) with message (mentioned in Parameter 3). This will require SMTP type connection string in order to send an email. | Param 1 : Connection string for email | Example: Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx replyToEmail Replies to an email having subject Hello Bqurious with email connection string EmailConn1 with message Hi! How are you. Email Connection (EmailConn1) should already be created under Email Connect. |
replyAllToEmail
To reply-all an email identified with subject (mentioned in Parameter 2) with connection string (mentioned in Parameter 1) with message (mentioned in Parameter 3). | Param 1 : Connection string for email | Example: Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx
Replies to all having an email subject Hello Bqurious with email connection string EmailConn1 with message Hi! How are you |
setMailConnection
To connect email server with connection string (mentioned in Parameter 1). | Param 1 : Connection string for email | Example: Suppose the Email Connect variable created is EmailConn1 with values IMAP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx
Connects the email server with connection string - IMAP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx |
sendEmail
To send an email with connection string (mentioned in Parameter 1) to email address (mentioned in Parameter 2). | Param 1 : Connection string for email | Example: Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx
Sends an email to abc@bqurious.com and cc to xyz@bqurious.com from support@bqurious.com having Subject Test Mail and body as Hello, How are you!, with email connection string EmailConn1 |
setSearchModeExact
To set the search mode as Exact to find the text in email. |  | Example:
Finds the text in email by exact text. |
setSearchModePartial
To set the search mode as Partial to find the text in email. | Â | Example:
Finds the text in email by partial text |
setCurrentFolder
To set the default folder (mentioned in Parameter 1) to search in mail server. | Param 1 : Name of the current folder | Example:
Sets the SENT folder as default in mail server for searching text |
verifyMessageCount
To verify the total number of messages is value (mentioned in Parameter 1). | Param 1 : Total number of messages | Example:
Verifies the total number of messages is 1000 |
verifyUnreadMessageCount
To verify the total number of unread messages is value (mentioned in Parameter 1). | Param 1 : Total number of unread messages | Example:
Verifies the total number of unread messages is 1000 |
verifySubjectExists
To verify if mail exists with subject (mentioned in Parameter 1). | Param 1 : Subject of the mail | Example:
Verifies if mails exists with subject Welcome to Bqurious |
verifyLinkWithTextExist
To verify the link text (mentioned in Parameter 2) from message content of the mail having subject (mentioned in Parameter 1) exists. | Param 1 : Subject of the mail | Example:
Verifies the link text www.bqurious.com from message content in mail with subject as Welcome to bqurious. |
verifyUrlWithTextExist
To verify the URL (mentioned in parameter 2), from the mail body with subject (mentioned in parameter 1). | Param 1 : Subject of the mail | Example:
Verifies url http://www.bqurious.com in the mail body with subject HELLO |
verifyTextExistsInMailBody
To verify the text (mentioned in Parameter 2) exists in email body having subject (subject mentioned in Parameter 1). | Param 1 : Subject of the mail | Example:
Verifies text Welcome to Bqurious exists in email body having subject Welcome Mail |