# IMAPArchiver
Have you ever found yourself in a situation where your IMAP mailbox is getting a bit too full, and you're concerned about losing important data?
The IMAPArchiver is here to ensure that no email goes missing. By exporting your emails to a local folder, you can safely backup your email data and store it in cloud storage solutions.
This enables easy access to old documents and provides a reliable backup solution for your important emails.
## Features
- Export emails from an IMAP mailbox to a local folder.
- Filter emails based on the specified year.
- Support for SSL connection.
- Option to skip specific IMAP folders.
- Verbose logging and debug mode for detailed output.
## Usage
Getting started is easy! Simply install IMAPArvchiver and configure the script with your IMAP server details and desired options, and run it. Your emails will be safely exported to the specified local folder, ready for backup or archiving.
Install:
```
pip install imaparchiver
```
Run IMAPArchiver with appropriate command-line arguments:
- `--server -s`: IMAP server address (required).
- `--user -u`: Username for IMAP authentication (required).
- `--password -p`: Password for IMAP authentication (required).
- `--destination -d`: Export folder path where emails will be saved (required).
- `--year -y`: Year to filter emails (optional).
- `--ssl`: Use SSL connection (optional).
- `--port`: Port number of the IMAP server (optional).
- `--skip`: Comma-separated list of IMAP folders to skip (optional).
- `--verbose`: Enable verbose logging (optional).
- `--debug`: Print debug output (optional).
Example:
```
imaparchiver -s imap.example.com -u john@example.com -p secret -d /path/to/export_folder -y 2022 --ssl --skip "Spam,Trash" --verbose
```
## Contribute
I welcome contributions from the community! If you've found a bug, have a feature request, or want to contribute code improvements, please submit an issue or pull request to this repository.
- Fork this repository.
- Create a branch: git checkout -b development.
- Make your changes and commit them: git commit -m '<commit_message>'
- Push to the original branch: git push origin flojud/IMAPArchiver
- Create the pull request.
Keep your mailbox organized and your data safe with the IMAPArchiver. Happy exporting!
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/flojud/IMAPArchiver",
"name": "IMAPArchiver",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "imap email export backup archive",
"author": "flojud",
"author_email": "dev.flojud@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9c/0c/1089d3e3c90b126314d716532707cbcf522d376a727e4b09515c1b00bc1c/IMAPArchiver-1.0.0.tar.gz",
"platform": null,
"description": "# IMAPArchiver\n\nHave you ever found yourself in a situation where your IMAP mailbox is getting a bit too full, and you're concerned about losing important data?\n\nThe IMAPArchiver is here to ensure that no email goes missing. By exporting your emails to a local folder, you can safely backup your email data and store it in cloud storage solutions.\n\nThis enables easy access to old documents and provides a reliable backup solution for your important emails.\n\n## Features\n\n- Export emails from an IMAP mailbox to a local folder.\n- Filter emails based on the specified year.\n- Support for SSL connection.\n- Option to skip specific IMAP folders.\n- Verbose logging and debug mode for detailed output.\n\n## Usage\n\nGetting started is easy! Simply install IMAPArvchiver and configure the script with your IMAP server details and desired options, and run it. Your emails will be safely exported to the specified local folder, ready for backup or archiving.\n\nInstall:\n\n```\npip install imaparchiver\n```\n\nRun IMAPArchiver with appropriate command-line arguments:\n\n- `--server -s`: IMAP server address (required).\n- `--user -u`: Username for IMAP authentication (required).\n- `--password -p`: Password for IMAP authentication (required).\n- `--destination -d`: Export folder path where emails will be saved (required).\n- `--year -y`: Year to filter emails (optional).\n- `--ssl`: Use SSL connection (optional).\n- `--port`: Port number of the IMAP server (optional).\n- `--skip`: Comma-separated list of IMAP folders to skip (optional).\n- `--verbose`: Enable verbose logging (optional).\n- `--debug`: Print debug output (optional).\n\nExample:\n\n```\nimaparchiver -s imap.example.com -u john@example.com -p secret -d /path/to/export_folder -y 2022 --ssl --skip \"Spam,Trash\" --verbose\n```\n\n## Contribute\n\nI welcome contributions from the community! If you've found a bug, have a feature request, or want to contribute code improvements, please submit an issue or pull request to this repository.\n\n- Fork this repository.\n- Create a branch: git checkout -b development.\n- Make your changes and commit them: git commit -m '<commit_message>'\n- Push to the original branch: git push origin flojud/IMAPArchiver\n- Create the pull request.\n\nKeep your mailbox organized and your data safe with the IMAPArchiver. Happy exporting!\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The IMAPArchiver is a command-line tool that exports emails from your IMAP mailbox to a local folder, helping you keep your mailbox organized and your data backed up.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/flojud/IMAPArchiver/issues",
"Homepage": "https://github.com/flojud/IMAPArchiver"
},
"split_keywords": [
"imap",
"email",
"export",
"backup",
"archive"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e42adfe8e156b024758924026d5ff62f534aa40fe36768c2813d5259e57b614",
"md5": "0b376cfc541100222c621f1e61f38240",
"sha256": "fd2e18622f4b7dd731efa6ab11b7cfa0e30445e31250716bb5fea11f585d8051"
},
"downloads": -1,
"filename": "IMAPArchiver-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b376cfc541100222c621f1e61f38240",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8465,
"upload_time": "2024-03-14T17:45:17",
"upload_time_iso_8601": "2024-03-14T17:45:17.945990Z",
"url": "https://files.pythonhosted.org/packages/8e/42/adfe8e156b024758924026d5ff62f534aa40fe36768c2813d5259e57b614/IMAPArchiver-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c0c1089d3e3c90b126314d716532707cbcf522d376a727e4b09515c1b00bc1c",
"md5": "2dd63a7c22147c28b06ba59d23b67615",
"sha256": "0a83feb48de19df451597b257bf41e682e2d2dfa421f16f72c8507865f4d8d75"
},
"downloads": -1,
"filename": "IMAPArchiver-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2dd63a7c22147c28b06ba59d23b67615",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8001,
"upload_time": "2024-03-14T17:45:19",
"upload_time_iso_8601": "2024-03-14T17:45:19.685442Z",
"url": "https://files.pythonhosted.org/packages/9c/0c/1089d3e3c90b126314d716532707cbcf522d376a727e4b09515c1b00bc1c/IMAPArchiver-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-14 17:45:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flojud",
"github_project": "IMAPArchiver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "imaparchiver"
}
JSON
