Jeremiah Russell
a5ea370af2
- enhance documentation for library and CLI tools, providing comprehensive guides - include installation, quick start, core types, config, error handling, async runtime - add gmail query syntax, performance details, logging, security, and troubleshooting - provide detailed command references, examples, workflows, safety features, and debugging - update readme headers to reflect new doc structure
The cull-gmail provides a software library and command line program to enable the culling of emails using the Gmail API.
Main Features
- login to get authorization
- backup the mailbox
- filtered lists of the contents
- move email matching a filtered list to trash
cull-gmail Library Documentation
The cull-gmail library provides types to enable the culling of emails using the Gmail API including the following steps:
- login to get authorization
- backup the mailbox
- filtered lists of the contents
- move email matching a filtered list to trash
Installation
Add the library to your program's Cargo.toml using cargo add:
$ cargo add cull-gmail
Or by configuring the dependencies manually in Cargo.toml:
[dependencies]
cull-gmail = "0.0.10"
cull-gmail CLI
A command line program to cull emails from Gmail using the Gmail API. The tool has sub-commands to for authorization, planning and executing the move of select email to the Gmail trash folder from which they will be automatically deleted after thirty days.
Installation
Install cull-gmail using Cargo:
cargo install cull-gmail
License
By contributing to cull-gmail, you agree that your contributions will be licensed under the MIT License. This means:
- You grant permission for your contributions to be used, modified, and distributed under the terms of the MIT License
- You confirm that you have the right to submit the code under this license
- You understand that your contributions will become part of the project and available to all users under the MIT License
Contribution
Thank you for your interest in contributing to cull-gmail! We welcome contributions from the community and appreciate your help in making this project better.
Further details can be found in the contribution document.