apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2025-08-04 06:31:06 +02:00

Table of Contents

Resend Notifications

Account Setup
Syntax
Parameter Breakdown

Example

Resend Notifications

Source: https://resend.com/
Icon Support: no
Attachment Support: Yes
Message Format: Text
Message Limit: 32768 Characters per message

Account Setup

Creating an account with Resend is free of charge and can be done through their main page.

Once you have an account and access to your dashboard. You will need to ensure you've correctly authenticated your domains with them; this is done from the Domains section of your dashboard.

The last thing you need is to generate an API Key with at least the Sending permission. This can also be done through your dashboard in the API Keys section of your dashboard.

Syntax

Valid syntaxes are as follows:

resend://{apikey}:{from_email}
resend://{apikey}:{from_email}/{to_email}
resend://{apikey}:{from_email}/{to_email1}/{to_email2}/{to_email3}

Parameter Breakdown

Variable	Required	Description
apikey	Yes	The API Key you generated from within your Resend dashboard.
from_email	Yes	This is the email address will identify the email's origin (the From address). This address must contain a domain that was previously authenticated with your Resend account (See Domain section of API).
to_email	No	This is the email address will identify the email's destination (the To address). If one isn't specified then the from_email is used instead.
cc	No	The Carbon Copy (CC:) portion of the email. This is entirely optional. It should be noted that Resend immediately rejects emails where the cc contains an email address that exists in the to or the bcc list. To avoid having issues, Apprise automatically eliminates these duplicates silently if detected.
bcc	No	The Blind Carbon Copy (BCC:) portion of the email. This is entirely optional. It should be noted that Resend immediately rejects emails where the bcc contains an email address that exists in the to or the cc list. To avoid having issues, Apprise automatically eliminates these duplicates silently if detected. If an identical email is detected in both the CC and the BCC list, the BCC list will maintain the email and it will drop from the CC list automatically.

Example

Send a Resend notification:

# Assuming our {apikey} is re_bcd123-xyz
# Assuming our Authenticated Domain is example.com, we might want to
#  set our {from_email} to noreply@example.com
# Assuming our {to_email} is someone@microsoft.com
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   resend:///re_bcd123-xyz:noreply@example.com/someone@microsoft.com

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface