skip to navigation
skip to content

robotframework-imaplibrary 0.0.4

Robot Framework IMAP Mail Check Library

Latest Version: 0.3.0

robotframework-imaplibrary is a Robot Framework test library to test mail validation tasks.


To install, just fetch the latest version from PyPI:.

pip install –upgrade robotframework-imaplibrary


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:
        - server:   the server name (e.g.
        - user:     the user name (e.g.
        - 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
        - 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

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


The robotframework-imaplibrary is licensed under the Apache 2.0 License.

File Type Py Version Uploaded on Size
robotframework-imaplibrary-0.0.4.tar.gz (md5) Source 2012-09-13 2KB