Skip to main content

Send scheduled emails

Project description


Build Status

Data Format

  • Emails
    • First column is names (see special names in emailer/
    • Second column is default values for each name
    • Next column(s) is one email each, with values replaced by default if empty
  • Recipients
    • Each row is one recipient made up of:
      • Email
      • Groups they are members of (e.g. Active, Dryrun)
      • Any number of highlights (this can be a name in the Emails sheet)


usage: email [-h] [-c CONFIG_DIR] [-k [KEY_NAMES [KEY_NAMES ...]]]
             [--all-keys] [-d DATE] [-v] [-V] [--sample-config] [--active]
             [--dryrun] [--test]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_DIR, --config-dir CONFIG_DIR
                        Directory containing config file. Default is current
                        working directory.
  -k [KEY_NAMES [KEY_NAMES ...]], --key-names [KEY_NAMES [KEY_NAMES ...]]
                        Key name(s) matching key(s) in the config.
  --all-keys            Run for all available keys in config.
  -d DATE, --date DATE  Date for which to send emails (YYYY-MM-DD). The
                        default is today.
  -v, --verbose         Display more logging output
  -V, --version         Print the current emailer module version.
  --sample-config       Print a sample config. Save as emailer.json or
  --active              Send emails to all active recipients.
  --dryrun              Send emails one day early to dryrun recipients.
  --test                Send emails only to test recipients.
  • Enable the Gmail and Sheets APIs.
  • Set up a config json file using --sample-config
    • Save the result as emailer.json in home dir.
    • The spreadsheet key is the long entry in the URL:<key>/edit

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
emailer-1.0.11-py3-none-any.whl (12.1 kB) Copy SHA256 hash SHA256 Wheel py3
emailer-1.0.11.tar.gz (8.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page