By default, this method sends the email synchronously and returns a result only after the upstream provider has accepted it.
For better performance with large attachments or batch sending, set async: true
to queue the email for background processing.
Define the version of the Connect protocol
1 Define the timeout, in ms
Request to send an email.
Verified sender email address (e.g., "[email protected]").
Primary recipients.
Carbon copy recipients.
Blind carbon copy recipients.
Email subject line.
Plain text content. Always recommended for better deliverability.
HTML content.
Custom metadata to track this email. These values are returned in webhooks and events.
Schedule this email for a future time (UTC).
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"
File attachments.
A file attachment.
Message-ID of the email to reply to. Setting this automatically handles threading headers (In-Reply-To, References).
Explicit threading references. Usually not needed if in_reply_to is set.
Set to true to return immediately and send the email in the background.
Recommended for bulk sending or when attachments are large.
Success
Response after sending an email.
Unique system ID for this email. Use this to track events.
Current status.
EMAIL_STATUS_UNSPECIFIED, EMAIL_STATUS_QUEUED, EMAIL_STATUS_PROCESSING, EMAIL_STATUS_SENT, EMAIL_STATUS_FAILED Upstream Message-ID (if available immediately).
Human-readable description of the status.