Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The email protocols available in BQ platform are :

  1. IMAP

  2. POP3

  3. SMTP

1- IMAP (Internet Message Access Protocol) :

IMAP allows you to access your email from any device. When you read an email message using IMAP, you don't actually download or store it on your computer. You read it from the email service.
IMAP only downloads a message when you click on it, and attachments aren't automatically downloaded.

2- POP3 (Post Office Protocol 3) :

POP works by contacting your email service and downloading all of your new messages from it. Once they are downloaded onto your PC or Mac, they are deleted from the email service. This means that after the email is downloaded, it can only be accessed using the same computer. If you try to access your email from a different device, the messages that have been previously downloaded won't be available to you.
Sent mail is stored locally on your PC or Mac, not on the email server.

3- SMTP (Simple Mail Transfer Protocol) :

SMTP is the protocol used to send new mail regardless of what protocol is used to retrieve new email.

Suppose you wish to verify that a particular subject exists in a specific folder.

...

Action

Parameters

Example Usage

setMailConnection

Web, Mobile


To connect email server with connection string (mentioned in Parameter 1). 

Param 1 : Connection string for email

Info

Use Email Connect to store the connection values in a variable & use the variable (as global variable) in param 1

Example:

Info

Email Connection String format : Type | Ip-Address/Host Name | Port | Security Type | User Name | Password

Suppose the Email Connect variable created is EmailConn1 with values IMAP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx

setMailConnection: <Email Connection String : EmailConn1>

Connects the email server with connection string - IMAP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx

Info

While creating an Email Connection String :
1- Email type available in BQ : IMAP, SMTP and POP3
IMAP (Internet Message Access Protocol) : This server retrieves email messages from a mail server over a TCP/IP connection.
SMTP (Simple Mail Transfer Protocol) : This server delivers outgoing messages on behalf of the user.
POP3 (Post Office Protocol 3) : Protocol used by e-mail clients to retrieve e-mail from a mail server.
2- Security type available in BQ : None, SSL and TLS

sendEmail

Web, Mobile


To send an email with connection string (mentioned in Parameter 1) to email address (mentioned in Parameter 2). 

This will require SMTP type connection string in order to send an email.

Param 1 : Connection string for email
Param 2 : Mail id to send email from
Param 3 : Mail id to send email to
Param 4 : Mail id of the person to be kept in CC
Param 5 : Subject of the mail
Param 6 : Mail content

Example:

Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx

sendEmail : <Email Connection String : EmailConn1> <From : support@bqurious.com> <To : abc@bqurious.com> <CC : xyz@bqurious.com> <Subject : Test Mail> <Message Body : Hello, How are you!>

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

Info

Email Connection (EmailConn1) should already be created under Email Connect.

setSearchModeExact

Web, Mobile


To set the search mode as Exact to find the text in email. 

If Exact is not set then search will be case-insensitive and fuzzy.

Example:

setSearchModeExact

Finds the text in email by exact text.

setSearchModePartial

Web, Mobile


To set the search mode as Partial to find the text in email.

Example:

setSearchModePartial

Finds the text in email by partial text

setCurrentFolder

Web, Mobile


To set the default folder (mentioned in Parameter 1) to search in mail server.

Param 1 : Name of the current folder

Example:

setCurrentFolder: <Folder Name : SENT>

Sets the SENT folder as default in mail server for searching text

copyMessageCount

Web, Mobile


To copy the total number of messages in variable (mentioned in Parameter 1).

Param 1 : Variable name to store the message count

Example:

copyMessageCount : <In Variable : MSGCOUNT>

Copies the total number of messages in variable name MSGCOUNT

copyUnreadMessageCount

Web, Mobile


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:

copyUnreadMessageCount: <In Variable : UNREADMSGCOUNT>

Copies the total number of unread messages in variable name UNREADMSGCOUNT

copyMessageWithSubject

Web, Mobile


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
Param 2 : Variable name to store the message

Example:

copyMessageWithSubject : <Subject : Welcome to bqurious> <In Variable : MSGCONTENT>

Copies the message from the mail having subject Welcome to bqurious in variable name MSGCONTENT

verifyMessageCount

Web, Mobile


To verify the total number of messages is value (mentioned in Parameter 1).

Param 1 : Total number of messages

Example:

verifyMessageCount : <Total Messages : 1000>

