Composing and sending an email
|
|
This example demonstrates how to implement composing and distribution of an email from within the context of an automated test in execution.
In this example, first the email sender is set, then the email subject, email recipient list (to, cc, bcc), followed by the email body, and finally, the composed/constructed email is distributed. Please note that in this example, for the email body, a simple text string is used. In real life, the email body usually is not that simple wherein a static text satisfies your needs. Please refer to other examples that cover techniques that will help you build more realistic email body incrementally, including multi-part mime types (embedding screenshots, attaching files, etc).
Solution:
| # | Command | Target | Value |
|---|---|---|---|
| 1 | emailBlockStart | ||
| To set the sender for the composed email | |||
| 2 | setSender | info@eureqatest.com | |
| To set the subject for the composed email | |||
| 3 | setSubject | Worksoft SaaS Notification: <Subject> | |
| To set the ‘To’ recipient list for the composed email | |||
| 4 | setRecipientToList | recipient1@gmail.com | |
| To set the ‘CC’ recipient list for the composed email | |||
| 5 | setRecipientCCList | recipient2@gmail.com, recipient3@gmail.com | |
| To set the ‘BCC’ recipient list for the composed email | |||
| 6 | setRecipientBCCList | recipient4@gmail.com | |
| To create the email body with a variable name | |||
| 7 | createBody | body_template | |
| To create an email body part from Text or HTML string | |||
| 8 | createBodyPartFromTextOrHTML | Hi <mention recipient’s name here>, <mention your body text here> |
body_template |
| To send the composed email to the sender’s specified in “To, CC and BCC” list | |||
| 9 | sendEmail | ||
| It indicates the end of the email block | |||
| 10 | emailBlockEnd | ||
Tips, Tricks, Gotchas & Best Practices:
- The subject can be foreign language characters.
- You can also use CSS styles like underlines, font color, and to highlight anything important in bold letters and the table background color in the email body to make the email look effective.
Representative Use Cases for this Example:
Use Case #1:
After scheduling a run/batch of runs in Worksoft SaaS, the user has to login to Worksoft SaaS to know the run details, inputs and the screenshots of each and every test run as part of certification/CTC runs. The user can log in and search for the respective run details if the runs are in a single number.
What would be the case if there were hundreds of runs?
Consider a driver run, in order to trigger the batch of test runs at the scheduled time, we prefer using driver run which in turn triggers the actual runs.
If the user wants to know the run details in the driver runs like Run Definition Name, Run ID, Testing Context Key, Test Start time, failure reason, the instance of failure occurrence and the response of the scheduled run...and so on. Then the user has to check those scheduled runs in Home screen else, checks the count through the Test Cycles screen by searching the Test Cycle Identifier under which runs are grouped. This process involves multiple navigations, ambiguity and time consumption.
Also in case of failures, while triggering the runs, the triage to identify the root cause for failure would consume a lot of time if more runs are executed.
To enable the user to have access to the information faster w/ minimal actions; Worksoft SaaS allows to customize emails which can be triggered by the execution.
An email can be customized using the above commands in such a way that the below details will be sent to the user within the email.
- Run Definition Name
- Run ID
- Testing Context Key
- Test Start time
- Response of the scheduled run
- Input driver Data File
- Input file
- Output Data Set
- Error message
Use Case #2:
Consider an e-commerce site https://www.amazon.com, add 5 or more products into the cart, verify the count of products in the shopping bag, proceed to checkout, add shipping details and complete payment method and then try to place an order.
In the above process, there are certain cases like
1. Products may or may not add into the cart
2. Product may available or may not available or out of stock
3. The payment process may successful or unable to process the payment details
4. The Order may be placed or may not be placed
If the user wants to capture all the above-mentioned cases w/ relevant details like product name, order number, payment details, etc.., an email can be customized using these commands and sent to the user using the email commands.
Use Case #3:
Consider an insurance site, when the user logs into the respective insurance site a unique customer id will be generated. If the user wants to acknowledge whether the customer id is generated successfully or not an email can be customized using these commands with the customer information within the email.