Skip to content
post

Create email

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/messaging/messages/email

Description

Create a new email message.

Required scopes

messages.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Parameters

string
Required

Message ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

Email Subject.

string
Required

Email Content.

array

List of Topic IDs.

array

List of User IDs.

array

List of Targets IDs.

array

Array of target IDs to be added as CC.

array

Array of target IDs to be added as BCC.

array

Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.

string

Email address to reply to. If not set, defaults to the sender email address.

string

Name of the reply to recipient. If not set, defaults to the sender name.

boolean

Is message a draft

boolean

Is content of type HTML

string

Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

Status
Content type
201
application/json

Message

Name
Type
Description
string

Message ID.

string

Message creation time in ISO 8601 format.

string

Message update date in ISO 8601 format.

string

Message provider type.

arrayof string

Topic IDs set as recipients.

arrayof string

User IDs set as recipients.

arrayof string

Target IDs set as recipients.

string

The scheduled time for message.

string

The time when the message was delivered.

arrayof string

Delivery errors if any.

integer

Number of recipients the message was delivered to.

object

Data of the message.

draft | processing | scheduled | sent | failed

Status of delivery.

HTTP
POST /v1/messaging/messages/email HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
Accept: application/json
X-Appwrite-Response-Format: 2.4.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
{
  "messageId": "<MESSAGE_ID>",
  "subject": "<SUBJECT>",
  "content": "<CONTENT>",
  "topics": [],
  "users": [],
  "targets": [],
  "cc": [],
  "bcc": [],
  "attachments": [],
  "replyToEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "draft": false,
  "html": false,
  "scheduledAt": "2020-10-15T06:38:00.000+00:00"
}