# Bounce Mail Identifier
A Python package to identify and handle bounced emails. This package allows you to fetch bounce emails from an IMAP server, extract sender and failed recipient information, and save the data to an Excel file.
## Features
- Fetches bounce emails from an IMAP server.
- Extracts sender address and failed recipient email addresses.
- Saves bounce information to an Excel file.
- Easy to integrate and use.
## Supported Email Providers
- Gmail
- Microsoft Outlook
- Yahoo Mail
- Any other IMAP-compatible email provider
## Installation
To install this package, use pip:
```sh
pip install bounce-mail-identifier
```
## Usage
### Command Line
After installing, you can use the package from the command line.
```sh
fetch_bounces
```
### As a Module
You can also use it as a module in your Python code.
```python
from bounce_mail_identifier.bounce_mail_handler import fetch_bounce_emails, save_bounces_to_excel
# Provide your email credentials and server details
username = 'your-email@example.com'
app_password = 'your-app-password'
imap_server = 'imap.example.com'
# Fetch bounce emails
bounces = fetch_bounce_emails(username, app_password, imap_server)
# Save the bounces to an Excel file
save_bounces_to_excel(bounces, 'bounces.xlsx')
```
## Dependencies
- pandas
- openpyxl
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Author
Around With Us - [mscrabe@gmail.com](mailto:mscrabe@gmail.com)
## Acknowledgments
- [pandas](https://pandas.pydata.org/)
- [openpyxl](https://openpyxl.readthedocs.io/)
- [imaplib](https://docs.python.org/3/library/imaplib.html)
- [email](https://docs.python.org/3/library/email.html)
## Contributing
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.
Raw data
{
"_id": null,
"home_page": null,
"name": "bounce-mail-identifier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Bounce Emails, Email Handling, Python package, Email Processing, Email Automation",
"author": "Around With Us",
"author_email": "mscrabe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/94/97d6f9866d0e9ef857c56aa182c81ede5ec5068ee27a025b68c7478c88c8/bounce_mail_identifier-1.0.2.tar.gz",
"platform": null,
"description": "\r\n# Bounce Mail Identifier\r\n\r\nA Python package to identify and handle bounced emails. This package allows you to fetch bounce emails from an IMAP server, extract sender and failed recipient information, and save the data to an Excel file.\r\n\r\n## Features\r\n\r\n- Fetches bounce emails from an IMAP server.\r\n- Extracts sender address and failed recipient email addresses.\r\n- Saves bounce information to an Excel file.\r\n- Easy to integrate and use.\r\n\r\n## Supported Email Providers\r\n\r\n- Gmail\r\n- Microsoft Outlook\r\n- Yahoo Mail\r\n- Any other IMAP-compatible email provider\r\n\r\n\r\n## Installation\r\n\r\nTo install this package, use pip:\r\n\r\n```sh\r\npip install bounce-mail-identifier\r\n```\r\n\r\n## Usage\r\n\r\n### Command Line\r\n\r\nAfter installing, you can use the package from the command line.\r\n\r\n```sh\r\nfetch_bounces\r\n```\r\n\r\n### As a Module\r\n\r\nYou can also use it as a module in your Python code.\r\n\r\n```python\r\nfrom bounce_mail_identifier.bounce_mail_handler import fetch_bounce_emails, save_bounces_to_excel\r\n\r\n# Provide your email credentials and server details\r\nusername = 'your-email@example.com'\r\napp_password = 'your-app-password'\r\nimap_server = 'imap.example.com'\r\n\r\n# Fetch bounce emails\r\nbounces = fetch_bounce_emails(username, app_password, imap_server)\r\n\r\n# Save the bounces to an Excel file\r\nsave_bounces_to_excel(bounces, 'bounces.xlsx')\r\n```\r\n\r\n## Dependencies\r\n\r\n- pandas\r\n- openpyxl\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Author\r\n\r\nAround With Us - [mscrabe@gmail.com](mailto:mscrabe@gmail.com)\r\n\r\n## Acknowledgments\r\n\r\n- [pandas](https://pandas.pydata.org/)\r\n- [openpyxl](https://openpyxl.readthedocs.io/)\r\n- [imaplib](https://docs.python.org/3/library/imaplib.html)\r\n- [email](https://docs.python.org/3/library/email.html)\r\n\r\n## Contributing\r\n\r\nIf you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A package to fetch bounce emails and save them to an Excel file",
"version": "1.0.2",
"project_urls": null,
"split_keywords": [
"bounce emails",
" email handling",
" python package",
" email processing",
" email automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bdc4bde17d95f8948cebc4984f31e3403290c5df10ad9c92627fdc550ccc042",
"md5": "6114d3efb783b28b301f012b3285eb64",
"sha256": "8a646412fd72302c387b2fa4047cdca5b0c2243a84facaa5ed627f3dda444d5a"
},
"downloads": -1,
"filename": "bounce_mail_identifier-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6114d3efb783b28b301f012b3285eb64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4172,
"upload_time": "2024-07-22T09:21:37",
"upload_time_iso_8601": "2024-07-22T09:21:37.822456Z",
"url": "https://files.pythonhosted.org/packages/9b/dc/4bde17d95f8948cebc4984f31e3403290c5df10ad9c92627fdc550ccc042/bounce_mail_identifier-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "019497d6f9866d0e9ef857c56aa182c81ede5ec5068ee27a025b68c7478c88c8",
"md5": "efba98fb3f36ab54fa0b4d3d19e2fb8e",
"sha256": "1fdae4cce890d5b4223b862117460b494866d50888708fb503fd9980f32febac"
},
"downloads": -1,
"filename": "bounce_mail_identifier-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "efba98fb3f36ab54fa0b4d3d19e2fb8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3287,
"upload_time": "2024-07-22T09:21:39",
"upload_time_iso_8601": "2024-07-22T09:21:39.140524Z",
"url": "https://files.pythonhosted.org/packages/01/94/97d6f9866d0e9ef857c56aa182c81ede5ec5068ee27a025b68c7478c88c8/bounce_mail_identifier-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 09:21:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bounce-mail-identifier"
}
JSON