gwbackupy: Google Workspace™ backup and restore solution.

What is it?

Gwbackupy is an open source Google Workspace™ backup and restore solution, written in python.

Currently supported Gmail messages and labels only.

Why?

Due to gmvault limitations:

• is still abandoned (??)
• authentication method is not usable in Google Workspace wide
• designed only for gmail messages
• only supports IMAP protocol (slow and less security)

Details

• Run from CLI or run directly from python code

• Authentication

  • OAUTH for free or paid plans (not recommended for paid plans)
  • Service account file (JSON or P12) for paid plans (can be configured to access all accounts in workspace.)

• Version controlled storage interface

  Allows to restore specific moments without using an external snapshot system (eg. zips, file system with snapshot). Not limited to file storage and is not limited to the use of a database server. Currently, file system based storage is only available.

• Dry mode (not write to local storage and not modify on server)

• API communication (no need for special IMAP and other settings): secure and fast

• Gmail backup

  • full backup (download all messages, labels)

  • full backup continuously (periodically rerunning)

    Scanning the full mailbox, but download only the new messages and mark the deleted messages.

  • Quick backup (sync the last N days)

• Gmail restore

  • restore deleted message in specified interval
  • full restore messages and labels to an empty mailbox (e.g. to other gmail account)

Paid plans are the following: here. Google One or additional storages are not considered as paid plans

Requirements

• python3 and pip

• Google Cloud account and own created access files. This software does not contain access files, this is for security reasons.

  A credit card is required during registration, but the use of Workspace APIs is free.

Install

The easiest way for installing:

pip install gwbackupy
# and run...
gwbackupy ...

or

# clone this repository
# install requirements
pip install -r requirements.txt
# and run...
python3 -m gwbackupy ...

The project also has an official Docker image: gwbackupy-docker - under development. The docker image has scheduled backup runs and also supports managing multiple email accounts.

Instructions

• GCP OAUTH access setup

  For free Gmail plan or paid Google Workspace™ plans

• GCP Service Account Setup

  Only for paid Google Workspace™ plans

Usage

• Parameters

Example usage Gmail

Backup run in CLI:

gwbackupy \
  --service-account-key-filepath <service-acount-json-key-file> \
  --batch-size 5 \
  gmail backup \
  --email <mailbox email address>

Restore run in CLI:

gwbackupy \
  --service-account-key-filepath <service-acount-json-key-file> \
  --batch-size 5 \
  gmail restore \
  --add-label "backup-restore-1231" \
  --add-label "more-restore-label" \
  --filter-date-from <date or datetime eg. "2023-01-01"> \
  --filter-date-to <date or datetime eg. "2023-02-02 03:00:00"> \
  --restore-deleted \
  --email <source backup mailbox email address> \
  --to-email <destination mailbox email address> # If you want to a different destination account

Backup run from python code:

# WARNING: Calling directly from python code actively change in the current state of development.

from gwbackupy.gmail import Gmail
from gwbackupy.storage.file_storage import FileStorage
from gwbackupy.providers.gmail_service_provider import GmailServiceProvider
from gwbackupy.providers.gapi_gmail_service_wrapper import GapiGmailServiceWrapper

storage = FileStorage('./data/[email protected]')
service_provider = GmailServiceProvider(
    service_account_file_path='serviceacc.json',
    storage=storage,
)
service_wrapper = GapiGmailServiceWrapper()
gmail = Gmail(email='[email protected]',
              service_provider=service_provider,
              service_wrapper=service_wrapper,
              batch_size=3,
              storage=storage)
if gmail.backup():
    print('Yeah!')
else:
    print(':(')

Security

See SECURITY.md

Contributing

Welcome! I am happy that you want to make the project better.

Currently, there is no developed documentation for the process, in the meantime, please use issues and pull requests.

Changelog

The changes are contained in CHANGELOG.md.

About

Márton Somogyi