What's Changed
Shoutrrr v0.25.0 adds Discord mentions and threads, XMPP server lookup through SRV records, Twilio API keys, and display names in SMTP addresses. It also changes how HTTP services treat redirects and replies, so a send counts as delivered only when the provider accepted it.
Redirects and Delivery
- A service's default HTTP client follows a redirect only on the same host name and never from HTTPS to HTTP. It also refuses a redirect that would resend a POST as a GET without its body, except a 303. A custom HTTP client keeps its own redirect policy.
- A send counts as delivered only on a 2xx status. A redirect the HTTP client did not follow, or any other status, fails the send instead of reporting success. A Slack webhook reply with a status other than 200 fails too.
- A Join push that the Join API refuses now fails instead of reporting success.
Discord
- Only the mentions listed in the new
mentionskey ping. An@everyone,@here, user, or role mention written in the message text no longer pings anyone. Earlier releases let a channel webhook ping@everyonefrom the text. - Each send waits for Discord to confirm the message was saved, and a failed send reports Discord's own error message.
- A webhook request is retried only when it could not connect, so a slow answer is never posted twice.
- The new
thread_namekey creates a thread in a forum or media channel.
Gotify
- Only application tokens are accepted. A client token fails when the URL is read, since Gotify 3 cannot send with one without an application ID.
- The token is sent in the
X-Gotify-Keyheader by default. Setuseheader=noto keep it in the query.
PagerDuty
- An
acknowledgeorresolveevent needs adedup_key, and it sends only the alert's key and action. - The new
titlekey becomes the event summary, and the message then goes tocustom_details.message. - An event over 512 KB,
detailsthat are not a JSON object, andtext:entries incontextsfail before the request.
MQTT
- Each sender connects with its own client ID by default, so two senders on one broker stop taking over each other's session. A broker that accepts only known client IDs needs
clientidset. - A message larger than the broker's maximum packet size fails instead of being dropped by the broker.
XMPP
- The server certificate is checked against the domain of the JID. A URL whose JID names another domain than its host needs a certificate for the JID's domain.
- A URL without a port whose host is the JID's domain finds the server through its SRV records, and falls back to the host when there are none.
SMTP
- Sender and recipient addresses can carry display names, such as
Jane Doe <jane@example.com>. - An address that is not a valid email address, such as a bare
root, is rejected when the URL is read. So is a recipient whose display name holds a comma.
Generic
- Settings in the URL query match in any letter case, so
Method=GETsets the method. A webhook parameter that shares a setting's name in another case is now read as that setting, and needs the__prefix to reach the webhook. A URL that names one setting in two spellings is rejected. contenttypenow applies to sends without a template. Without it, such a send still goes out astext/plain.- A
titlein the URL reaches the payload under the title key.
Twilio
- The new
apikeykey sends with an API key, with its secret as the password. - Only a sender of
MGfollowed by 32 hexadecimal characters is sent as a Messaging Service. An alphanumeric sender ID is sent as written. - An empty message or one over 1600 characters fails before the request.
Other Services
- Bark sends a badge only when it is positive, so a push no longer clears the app's notifications. A negative badge is rejected.
- Telegram sends with the Bot API 7.0 fields and shows the title in every parse mode. A thread ID that is not a positive integer is rejected.
- An ntfy topic behind a base path is published to the base path, so a server hosted at the root answers with an error instead of reading the topic as a sequence ID.
Deprecations
The following items are deprecated in this release. See the Deprecations documentation page for more information.
URL Settings
| Service | Deprecated | Replacement |
|---|---|---|
| Bark | category
| None |
Go API
| Package | Deprecated | Replacement |
|---|---|---|
| bark | Config.Category
| None |
| bark | PushPayload.Category
| None |
Commits
Features
- feat(smtp): support display names in sender and recipient addresses by @nicholas-fedor in #2170
- feat(discord): add a mentions key that adds pings and allows only them by @nicholas-fedor in #2196
- feat(discord): add thread_name to create threads in forum and media channels by @nicholas-fedor in #2198
- feat(xmpp): find the server through the JID domain's SRV records by @nicholas-fedor in #2234
- feat(twilio): send with API keys and classify sender IDs correctly by @nicholas-fedor in #2238
Fixes
- fix(join): fail pushes that the Join API refuses by @nicholas-fedor in #2172
- fix(bark): stop sending a badge of 0 with every push by @nicholas-fedor in #2176
- fix(httpclient): follow redirects only on the same host and never to HTTP by @nicholas-fedor in #2178
- fix(gotify): reject client tokens and send the token in a header by @nicholas-fedor in #2180
- fix(telegram): refuse generator redirects to another host by @nicholas-fedor in #2182
- fix(xoauth2): refuse token exchange redirects to another host by @nicholas-fedor in #2184
- fix(smtp): leave token request redirects to the sending client by @nicholas-fedor in #2186
- fix(discord): confirm delivery and report Discord's error reason by @nicholas-fedor in #2188
- fix(discord): name the invalid fields in form body errors by @nicholas-fedor in #2190
- fix(discord): keep split lines up to the embed description limit by @nicholas-fedor in #2192
- fix(discord): retry transport errors without net.Error.Temporary by @nicholas-fedor in #2194
- fix(discord): report server errors that may follow a saved message by @nicholas-fedor in #2200
- fix(matrix): log in again when the homeserver rejects a stored token by @nicholas-fedor in #2204
- fix(matrix): join rooms given by ID so an invite to them is accepted by @nicholas-fedor in #2206
- fix(matrix): explain a homeserver that offers no password login by @nicholas-fedor in #2208
- fix(ntfy): publish through a base path without naming a sequence ID by @nicholas-fedor in #2212
- fix(mqtt): give each sender its own client ID by default by @nicholas-fedor in #2214
- fix(mqtt): reject messages larger than the broker's maximum packet size by @nicholas-fedor in #2216
- fix(pushbullet): count a push as sent once Pushbullet accepts it by @nicholas-fedor in #2218
- fix(services): count a send as delivered only on a 2xx status by @nicholas-fedor in #2220
- fix(gotify): send every message through one jsonclient request by @nicholas-fedor in #2222
- fix(httpclient): refuse redirects that turn a request into a bodiless GET by @nicholas-fedor in #2224
- fix(telegram): send messages with the Bot API 7.0 fields by @nicholas-fedor in #2226
- fix(zulip): send channel messages that every Zulip version accepts by @nicholas-fedor in #2228
- fix(xmpp): verify the server's certificate against the JID domain by @nicholas-fedor in #2230
- fix(pagerduty): require a dedup_key to acknowledge or resolve and send the title by @nicholas-fedor in #2236
- perf(httpbody): read each response body to its end before closing it by @nicholas-fedor in #2240
- fix(mattermost): join the title and message with util.TitledMessage by @nicholas-fedor in #2244
- fix(services): read generic settings in any case and limit notifiarr fields by @nicholas-fedor in #2249
Full Changelog: v0.24.0...v0.25.0