robotframework-imaplibrary is a Robot Framework test library to test mail validation tasks.
Installation
To install, just fetch the latest version from PyPI:.
pip install –upgrade robotframework-imaplibrary
Usage
Setup in the robotframework Settings section:
Setting |
Value |
|---|---|
Library |
ImapLibrary |
These keyword actions are available:
Open Mailbox:
Open the mailbox on a mail server with a valid authentication:
Arguments:
- server: the server name (e.g. imap.googlemail.com)
- user: the user name (e.g. me@googlemail.com)
- password: the user's password
Wait for Mail:
Wait for an incoming mail. Check the mailbox every 10 seconds
for incoming mails until a matching email is received or the
timeout is exceeded. Returns the mail number of the latest matching
email.
Arguments:
- fromEmail: the email address of the sender (not required)
- toEmail: the email address of the receiver (not required)
- timeout: the timeout how long the mailbox shall check emails
in seconds (defaults to 60 seconds)
Get Links From Email:
Finds all links in an email body and returns them
Arguments:
- mailNumber: is the index number of the mail to open
Open Link from Mail:
Find a link in an email body and open the link. Returns the links' html.
Arguments:
mailNumber: the number of the email to check for a link
linkNumber: the index of the link to open
(defaults to 0, which is the first link)
Close Mailbox:
Close the mailbox after finishing all mail activities of a user.
Here is an example of how to use the library:
Action |
Argument |
Argument |
Argument |
Argument |
|---|---|---|---|---|
Open Mailbox |
server=imap.googlemail.com |
password=mysecretpassword |
||
${LATEST}= |
Wait for Mail |
timeout=150 |
||
${HTML}= |
Open Link from Mail |
${LATEST} |
||
Should Contain |
${HTML} |
Your email address has been updated |
||
Close Mailbox |
License
The robotframework-imaplibrary is licensed under the Apache 2.0 License.
Metadata
Release files for robotframework-imaplibrary 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| robotframework-imaplibrary-0.0.4.tar.gz | 3.1 kB | Details |
Release files / robotframework-imaplibrary-0.0.4.tar.gz
| Download URL | robotframework-imaplibrary-0.0.4.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa16e0ce6ddee1711740f28fdf916a98941abaa1310924b6901c3ea9f08fdd11
|
|
BLAKE2b-256 checksum How to use checksums |
7050ea5c7765baf98f77d169bc7960483b71d732babe42258ac126f1724d3051
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |