README
¶
Iris
Iris is a CLI tool for dispatching templated emails.
Supported Services
- AWS SES
Install
Download a suitable binary from the latest GitHub
release. Or if you have
$GOPATH/bin in your system path, you can use go install.
go install github.com/trynoice/iris@latest
Usage
First, create working files using iris init. You can omit the positional argument to initialise files in the current working directory. These files contain a sensible configuration, a minimal email template and placeholder data to get you started quickly.
$ iris init sample-email
creating directory sample-email
creating file sample-email/.iris.yaml
creating file sample-email/recipients.csv
creating file sample-email/subject.txt
creating file sample-email/body.txt
creating file sample-email/body.html
creating file sample-email/default.csv
Working Files
.iris.yaml: Iris configuration for this email template.subject.txt: A Go template containing the subject line of the email.body.txt: A Go Template containing the body of the email in plain text format.body.html: A Go Template containing the body of the email in HTML format.recipients.csv: Data for rendering the email templates.default.csv: Fallback values for missing values in recipients' data file. You can also use it to inject data that remains the same for all recipients.
Configuration
service:
awsSes:
# If `true`, automatically load AWS configuration from ~/.aws or env
# vars.
useSharedConfig: true
# AWS region to for SES if `useSharedConfig` is `false`.
region:
# AWS configuration profile if `useSharedConfig` is `false`.
profile:
# API calls per second.
rateLimit: 10
# Number of retries before exiting with error on failing an API call.
retries: 3
message:
# Email FROM header.
sender: Iris CLI <iris@trynoice.com>
# Data for rendering the email templates. It must be in the same directory
# as this configuration.
recipientDataCsvFile: recipients.csv
# Fallback values for missing values in recipients' data file. You can also
# use it to inject data that remains the same for all recipients. It must be
# in the same directory as this configuration. It must contain only two
# rows: headers and values.
defaultDataCsvFile: default.csv
# Name of the column containing emails of recipients in `recipients.csv`.
recipientEmailColumnName: Email
# If true, minify rendered HTML before composing the email message.
minifyHtml: true
Send Emails
Verify rendered email for a template with a dry run.
$ iris send sample-email --dry-run
dispatching to jack@example.test
+-----------+---------------------------------------------------------+
| Subject | Hello Jack |
+-----------+---------------------------------------------------------+
| Text Body | Iris is a CLI tool for sending templated bulk emails. |
| | |
| | You can inject data into templates, e.g. a date - |
| | January 2006 or your email - jack@example.test. |
+-----------+---------------------------------------------------------+
| HTML Body | <!doctype html><html><head><meta name=viewport |
| | content="width=device-width,initial-scale=1"><meta |
| | charset=utf-8><title>Hello |
| | Jack</title></head><body><p>Iris is a CLI tool for |
| | sending templated bulk emails.</p><p>You can inject |
| | data into templates, e.g. a date - January 2006 or your |
| | email - jack@example.test.</p></body></html> |
+-----------+---------------------------------------------------------+
And dispatch emails.
$ iris send sample-email
confirm sending emails? [y/n] y
dispatching to jack@example.test
License
Documentation
¶
There is no documentation for this package.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.