Verifies the total number of messages is 1000

verifyUnreadMessageCount

Web, Mobile


To verify the total number of unread messages is value (mentioned in Parameter 1).

Param 1 : Total number of unread messages

Example:

verifyUnreadMessageCount : <Total unread Messages : 1000>

Verifies the total number of unread messages is 1000

verifySubjectExists

Web, Mobile


To verify if mail exists with subject (mentioned in Parameter 1).

Param 1 : Subject of the mail

Example:

verifySubjectExists : <Subject : Welcome to Bqurious>

Verifies if mails exists with subject Welcome to Bqurious

copyLinkWithText

Web, Mobile


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).

Info

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
Param 2 : Text on link
Param 3 : Variable name to store

Example:

copyLinkWithText : <Subject : Welcome to bqurious> <Link Text : www.bqurious.com> <In variable : MSGCONTENT>

Copies the link text www.bqurious.com from message content in mail having subject Welcome to bqurious in variable name MSGCONTENT

verifyLinkWithTextExist

Web, Mobile


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
Param 2 : Text on link

Example:

verifyLinkWithTextExist : <Subjet : Welcome to bqurious > <Link Text: www.bqurious.com>

Verifies the link text www.bqurious.com from message content in mail with subject as Welcome to bqurious.

copyUrlAtIndex

Web, Mobile


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
Param 2 : Variable name to store
Param 3 : Index of the url

Example:

copyUrlAtIndex : <Subjec: HELLO > <In Variable : bqVar> <Index : 2>

Copies url at index 2 from the mail body with subject HELLO into variable bqVar

verifyUrlWithTextExist

Web, Mobile


To verify the URL (mentioned in parameter 2), from the mail body with subject (mentioned in parameter 1).

Param 1 : Subject of the mail
Param 2 : Text to verify

Example:

verifyUrlWithTextExist : <Subject : HELLO> <Text to verify : http://www.bqurious.com>

Verifies url http://www.bqurious.com in the mail body with subject HELLO

verifyTextExistsInMailBody

Web, Mobile


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
Param 2 : Text to verify

Example:

verifyTextExistsInMailBody : <Subject : Welcome Mail> <Text to verify : Welcome to Bqurious>

Verifies text Welcome to Bqurious exists in email body having subject Welcome Mail

copyValueFromMailSubject

Web, Mobile


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
Param 2 : Variable name to store
Param 3 (Optional) : Left Boundary
Param 4 (Optional) : Right Boundary

Example:

copyValueFromMailSubject : <Subject : New Case :> <In Variable : caseNumber> <Left Boundary : Case :> <Right Boundary : >

Copies the value between the left boundary ‘Case :’and right boundary (not provided in this case) from subject New Case : in variable caseNumber

replyToEmail

Web, Mobile


To reply an email identified with subject (mentioned in Parameter 2) with connection string (mentioned in Parameter 1) with message (mentioned in Parameter 3).

Info

This will require SMTP type connection string in order to send an email.

Param 1 : Connection string for email
Param 2 : Subject of the mail
Param 3 : Mail content

Example:

Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx

replyToEmail: <Email Connection : EmailConn1> <Subject : Hello Bqurious> <Message Body : Hi! How are you>

Replies to an email having subject Hello Bqurious with email connection string EmailConn1 with message Hi! How are you.

Info

Email Connection (EmailConn1) should already be created under Email Connect.

replyAllToEmail

Web, Mobile


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).

Info

This will require SMTP type connection string in order to send an email.

Param 1 : Connection string for email
Param 2 : Subject of the mail
Param 3 : Mail content

Example:

Suppose the Email Connect variable created is EmailConn1 with values SMTP | 192.9.9.9 | 9999 | abc@defgh.com | xxxxxxxx

replyAllToEmail : <Email Connection String : EmailConn1> <Subject : Hello Bqurious> <Message Body : Hi! How are you>

Replies to all having an email subject Hello Bqurious with email connection string EmailConn1 with message Hi! How are you

Info

Email Connection (EmailConn1) should already be created under Email Connect.

...

Filter by label (Content by label)
labels
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@10213
showSpacefalse
sortmodified
typepage
reversetrue
kb-how-to-articlecqllabel = "kb-how-to-article" and type = "page" and space = "BSD"
labelskb-how-to-article


Page Properties
hiddentrue


Related issues



...