@@ -9,6 +9,7 @@ Iris is a CLI tool for dispatching templated emails.
9
9
## Supported Services
10
10
11
11
- AWS SES
12
+ - SMTP
12
13
13
14
## Install
14
15
@@ -48,35 +49,53 @@ creating file sample-email/default.csv
48
49
- ` body.html ` : A [ Go Template] ( https://pkg.go.dev/text/template ) containing the
49
50
body of the email in HTML format.
50
51
- ` recipients.csv ` : Data for rendering the email templates.
51
- - ` default.csv ` : Fallback values for missing values in recipients' data file.
52
- You can also use it to inject data that remains the same for all recipients.
52
+ - ` default.csv ` : Optional fallback values for missing values in recipients' data
53
+ file. You can also use it to inject data that remains the same for all
54
+ recipients.
53
55
54
56
### Configuration
55
57
56
58
``` yaml
57
59
service :
60
+ # If using AWS SES backend.
58
61
awsSes :
59
- # If `true`, automatically load AWS configuration from ~/.aws or env
60
- # vars.
62
+ # If `true`, automatically load AWS configuration from ~/.aws or env vars.
61
63
useSharedConfig : true
62
- # AWS region to for SES if `useSharedConfig` is `false`.
64
+ # AWS region for SES if `useSharedConfig` is `false`.
63
65
region :
64
66
# AWS configuration profile if `useSharedConfig` is `false`.
65
67
profile :
68
+
69
+ # If using SMTP server backend.
70
+ smtp :
71
+ # Host name of the smtp server.
72
+ host :
73
+ # Port of the smtp server.
74
+ port :
75
+ # Username for authenticating on the smtp server.
76
+ username :
77
+ # Password for authenticating on the smtp server.
78
+ password :
79
+ # One of 'none', 'ssl', 'tls', 'ssl/tls' (default), 'starttls'.
80
+ encryption :
81
+
66
82
# API calls per second.
67
83
rateLimit : 10
68
84
# Number of retries before exiting with error on failing an API call.
69
85
retries : 3
70
86
message :
71
- # Email FROM header.
87
+ # An address for the 'From' email header.
72
88
sender :
Iris CLI <[email protected] >
89
+ # A list of addresses for the 'Reply-To' email header.
90
+ replyToAddresses :
91
+
73
92
# Data for rendering the email templates. It must be in the same directory
74
93
# as this configuration.
75
94
recipientDataCsvFile : recipients.csv
76
- # Fallback values for missing values in recipients' data file. You can also
77
- # use it to inject data that remains the same for all recipients. It must be
78
- # in the same directory as this configuration. It must contain only two
79
- # rows: headers and values.
95
+ # (Optional) Fallback values for missing values in recipients' data file.
96
+ # You can also use it to inject data that remains the same for all
97
+ # recipients. It must be in the same directory as this configuration. It
98
+ # must contain only two rows: headers and values.
80
99
defaultDataCsvFile : default.csv
81
100
# Name of the column containing emails of recipients in `recipients.csv`.
82
101
recipientEmailColumnName : Email
0 commit comments