# 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/noubar/RobotFramework-MailClientLibrary",
"name": "robotframework-mailclient",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "robotframework testing testautomation mailtesting mailclient mail imap smtp pop3",
"author": "noubar",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/49/04/fe2aff81d23c9094995bd952da41ef54e5d9f397c239f5e92de8a9f0b7a3/robotframework_mailclient-0.0.12.tar.gz",
"platform": "any",
"description": "# MailClientLibrary\n\nThe [`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.\nThe library officially supports Python >= 3.8 and can be installed using pip.\n\n## Installation\n\nTo install the library, run the following command:\n\n```\npip install robotframework-mailclient\n```\n\n## Usage\n\nAfter installing the library, you can import it into your Robot Framework test suite using the following line:\n\n```\n*** Settings ***\nLibrary MailClientLibrary\n```\n\nOr provide optionally the following arguments:\n\n```\nLibrary MailClientLibrary Username=UsernameStr Password=PasswordStr MailServerAddress=127.0.0.1 ImapPort=[993,143] Pop3Port=[995,110] SmtpPort=[587,26]\n```\n\nIf these not provided as arguments it should be set during the test using provided setter keywords look in Keyword Documentation.\nThe `MailClientLibrary` provides keywords for interacting with mail clients using IMAP, POP3, and SMTP protocols.\n\n### Supported protocols\n\nThe `MailClientLibrary` supports the following protocols:\n\n- IMAP\n- POP3\n- SMTP\n\n### SSL support\n\nThe `MailClientLibrary` supports SSL for all protocols and is enabled per default. To disable SSL, simply use the `UseSsl=True` argument when using any keyword.\n\n## Keyword Documentation\n\nThe keyword documentation can be found in this [Page](https://noubar.github.io/RobotFramework-MailClientLibrary/).\n\n## License\n\nThe `MailClientLibrary` is released under the [MIT License](https://opensource.org/licenses/MIT).\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Mail Client library for Robot Framework",
"version": "0.0.12",
"project_urls": {
"Homepage": "https://github.com/noubar/RobotFramework-MailClientLibrary"
},
"split_keywords": [
"robotframework",
"testing",
"testautomation",
"mailtesting",
"mailclient",
"mail",
"imap",
"smtp",
"pop3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "192eaf1de92f66e22f75f5af75db9dc54dd1035247929ef57d16a986d000ae7e",
"md5": "3a298ab9248b1680c6fd68cecba761ba",
"sha256": "861a128a09eea29e03c7e622d734e01508fc0d35d8a51d95c6898eca41c140bf"
},
"downloads": -1,
"filename": "robotframework_mailclient-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a298ab9248b1680c6fd68cecba761ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 17786,
"upload_time": "2024-07-30T10:39:30",
"upload_time_iso_8601": "2024-07-30T10:39:30.299011Z",
"url": "https://files.pythonhosted.org/packages/19/2e/af1de92f66e22f75f5af75db9dc54dd1035247929ef57d16a986d000ae7e/robotframework_mailclient-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4904fe2aff81d23c9094995bd952da41ef54e5d9f397c239f5e92de8a9f0b7a3",
"md5": "76cb53e7dacb8f9252a86fa48cfee357",
"sha256": "f65982b371511abf5da24b90ffee78a14d331b1bd2f5407ff0b406cb17a64c60"
},
"downloads": -1,
"filename": "robotframework_mailclient-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "76cb53e7dacb8f9252a86fa48cfee357",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 12289,
"upload_time": "2024-07-30T10:39:31",
"upload_time_iso_8601": "2024-07-30T10:39:31.516833Z",
"url": "https://files.pythonhosted.org/packages/49/04/fe2aff81d23c9094995bd952da41ef54e5d9f397c239f5e92de8a9f0b7a3/robotframework_mailclient-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 10:39:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "noubar",
"github_project": "RobotFramework-MailClientLibrary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "robotframework-mailclient"
}
JSON
