Read the Imbox. Reads the Imbox: mail from people and senders the account screened in. Lists threads in HEY’s order: those not yet seen first, then the rest, each part by observed_at, newest first. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "imbox", threads: [Thread in a box], next_page }
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read The Feed. Reads The Feed: newsletters and other mail the account reads as a stream. Lists threads newest first, by active_at. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "feed", threads: [Thread in a box], next_page }
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read the Paper Trail. Reads the Paper Trail: receipts, notifications and other mail kept for the record. Lists threads newest first, by active_at. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "paper_trail", threads: [Thread in a box], next_page }
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read Reply Later. Reads Reply Later: threads the account saved to answer later. Lists threads in HEY’s order: those not yet seen first, then the rest, each part by observed_at, newest first. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "reply_later", threads: [Thread in a box], next_page }
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read Set Aside. Reads Set Aside: threads the account kept handy for reference. Lists threads in HEY’s order: those not yet seen first, then the rest, each part by observed_at, newest first. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "set_aside", threads: [Thread in a box], next_page }
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read Bubble Up. Reads Bubble Up: threads scheduled to return to the top of the Imbox, with when each one returns. Lists threads in the order they return. Each comes with sender, subject, HEY’s short preview, and the topic_id get_thread reads. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
{ box: "bubble_up", threads: [Thread in a box], next_page }. Each thread also carries bubble_up_at.
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Search mail. Searches the account’s mail by words, sender, recipient or subject, as HEY’s search page does. Returns matching threads with their matching messages. A thread whose sender isn’t screened in, or that is in spam, comes with its senders and dates only, and withheld says what was left out and why. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
exact_phrase | string | no | Only mail containing this exact phrase. |
from | string | no | Only mail from this name or address. |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
query | string | no | Words to search for. |
subject | string | no | Only mail whose subject has these words. |
to | string | no | Only mail to this name or address. |
without | string | no | Leave out mail containing any of these words. |
- Returns
{ threads: [Thread], next_page }. Each thread also carries posting_id where it is in one of the person’s boxes, and its messages are the matching messages, as previews. A thread from a sender who isn’t screened in, or in spam, is withheld. Needs at least one search argument besides page.
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read a thread. Reads one email thread: its subject, participants and messages in order, each with sender, time and a short preview. Use get_message with a message_id for a full message. A thread whose sender isn’t screened in, or that is in spam, comes with its senders and dates only, and withheld says what was left out and why. When HEY couldn’t verify the sender, sender_warning carries HEY’s own warning. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
topic_id | integer | yes | The thread’s topic_id, from a box, search or contact result. |
page | string | no | The next_page value from the previous page of this list. Omit it for the first page. |
- Returns
- Thread, with up to a page of its messages as previews, and
next_page for the rest. Full bodies come from get_message.
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail subjects and previews, Email addresses
Read a message. Reads one email message in full: sender, recipients, subject and the body as text inside an <email-content> block. Content HEY hides from view, such as hidden text and images, is left out. A long body comes a page at a time: when next_offset is present, call again with it as offset for the rest. A message whose sender isn’t screened in, or whose thread is in spam, comes with its sender and date only, and withheld says what was left out and why. Fields a sender wrote are listed in each item’s _untrusted array.
Inputs
| Input | Type | Required | Description |
message_id | integer | yes | The message_id, from get_thread, search_mail or get_screener. |
offset | integer | no | Characters into the body to start from: the next_offset of the previous page. Omit it for the start. |
- Returns
{ message_id, topic_id, subject, from, sender_display_name, to, cc, bcc, created_at, scheduled_delivery_at, app_url, box, screened_in, thread_status, body, body_length, offset, next_offset, hidden_content_omitted, body_unavailable, _untrusted }. from and each recipient are people. body is the message rendered to plain text inside an <email-content> block, a page at a time: call again with next_offset as offset for the rest. Text HEY hides from view is left out and counted in hidden_content_omitted. Attachments are never returned, only mentioned where the body names them. A message from a sender who isn’t screened in, or in spam, keeps only its sender and dates (withheld).
- Class
- Read
- Hints
readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false
- Permission
read
- Data
- Mail bodies, Mail subjects and previews, Email addresses