Skip to content

Commit af0dcea

Browse files
committed
update README.md
1 parent df73e80 commit af0dcea

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Iris is a CLI tool for dispatching templated emails.
99
## Supported Services
1010

1111
- AWS SES
12+
- SMTP
1213

1314
## Install
1415

@@ -48,35 +49,53 @@ creating file sample-email/default.csv
4849
- `body.html`: A [Go Template](https://pkg.go.dev/text/template) containing the
4950
body of the email in HTML format.
5051
- `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.
5355

5456
### Configuration
5557

5658
```yaml
5759
service:
60+
# If using AWS SES backend.
5861
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.
6163
useSharedConfig: true
62-
# AWS region to for SES if `useSharedConfig` is `false`.
64+
# AWS region for SES if `useSharedConfig` is `false`.
6365
region:
6466
# AWS configuration profile if `useSharedConfig` is `false`.
6567
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+
6682
# API calls per second.
6783
rateLimit: 10
6884
# Number of retries before exiting with error on failing an API call.
6985
retries: 3
7086
message:
71-
# Email FROM header.
87+
# An address for the 'From' email header.
7288
sender: Iris CLI <[email protected]>
89+
# A list of addresses for the 'Reply-To' email header.
90+
replyToAddresses:
91+
- Noice App <[email protected]>
7392
# Data for rendering the email templates. It must be in the same directory
7493
# as this configuration.
7594
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.
8099
defaultDataCsvFile: default.csv
81100
# Name of the column containing emails of recipients in `recipients.csv`.
82101
recipientEmailColumnName: Email

0 commit comments

Comments
 (0)