# Unofficial Xitroo API
This is an unofficial API for interacting with the Xitroo email service. The API provides a set of Python classes and methods to manage email addresses, retrieve and send emails, handle inboxes, solve captchas, and more.
## Table of Contents
- [Installation](#Installation)
- [Quick Start](#Quick-Start)
- [Classes Overview](#classes-overview)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Installation
To install this package, clone the repository and install the required dependencies:
```bash
pip install unofficial-xitroo-api
```
## Quick Start
Here's a brief example to get you started:
```python
from xitroo import Xitroo
# Generate mail
email = Xitroo.generate()
print(email)
# Initialize the Xitroo object
xitroo = Xitroo("your-email@xitroo.com")
# Get the inbox
inbox = xitroo.Inbox()
# Get the latest email
latest_mail = xitroo.getLatestMail()
print(latest_mail.getBodyText())
# Print code form latest email
print(Xitroo.getCode(latest_mail))
```
## Classes Overview
### Xitroo
The main class to interact with the Xitroo API. It includes methods for managing email addresses, headers, sessions, and performing various email operations.
### Mail
Represents an email. It provides methods to retrieve email content, attachments, and metadata.
### Inbox
Represents an inbox. It provides methods to retrieve emails and inbox information.
### SearchMail
Provides methods to search the inbox by different criteria such as date, sender, title, and text in the body.
### Captcha
Handles captcha-related operations including retrieving and verifying captchas.
## Documentation
For detailed documentation, please refer to the [HTML documentation](http://htmlpreview.github.io/?https://github.com/Th3K1n91/xitroo_api/tree/main/docs/index.html) in the docs folder.
## Contributing
We welcome contributions! Please fork the repository and submit pull requests.
## License
This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Th3K1n91/xitroo_api",
"name": "unofficial-xitroo-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "InSuckaBlyat88",
"author_email": "x.xxha001@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/2d/d4d924ccf29e9f337721395d43e06f331eb4c2dcd6831fbc6a57d0eebe44/unofficial_xitroo_api-0.9.tar.gz",
"platform": null,
"description": "# Unofficial Xitroo API\n\nThis is an unofficial API for interacting with the Xitroo email service. The API provides a set of Python classes and methods to manage email addresses, retrieve and send emails, handle inboxes, solve captchas, and more.\n\n## Table of Contents\n- [Installation](#Installation)\n- [Quick Start](#Quick-Start)\n- [Classes Overview](#classes-overview)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nTo install this package, clone the repository and install the required dependencies:\n\n```bash\npip install unofficial-xitroo-api\n```\n\n## Quick Start\n\nHere's a brief example to get you started:\n```python\nfrom xitroo import Xitroo\n\n# Generate mail\nemail = Xitroo.generate()\nprint(email)\n\n# Initialize the Xitroo object\nxitroo = Xitroo(\"your-email@xitroo.com\")\n\n# Get the inbox\ninbox = xitroo.Inbox()\n\n# Get the latest email\nlatest_mail = xitroo.getLatestMail()\nprint(latest_mail.getBodyText())\n\n# Print code form latest email\nprint(Xitroo.getCode(latest_mail))\n```\n## Classes Overview\n### Xitroo\nThe main class to interact with the Xitroo API. It includes methods for managing email addresses, headers, sessions, and performing various email operations.\n\n### Mail\nRepresents an email. It provides methods to retrieve email content, attachments, and metadata.\n\n### Inbox\nRepresents an inbox. It provides methods to retrieve emails and inbox information.\n\n### SearchMail\nProvides methods to search the inbox by different criteria such as date, sender, title, and text in the body.\n\n### Captcha\nHandles captcha-related operations including retrieving and verifying captchas.\n\n## Documentation\nFor detailed documentation, please refer to the [HTML documentation](http://htmlpreview.github.io/?https://github.com/Th3K1n91/xitroo_api/tree/main/docs/index.html) in the docs folder.\n\n## Contributing\nWe welcome contributions! Please fork the repository and submit pull requests.\n\n## License\nThis project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Xitroo API",
"version": "0.9",
"project_urls": {
"Bug Tracker": "https://github.com/Th3K1n91/xitroo_api/issues",
"Homepage": "https://github.com/Th3K1n91/xitroo_api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43cb120310d63aabe8333e400c357054e3c69f7a0e037acb6b6d55658c13fe71",
"md5": "2ab1d83050f908707e27ac8ae6c76ae4",
"sha256": "ec070aff2b7507325a4c27de33c7f19ba970c183e1ff695e0cec89ec63ba4a8a"
},
"downloads": -1,
"filename": "unofficial_xitroo_api-0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ab1d83050f908707e27ac8ae6c76ae4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 11630,
"upload_time": "2024-07-05T23:39:18",
"upload_time_iso_8601": "2024-07-05T23:39:18.836526Z",
"url": "https://files.pythonhosted.org/packages/43/cb/120310d63aabe8333e400c357054e3c69f7a0e037acb6b6d55658c13fe71/unofficial_xitroo_api-0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be2dd4d924ccf29e9f337721395d43e06f331eb4c2dcd6831fbc6a57d0eebe44",
"md5": "ccc2ebe32187a76400ea9f77e767f9d4",
"sha256": "080d2d9011b0d318be544f870a23f91f8a2048c6d4895feef578c9159efb5a2d"
},
"downloads": -1,
"filename": "unofficial_xitroo_api-0.9.tar.gz",
"has_sig": false,
"md5_digest": "ccc2ebe32187a76400ea9f77e767f9d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9134,
"upload_time": "2024-07-05T23:39:20",
"upload_time_iso_8601": "2024-07-05T23:39:20.691192Z",
"url": "https://files.pythonhosted.org/packages/be/2d/d4d924ccf29e9f337721395d43e06f331eb4c2dcd6831fbc6a57d0eebe44/unofficial_xitroo_api-0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 23:39:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Th3K1n91",
"github_project": "xitroo_api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "unofficial-xitroo-api"
}
JSON
