mailz

Basic mailing tool.

Installation

With pip:

pip install mailz

Shell completion installation

Depending on your shell:

• For Bash:

  _MAILZ_COMPLETE=source_bash mailz > deckz-complete.sh

• For Zsh:

  _MAILZ_COMPLETE=source_zsh mailz > deckz-complete.sh

• For Fish:

  _MAILZ_COMPLETE=source_fish mailz > deckz-complete.sh

And then source/activate the resulting file in your shell config.

Directory Structure

mailz works with assumptions on the directory structure of your mailing directory. Among those assumptions:

• your directory should be a git repository
• it should contain jinja2 mail templates in the templates/jinja2 directory
• it should contain YAML templates in the templates/yml directory, with specific names (listed below)
• a user-config.yml file should exist in the mailz config dir (depends on platform, on GNU/Linux it'll commonly be $HOME/.config/mailz), containing your sendgrid credentials and sending email

root (git repository)
├── templates
│   ├── jinja2
│   │   ├── signup.txt
│   │   └── event.txt
│   └── yml
│       ├── mailing-config.yml
│       └── user-config.yml
└── mailing-signup-september.yml

Usage

See the --help flag of the mailz command line tool.