Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rjarry/notmuch-gmail
Bidirectional sync of Gmail messages with notmuch database
https://github.com/rjarry/notmuch-gmail
gmail notmuch oauth2
Last synced: 23 days ago
JSON representation
Bidirectional sync of Gmail messages with notmuch database
- Host: GitHub
- URL: https://github.com/rjarry/notmuch-gmail
- Owner: rjarry
- License: mit
- Created: 2018-01-12T08:46:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-13T23:34:20.000Z (almost 3 years ago)
- Last Synced: 2023-03-11T12:57:31.745Z (over 1 year ago)
- Topics: gmail, notmuch, oauth2
- Language: Python
- Size: 53.7 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notmuch-gmail
Bidirectional sync of Gmail messages with a notmuch database.
## Description
`notmuch-gmail` is a command line application that can pull email and labels
(and changes to labels) from your Gmail account and store them locally in a
maildir with the labels synchronized with a notmuch database. The changes to
tags in the notmuch database may be pushed back remotely to your Gmail account.
## Installation
```
git clone https://git.sr.ht/~rjarry/notmuch-gmail
cd notmuch-gmail
python3 -m pip install -e .
```
NB: notmuch python bindings must be installed first (e.g. `apt install
python3-notmuch`)
## Quickstart
Run this in a terminal and follow the instructions:
```
notmuch-gmail
```
The first sync will take a long time. After which you should run the same
command in your user's crontab:
```
*/5 * * * * notmuch-gmail --logfile ~/.notmuch-gmail.log
```
Or run it manually when needed.
## Configuration & Advanced Usage
The default configuration file is loaded from `~/.notmuch-gmail-config`. You
can initialize the file with the following command:
```
notmuch-gmail --defconfig > ~/.notmuch-gmail-config
```
And open it with an editor.
## Privacy Policy
* `notmuch-gmail` is a **local** command line application. It uses OAuth2 to
access your Gmail data and will **NOT** share anything with anyone.
* `notmuch-gmail` uses the Gmail web API to access (READ) your messages and
labels.
* `notmuch-gmail` uses the Gmail web API to change (ADD, REMOVE) the labels
associated with messages.
* `notmuch-gmail` uses the Gmail web API to change (ADD, REMOVE) your Gmail
labels.
* `notmuch-gmail` uses the Gmail web API to add (INSERT) new DRAFT and SENT
messages.
* `notmuch-gmail` will not and can not:
- Add or delete messages on your remote account (except syncing the `trash`
or `spam` label to messages, and those messages will eventually be
[deleted](https://support.google.com/mail/answer/7401?co=GENIE.Platform%3DDesktop&hl=en))
- Modify messages other than their labels
* `notmuch-gmail` is free software released under the [MIT
license](https://opensource.org/licenses/MIT) and comes with **NO
WARRANTIES**.