Metadata-Version: 1.0
Name: robotframework-imaplibrary
Version: 0.0.4
Summary: Robot Framework IMAP Mail Check Library
Home-page: https://github.com/lovelysystems/robotframework-imaplibrary
Author: Lovely Systems GmbH
Author-email: office@lovelysystems.com
License: Apache License 2.0
Description: ==========================
        robotframework-imaplibrary
        ==========================
        
        **robotframework-imaplibrary** is a `Robot Framework
        <http://code.google.com/p/robotframework/>`_ 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  user=mymail@googlemail.com           password=mysecretpassword
        ${LATEST}=      Wait for Mail               fromEmail=noreply@register.com       toEmail=mymailalias@googlemail.com  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
        <http://www.apache.org/licenses/LICENSE-2.0.html>`_.
        
Keywords: robotframework testing testautomation imap mail
Platform: any
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Testing
