Skip to content

mail_email_get

Retrieve an email by id, with its last event

Tool

mail_email_get

Retrieve an email by id, with its last event

Retrieve an email by id, with its last event

Behavior

HTTP
GET /mail/emails/:id

Arguments

Name
Type
Required
Description
id
string
•
Email id — as returned by mail_email_send

Response

Field
Type
Always
Description
cc
array
•
Cc recipients; empty when there were none
id
string
•
Email id
to
array
•
Primary recipients
bcc
array
•
Bcc recipients; empty when there were none. Never appeared in the message headers.
from
string
•
Sender the message was sent as
status
string
•
Where the email stands: scheduled, queued, sent, failed, canceled, delivered, bounced, complained, suppressed or blocked
subject
string
•
Subject line as sent, after any template rendering
created_at
string
•
ISO-8601 instant the email was accepted
last_event
object
•
The latest lifecycle event, the reason `status` reads as it does
template_id
string
•
Template the email was rendered from; null for an inline send
scheduled_at
string
•
ISO-8601 instant the email is scheduled for; null when it was sent immediately
template_name
string
•
Name of that template; null for an inline send
provider_message_id
string
•
The sending provider’s own id, for correlating with its logs; null until the email leaves

Try it

Retrieve an email by id, with its last event.

When to use

Retrieve an email by id, with its last event

Example

Ask your agent something like this:

Retrieve an email by id, with its last event.

The agent will invoke mail_email_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select