Skip to main content

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.

Project description

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 file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

IMAPArchiver-1.0.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

IMAPArchiver-1.0.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file IMAPArchiver-1.0.0.tar.gz.

File metadata

  • Download URL: IMAPArchiver-1.0.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for IMAPArchiver-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0a83feb48de19df451597b257bf41e682e2d2dfa421f16f72c8507865f4d8d75
MD5 2dd63a7c22147c28b06ba59d23b67615
BLAKE2b-256 9c0c1089d3e3c90b126314d716532707cbcf522d376a727e4b09515c1b00bc1c

See more details on using hashes here.

File details

Details for the file IMAPArchiver-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: IMAPArchiver-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for IMAPArchiver-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fd2e18622f4b7dd731efa6ab11b7cfa0e30445e31250716bb5fea11f585d8051
MD5 0b376cfc541100222c621f1e61f38240
BLAKE2b-256 8e42adfe8e156b024758924026d5ff62f534aa40fe36768c2813d5259e57b614

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page