###### ⚠️ Disclaimer: Reverse engineering process is shown for research purposes only.
# 👏 Get mails from Yopmail inbox
Get mails from a Yopmail inbox, save them as ``.html``
## 📖 Usage:
Install the latest version from PyPI by using [pip](https://pip.pypa.io/):
```
pip install yopmail
```
Import ``Yopmail`` class from ``yopmail`` module
```python
from yopmail import Yopmail
```
Instantiate ``Yopmail`` class with username as parameter (with ``@`` or not) and provide proxies if needed
```python
y = Yopmail('test', proxies=None)
```
Using ``get_mail_ids()`` method you get mail ids. You can provide (optional) ``page`` parameter otherwise page 1 is used as default. You can as well provide ``proxy`` parameter which would override instantiated class proxies.
```python
mails_ids = y.get_mail_ids(page=3)
```
Iterate over mail ids to get mail body using:
```python
for mail_id in mails_ids:
mail = y.get_mail_body(mail_id, show_image=True)
mail.save()
```
Again you can provide ``proxy`` parameter which would override instantiated class proxies.
``show_image`` is used to load mail images (equivalent to "load remote content" in most mail clients)
You can use ``save()`` method to save mail as ``.html``.
Feel free to contribute 🤝
## 📝 TODO:
- [ ] Add CSS to saved html mail
###### Feel free to contact me wherever you find me
Raw data
{
"_id": null,
"home_page": "https://github.com/rklf/yopmail",
"name": "yopmail",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "yopmail get mails retrieve scrap emails",
"author": "rklf",
"author_email": "11515950+rklf@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/85/3d/b6b972df6bf920dec6caed8bb55448b515fc9e7be022195f86e01bd4ac15/yopmail-1.9.tar.gz",
"platform": null,
"description": "###### \u26a0\ufe0f Disclaimer: Reverse engineering process is shown for research purposes only.\n\n# \ud83d\udc4f Get mails from Yopmail inbox\nGet mails from a Yopmail inbox, save them as ``.html``\n\n\n## \ud83d\udcd6 Usage:\nInstall the latest version from PyPI by using [pip](https://pip.pypa.io/):\n```\npip install yopmail\n```\n\nImport ``Yopmail`` class from ``yopmail`` module\n```python\nfrom yopmail import Yopmail\n```\n\nInstantiate ``Yopmail`` class with username as parameter (with ``@`` or not) and provide proxies if needed\n```python\ny = Yopmail('test', proxies=None)\n```\n\nUsing ``get_mail_ids()`` method you get mail ids. You can provide (optional) ``page`` parameter otherwise page 1 is used as default. You can as well provide ``proxy`` parameter which would override instantiated class proxies.\n```python\nmails_ids = y.get_mail_ids(page=3)\n```\n\nIterate over mail ids to get mail body using:\n```python\nfor mail_id in mails_ids:\n mail = y.get_mail_body(mail_id, show_image=True)\n mail.save()\n```\nAgain you can provide ``proxy`` parameter which would override instantiated class proxies.\n``show_image`` is used to load mail images (equivalent to \"load remote content\" in most mail clients)\nYou can use ``save()`` method to save mail as ``.html``.\n\n\nFeel free to contribute \ud83e\udd1d\n\n\n## \ud83d\udcdd TODO:\n- [ ] Add CSS to saved html mail\n\n###### Feel free to contact me wherever you find me\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python module to get mails from a Yopmail inbox, save them",
"version": "1.9",
"project_urls": {
"Homepage": "https://github.com/rklf/yopmail"
},
"split_keywords": [
"yopmail",
"get",
"mails",
"retrieve",
"scrap",
"emails"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4297700284d666f2669cbc340a4d44ce400784ea98d404d31530c50cd9526f17",
"md5": "b4fa621b18757cff0f1bd93b843869e0",
"sha256": "872bf2e6a0d17e7aec9db084641cf80f3dc01ae75e14a6464154c21b34fd3420"
},
"downloads": -1,
"filename": "yopmail-1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4fa621b18757cff0f1bd93b843869e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4143,
"upload_time": "2024-03-17T14:14:39",
"upload_time_iso_8601": "2024-03-17T14:14:39.415493Z",
"url": "https://files.pythonhosted.org/packages/42/97/700284d666f2669cbc340a4d44ce400784ea98d404d31530c50cd9526f17/yopmail-1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "853db6b972df6bf920dec6caed8bb55448b515fc9e7be022195f86e01bd4ac15",
"md5": "10d25970866501a71bcdd252de8f612b",
"sha256": "a8d47c2b7b604f16e397bc01c69a296801fa98234750ff3d7f75342279c28d63"
},
"downloads": -1,
"filename": "yopmail-1.9.tar.gz",
"has_sig": false,
"md5_digest": "10d25970866501a71bcdd252de8f612b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4116,
"upload_time": "2024-03-17T14:14:41",
"upload_time_iso_8601": "2024-03-17T14:14:41.159105Z",
"url": "https://files.pythonhosted.org/packages/85/3d/b6b972df6bf920dec6caed8bb55448b515fc9e7be022195f86e01bd4ac15/yopmail-1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-17 14:14:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rklf",
"github_project": "yopmail",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yopmail"
}
JSON
