gmail-backup
v0.2.2
Published
gmail backup tool
Downloads
15
Readme
gmail-backup
Tool for backing up all your gmail messages
It's available as helm chart with cronjob ready to use as truenas scale app in ugly-charts catalog
Configuration
| Env variable | Description | Default value |
|------------------|-------------------------------------|-----------------------------|
| SECRETS_PATH
| Path to store sensitive credentials | ~/.gmail-backup/secrets
|
| SNAPSHOTS_PATH
| Path to store all messages | ~/.gmail-backup/snapshots
|
Setup oauth credentials
- Create project and OAuth 2.0 Client ID for Desktop client at https://console.cloud.google.com/apis/credentials. Use
download JSON
button, then save file in secrets directory asclient_secret.json
- Enable gmail api at https://console.cloud.google.com/apis/library/gmail.googleapis.com
- Use
gmail-backup oauth
to connect gmail-backup with your google account
Usage
$ npm install -g gmail-backup
$ gmail-backup COMMAND
running command...
$ gmail-backup (--version)
gmail-backup/0.2.1 linux-x64 node-v18.9.0
$ gmail-backup --help [COMMAND]
USAGE
$ gmail-backup COMMAND
...
Commands
gmail-backup help [COMMAND]
Display help for gmail-backup.
USAGE
$ gmail-backup help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for gmail-backup.
See code: @oclif/plugin-help
gmail-backup oauth
Setup your google account with oauth. It supports multiple accounts.
USAGE
$ gmail-backup oauth
DESCRIPTION
Setup your google account with oauth. It supports multiple accounts.
See code: src/commands/oauth/index.ts
gmail-backup snapshot create
Creates new incremental snapshot in configured directory. It's meant to be run periodically (for example with cron).
USAGE
$ gmail-backup snapshot create
DESCRIPTION
Creates new incremental snapshot in configured directory. It's meant to be run periodically (for example with cron).