Metadata-Version: 2.1
Name: robotframework-mailclient
Version: 0.0.12
Summary: Mail Client library for Robot Framework
Home-page: https://github.com/noubar/RobotFramework-MailClientLibrary
Author: noubar
License: Apache License 2.0
Keywords: robotframework testing testautomation mailtesting mailclient mail imap smtp pop3
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Communications :: Email :: Email Clients (MUA)
Classifier: Topic :: Communications :: Email :: Post-Office :: IMAP
Classifier: Topic :: Communications :: Email :: Post-Office :: POP3
Classifier: Topic :: Communications :: Email
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Requires-Python: >=3.8, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: robotframework >=4.1.3
Requires-Dist: robotframework-pythonlibcore >=4.4.1

# MailClientLibrary

The [`MailClientLibrary`](https://github.com/noubar/RobotFramework-MailClientLibrary) is a Python based library for the [Robot Framework](https://robotframework.org/) that provides keywords to interact with mail clients using IMAP, POP3, and SMTP protocols.
The library officially supports Python >= 3.8 and can be installed using pip.

## Installation

To install the library, run the following command:

```
pip install robotframework-mailclient
```

## Usage

After installing the library, you can import it into your Robot Framework test suite using the following line:

```
*** Settings ***
Library  MailClientLibrary
```

Or provide optionally the following arguments:

```
Library  MailClientLibrary  Username=UsernameStr  Password=PasswordStr  MailServerAddress=127.0.0.1  ImapPort=[993,143]  Pop3Port=[995,110]  SmtpPort=[587,26]
```

If these not provided as arguments it should be set during the test using provided setter keywords look in Keyword Documentation.
The `MailClientLibrary` provides keywords for interacting with mail clients using IMAP, POP3, and SMTP protocols.

### Supported protocols

The `MailClientLibrary` supports the following protocols:

- IMAP
- POP3
- SMTP

### SSL support

The `MailClientLibrary` supports SSL for all protocols and is enabled per default. To disable SSL, simply use the `UseSsl=True` argument when using any keyword.

## Keyword Documentation

The keyword documentation can be found in this [Page](https://noubar.github.io/RobotFramework-MailClientLibrary/).

## License

The `MailClientLibrary` is released under the [MIT License](https://opensource.org/licenses/MIT).
