robotframework-imaplibrary2

What it is and what it does

ImapLibrary2 is a Robot Framework extension that wraps IMAP protocol access to enable email-based test automation. It lets you connect to mailboxes, wait for incoming messages, extract and verify email content, and inspect multipart messages—all within Robot Framework's keyword-driven test syntax. The library handles the low-level IMAP protocol details so test authors can focus on email verification logic.

Typical use is in end-to-end testing workflows where your application sends transactional emails and you need to verify they arrived with correct content. It depends on robotframework as its primary runtime dependency, plus future for Python 2/3 compatibility and pysocks for proxy support. The package is a fork of an earlier robotframework-imaplibrary project and remains in beta status.

Use it for:

• Verify that password-reset emails arrive with correct verification links after user signup
• Validate email content and formatting in multipart messages sent by your application
• Wait for and extract one-time codes or confirmation URLs from automated transactional emails
• Test email delivery workflows by polling an IMAP mailbox during end-to-end test runs
• Inspect email headers and payloads to confirm sender, subject, and body content match expectations

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Robot Framework library that connects to IMAP mailboxes to retrieve, verify, and inspect email content during automated testing.

Yes, if you are already using Robot Framework for test automation and need to verify email-driven workflows. Install friction is low and the Apache 2.0 license is permissive. However, note that maintenance is aging (534 days since last release) and Python version support is unclear—verify compatibility with your target Python version before committing to it in a production test suite.

Install

robotframework-imaplibrary2 on PyPI

pip install robotframework-imaplibrary2

uv add robotframework-imaplibrary2

poetry add robotframework-imaplibrary2

Installing robotframework-imaplibrary2

Before you install

Low install friction with a pure-Python wheel distribution. Maintenance is aging—last release was 534 days ago, though the repository remains active with a recent commit on 2025-02-26. Depends on robotframework, future, and pysocks, all stable packages.

License in practice

Licensed under Apache License, Version 2.0 (permissive), which allows commercial and private use with minimal restrictions. No licensing barrier to adoption.

Quickstart

pip install robotframework-imaplibrary2

In a Robot Framework test file:
*** Settings ***
Library    ImapLibrary2

*** Test Cases ***
Verify Email
    Open Mailbox    host=imap.domain.com    user=email@domain.com    password=secret
    ${email} =    Wait For Email    sender=noreply@domain.com    timeout=300
    Close Mailbox

Requires Robot Framework to be installed and a working IMAP server connection with valid credentials.

Verify before relying

• Current Python version support (classifiers list 2.7 and 3.5, but requires_python is unspecified)
• Whether pysocks is used for proxy support or is a transitive dependency
• Active maintenance cadence and responsiveness to issues given aging status

Package facts

Evidence: robotframework_imaplibrary2-0.4.11-py2.py3-none-any.whl

Keywords: robot, framework, testing, automation, imap, email, mail, softwaretesting

Tags

More Testing packages