mail_email_list

Tool

mail_email_list

List this product’s emails, newest first.

List this product’s emails, newest first. Filter by recipient, status, sender domain, subject, template or creation time; paginate with nextCursor. Use mail_email_get for last_event.

Behavior

HTTP: GET /mail/emails

Arguments

Name	Type	Required	Description
q	string	—	Case-insensitive subject search
to	string	—	Filter by a recipient address
after	string	—	ISO-8601 lower bound on created_at (inclusive)
limit	integer	—	Page size, 1-100. Defaults to 25.
before	string	—	ISO-8601 upper bound on created_at (exclusive)
cursor	string	—	Opaque cursor from the previous page’s `nextCursor`. Omit for the first page.
domain	string	—	Filter by sender domain
status	string	—	Filter by email status
template_id	string	—	Filter by the template the email was rendered from

Response

Field	Type	Always	Description
items	array	•	Emails in descending creation order
nextCursor	string	•	Opaque cursor for the next page; null at the end

Try it

List this product’s emails, newest first.

When to use

List this product’s emails, newest first. Filter by recipient, status, sender domain, subject, template or creation time; paginate with nextCursor. Use mail_email_get for last_event.

Example

Ask your agent something like this:

List this product’s emails, newest first.

The agent will invoke mail_email_list with these arguments:

{}