Integrations
An integration is the provider that delivers your messages. Set one up with messengerr credentials setup NAME. This page is generated from the code, so it always matches the installed version.
| Integration | Delivers | Required credentials | Optional credentials |
|---|---|---|---|
postmark |
server_token, from |
none | |
clicksend |
sms | username, api_key |
from |
postmark
- Delivers: email
- Set up with:
messengerr credentials setup postmark - Required credentials:
server_token,from - Optional credentials: none
- Message formats: text, html
| Sending option | Command-line flag | What it does |
|---|---|---|
from |
--from |
Sender address or ID. Overrides the from stored with the credentials. |
batch_size |
--batch-size |
Messages per batch. Default 50. |
rate_limit |
--rate-limit |
Batches per second. Default 10. Counts batches, not messages. |
metadata |
not exposed yet | Reserved. Not used by any built-in integration. |
subject |
not exposed yet | Fallback email subject when a message has none. The wizard supplies a rendered subject per message. |
message_stream |
not exposed yet | Postmark message stream (for example outbound). |
tag |
not exposed yet | Postmark tag for grouping messages in reports. |
track_opens |
not exposed yet | Postmark open tracking (true or false). |
clicksend
- Delivers: sms
- Set up with:
messengerr credentials setup clicksend - Required credentials:
username,api_key - Optional credentials:
from - Message formats: text
- Maximum batch size: 1000
| Sending option | Command-line flag | What it does |
|---|---|---|
from |
--from |
Sender address or ID. Overrides the from stored with the credentials. |
batch_size |
--batch-size |
Messages per batch. Default 50. |
rate_limit |
--rate-limit |
Batches per second. Default 10. Counts batches, not messages. |
metadata |
not exposed yet | Reserved. Not used by any built-in integration. |
schedule |
not exposed yet | ClickSend send time, as a Unix timestamp. |
Options marked “not exposed yet” are supported by the integration but cannot be set from the command line today.
How failures are classified as definite or uncertain for each provider is described in Ledger and resume. To add your own, see Writing an integration.