TypeScript

nextmail.threads

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

Read, search, label, trash, snooze and mute conversations in the mailbox, read the inbox one tab at a time, and choose the tab the mail of a sender always goes to.

`nextmail.threads.list()`

List one page of threads in a folder

threads:readPages through results

Signature

list(options?: ThreadListOptions): Promise<Page<ThreadSummaryResource>>

Returns one page of threads from the mailbox index, ordered by each thread's latest message with the newest first unless sort says otherwise. A row is only object and id, so call get for the messages, labels and unread state.

sort, dateFrom, dateTo and fromContacts are the thread list's own controls: the four orders, a date range read against the newest message on each thread, and a filter to mail from saved contacts. Every order pages to the end, and a cursor carries on in the order it was handed out in, so send the same filters with it.

folder defaults to inbox and is matched against label ids after being upper cased, so sent, archive, spam, trash, draft, snoozed, starred and unread all work, bin is read as trash, and a user label id works as a folder too. A name that matches nothing returns an empty page rather than an error. labelIds narrows the folder further: a thread must carry the folder label and every id you pass. category keeps one inbox tab, primary, promotions, updates, social or forums, where primary is every thread in no other tab.

query takes the mailbox search syntax. Plain words must all appear, and each matches loosely: case, accents and separators are ignored and part of a longer word counts, so min finds "Benjamin". A quoted phrase is matched as written apart from case and accents, so "ben jamin" does not find "Ben-Jamin" while "quarterly invoice" finds "Quarterly invoice". When nothing matches exactly, close spellings are returned instead, so benjimin finds "Benjamin": a plain word, or the value of from:, to:, cc:, subject:, body:, filename: or label:, may differ from the start of a word by one typo when it has four to seven letters and by two when it has eight or more, while a quoted phrase, a word containing a digit, a shorter word and an excluded word still match exactly, and the pages that follow keep matching the same way. Filler words such as the, about or emails are dropped from a list of plain words when something else is left to search for, so emails from john searches for john alone. Operators such as from:, to:, subject:, label:, is:unread, has:pdf, after:2026/01/31 and newer_than:7d narrow it, and OR, parentheses and a leading - combine them. is:muted finds muted threads, is:waiting the threads with a reminder nobody has answered yet, and category:promotions one inbox tab in any folder. Recipients are stored as one list without roles and never hold a Bcc, so cc: reads the same field as to: and bcc: matches nothing of its own. from:me is mail you sent, and to:me is mail carrying one of your own addresses, aliases included, among its recipients or as the address it was delivered to.

With semantic: true the plain words of query match by meaning rather than spelling. Describe the mail in a few words, flight to Berlin or invoices I still owe, in any language, and the threads closest in meaning come back best match first, together with every thread the words match as text, which ranks above one that only means the same. A thread is kept only when it is clearly closer to the words than the rest of the mailbox, so a description nothing fits returns only the text matches. Operators and filters narrow it as usual, sort does not apply, and a query with no plain words is a text search whatever semantic says. Meaning is read from the whole conversation, newest messages first, so an earlier message counts too, and a workspace that turned search by meaning off in its settings gets a text search instead.

Words and the from:, to:, cc:, subject: and body: operators read only the newest message on each thread: its sender, its recipients, its subject and the first 4,000 characters of its body with markup stripped. filename: and has: read every attachment on the whole conversation, and label:, in: and is: read the whole conversation. A plain word also matches the name of any attachment on the conversation, whichever message carried it. A sealed message has no body text to match. The search stays inside folder unless the query names a folder itself, with in: or a folder is: such as is:sent, and in:anywhere searches every folder, on its own as well as beside other terms. A drafts listing is the exception and stays in drafts whatever the query names.

Dates read the newest activity on the thread, in UTC. after: includes the day it names and before: excludes it, and a date can be written YYYY/MM/DD, YYYY-MM-DD, YYYYMMDD, as a bare year, or as epoch seconds or milliseconds. A short date reads day first (16/09/2026), unless the second number cannot be a month (09/16/2026), and a number above 12 settles it either way. The API pages with an opaque pageToken, which the SDK hands back as nextCursor and accepts as options.cursor.

Parameters

options.folderstring: Label the threads must carry, case insensitive. Defaults to inbox, and bin is read as trash.
options.querystring: Mailbox search. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as from:ada, has:pdf and in:anywhere narrow it.
options.labelIdsstring | Array<string>: Label ids a thread must all carry on top of folder, matched exactly. An array is sent comma separated.
options.sortThreadSort: newest (the default), oldest, sender or subject, the four orders of the thread list in the app. sender and subject are alphabetical, newest first within one sender or subject.
options.dateFromDate | string: Keeps threads whose newest message arrived at or after this instant. A Date or an ISO 8601 string with a time and an offset.
options.dateToDate | string: Keeps threads whose newest message arrived at or before this instant. Both ends are included, and dateFrom after dateTo is a 422.
options.fromContactsboolean: When true, keeps only threads whose newest message came from a saved contact. A key limited to some addresses reads the contacts its owner saved.
options.semanticboolean: When true, the plain words of query match by meaning instead of spelling, in any language, and the closest threads come first along with every thread the words match as text. Operators and the other filters still apply and sort does not. Ignored when the workspace has search by meaning turned off.
options.categoryInboxCategory: Keeps only the threads sorted into this inbox tab: primary, promotions, updates, social or forums. primary is every thread in no other tab. In query, category:promotions filters the same way in any folder.
options.addressstring: Keeps only the threads delivered to this address, the address filter of the thread list. One the key does not reach returns nothing rather than failing.
options.limitnumber: Threads per page, a whole number from 1 to 100. Defaults to 25.
options.cursorstring: The nextCursor of the previous page, passed back unchanged.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Page<ThreadSummaryResource> with items, hasMore and nextCursor. Each item is { object: 'thread', id }.

Example

const page = await nextmail.threads.list({ folder: 'inbox', query: 'from:ada has:pdf', limit: 50 }) const lastWeek = await nextmail.threads.list({ sort: 'oldest', dateFrom: new Date(Date.now() - 7 * 864e5), fromContacts: true })console.log(lastWeek.items.length) const trip = await nextmail.threads.list({ folder: 'archive', query: 'flight to Berlin', semantic: true })console.log(trip.items[0]?.id) const offers = await nextmail.threads.list({ category: 'promotions' })console.log(offers.items.length) console.log(page.items.map((thread) => thread.id)) if (page.nextCursor) {    const next = await nextmail.threads.list({ folder: 'inbox', query: 'from:ada has:pdf', limit: 50, cursor: page.nextCursor })    console.log(next.items.length)}

Notes

The server offers a cursor whenever a page comes back full, so hasMore can be true on what turns out to be the last page, and the next call then returns no items.
Threads that arrived in the same instant are ordered by id, so a page boundary between two of them never skips or repeats one.
A thread that receives mail while you page moves ahead of the cursor and is not returned by later pages.
A value query cannot use is ignored rather than narrowing, so a typo in a value widens the result instead of emptying it. That covers larger:, smaller:, size:, messagesize:, list:, rfc822msgid:, received: and sent:, a category: naming no inbox tab, a has: word naming no kind of attachment, an importance: other than high or low, an unreadable date and a duration whose unit is not h, d, w, m or y. An operator name it does not know, project: for instance, is searched as plain text.
A narrowed key only sees threads delivered to the addresses it covers, every address on a whole domain it holds included. A thread still has to carry the folder and every one of labelIds, the same as for any other key.

Also available in

API: GET /threads
Python: threads.list()
Ruby: threads.list
PHP: threads->list
Go: Threads.List
Java: threads().list
C#: Threads.ListAsync
CLI: openemail threads list

`nextmail.threads.listAll()`

Collect every thread in a folder into one array

threads:readPages through results

Signature

listAll(options?: ThreadListOptions): Promise<Array<ThreadSummaryResource>>

Walks every page with the same filters as list and resolves once the last page is in, so the whole result sits in memory at once. That suits a label view or a small folder. For a large inbox, iterate lets you stop as soon as you have what you need.

Each request asks for options.limit threads, 25 when you leave it out, so raising it to 100 needs a quarter of the round trips. Passing options.cursor starts the walk from that page instead of the first. The walk ends when hasMore is false, when the server stops offering a cursor, or when it repeats one.

A failure on any page rejects the promise and discards everything collected so far.

Parameters

options.folderstring: Label the threads must carry, case insensitive. Defaults to inbox.
options.querystring: Mailbox search, as in list. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as from:ada, has:pdf and in:anywhere narrow it.
options.labelIdsstring | Array<string>: Label ids a thread must all carry on top of folder, matched exactly.
options.sortThreadSort: newest (the default), oldest, sender or subject, the four orders of the thread list in the app. sender and subject are alphabetical, newest first within one sender or subject.
options.dateFromDate | string: Keeps threads whose newest message arrived at or after this instant. A Date or an ISO 8601 string with a time and an offset.
options.dateToDate | string: Keeps threads whose newest message arrived at or before this instant. Both ends are included, and dateFrom after dateTo is a 422.
options.fromContactsboolean: When true, keeps only threads whose newest message came from a saved contact. A key limited to some addresses reads the contacts its owner saved.
options.semanticboolean: When true, the plain words of query match by meaning instead of spelling, in any language, and the closest threads come first along with every thread the words match as text. Operators and the other filters still apply and sort does not. Ignored when the workspace has search by meaning turned off.
options.categoryInboxCategory: Keeps only the threads sorted into this inbox tab: primary, promotions, updates, social or forums. primary is every thread in no other tab.
options.addressstring: Keeps only the threads delivered to this address, the address filter of the thread list. One the key does not reach returns nothing rather than failing.
options.limitnumber: Page size for each request, a whole number from 1 to 100. Defaults to 25.
options.cursorstring: A nextCursor to start the walk from instead of the first page.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Returns

Array<ThreadSummaryResource>, every matching thread as { object: 'thread', id }, newest first.

Example

const snoozed = await nextmail.threads.listAll({ folder: 'snoozed', limit: 100 }) console.log(`${snoozed.length} threads are waiting to wake`)

Notes

Each page is its own request with its own retries, so a network blip on page five does not restart the walk from page one.
Rows are ids only. Reading the threads afterwards is one get per id.

Also available in

API: GET /threads
Python: threads.list_all()
Ruby: threads.list_all
PHP: threads->listAll
Go: Threads.ListAll
Java: threads().listAll
C#: Threads.ListAllAsync

`nextmail.threads.iterate()`

Stream threads one at a time across pages

threads:readPages through results

Signature

iterate(options?: ThreadListOptions): AsyncGenerator<ThreadSummaryResource, void, undefined>

Returns an async generator that yields threads one by one and requests the next page only when the current one is used up. Nothing is fetched until the loop starts, and breaking out of it stops further requests, so this is the way to scan a large folder for the first match.

Filters behave as in list, and each request asks for options.limit threads, 25 by default. The cursor marks a position in time rather than a row count, so trashing, archiving or relabelling threads inside the loop does not make the walk skip the ones after them. A thread that receives new mail during the walk moves ahead of the cursor and is not yielded again. With semantic: true the cursor counts places in the ranked list instead, so moving a thread out of the folder during the walk can shift the ones after it.

Parameters

options.folderstring: Label the threads must carry, case insensitive. Defaults to inbox.
options.querystring: Mailbox search, as in list. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as from:ada, has:pdf and in:anywhere narrow it.
options.labelIdsstring | Array<string>: Label ids a thread must all carry on top of folder, matched exactly.
options.sortThreadSort: newest (the default), oldest, sender or subject, the four orders of the thread list in the app. sender and subject are alphabetical, newest first within one sender or subject.
options.dateFromDate | string: Keeps threads whose newest message arrived at or after this instant. A Date or an ISO 8601 string with a time and an offset.
options.dateToDate | string: Keeps threads whose newest message arrived at or before this instant. Both ends are included, and dateFrom after dateTo is a 422.
options.fromContactsboolean: When true, keeps only threads whose newest message came from a saved contact. A key limited to some addresses reads the contacts its owner saved.
options.semanticboolean: When true, the plain words of query match by meaning instead of spelling, in any language, and the closest threads come first along with every thread the words match as text. Operators and the other filters still apply and sort does not. Ignored when the workspace has search by meaning turned off.
options.categoryInboxCategory: Keeps only the threads sorted into this inbox tab: primary, promotions, updates, social or forums. primary is every thread in no other tab.
options.addressstring: Keeps only the threads delivered to this address, the address filter of the thread list. One the key does not reach returns nothing rather than failing.
options.limitnumber: Page size for each request, a whole number from 1 to 100. Defaults to 25.
options.cursorstring: A nextCursor to start from instead of the first page.
options.signalAbortSignal: Cancels the request in flight and ends the iteration with that error.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Returns

AsyncGenerator<ThreadSummaryResource, void, undefined> yielding { object: 'thread', id } per step.

Example

for await (const summary of nextmail.threads.iterate({ folder: 'inbox', query: 'receipt newer_than:30d', limit: 100 })) {    const thread = await nextmail.threads.get(summary.id)     if (thread.hasUnread) {        await nextmail.threads.update(summary.id, { read: true })    }}

Notes

The generator is lazy, so an abandoned loop costs only the pages it consumed.
An aborted options.signal throws NextmailNetworkError out of the loop rather than ending it quietly.

Also available in

API: GET /threads
Python: threads.iterate()
Ruby: threads.iterate
PHP: threads->iterate
Go: Threads.Iterate
Java: threads().iterate
C#: Threads.IterateAsync

`nextmail.threads.get()`

Read a thread with every message on it

threads:read

Signature

get(id: string, options?: RequestScope): Promise<ThreadResource>

Returns the whole conversation, oldest message first, with the labels the thread sits in and its unread state. Unsent draft replies are included in messages with isDraft: true, which is why messageCount, the length of messages, can be higher than totalReplies, which counts only real messages.

Messages are passed through as the mailbox stored them, so MessageResource is an open record rather than a fixed field list. The one field the API commits to is encryption. When encryption.format is pgp-mime, pgp-inline or smime-encrypted, the message is sealed and its body is empty or holds armour. pgp-signed and smime-signed are ordinary readable mail. A message with no encryption at all was stored before detection existed, so its absence says nothing about whether it was plaintext.

Each message's tags and unread are overwritten on read with the thread's current labels and unread flag, so they describe the thread and not that one message.

Parameters

idstringRequired: Thread id, as returned by list or carried on a message.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadResource with id echoed from the request, messages, labels as { id, name, color }, messageCount, hasUnread, totalReplies and deliveredTo, the workspace address the thread belongs to (null when none was recorded).

Example

const thread = await nextmail.threads.get('CAHk7pQ2x9LmZ4-mail.example.com')const sealedFormats = ['pgp-mime', 'pgp-inline', 'smime-encrypted'] for (const message of thread.messages) {    const sealed = sealedFormats.includes(String(message.encryption?.format))    console.log(message.id, message.subject, sealed ? 'sealed' : 'readable')} console.log(thread.labels.map((label) => label.id))

Notes

A thread delivered to no address the key covers is a 404, exactly like one that does not exist.
hasUnread mirrors the UNREAD label, and update with read is how you change it.
Draft ids from drafts.list open here too, because a draft is stored as a thread labelled DRAFT.

Also available in

API: GET /threads/{id}
Python: threads.get()
Ruby: threads.get
PHP: threads->get
Go: Threads.Get
Java: threads().get
C#: Threads.GetAsync
CLI: openemail threads get

`nextmail.threads.update()`

Mark a thread read or unread and change its labels

threads:write

Signature

update(id: string, patch: ThreadPatch, options?: RequestScope): Promise<UpdatedThreadResource>

Adds and removes labels on a thread in one call. read is shorthand for the UNREAD label: true removes it and false adds it. At least one of read, a non empty addLabelIds or a non empty removeLabelIds is required, each list takes at most 50 ids, and any other key is a 422 because the body is strict.

Folders are labels too, so archiving is addLabelIds: ['ARCHIVE'] with removeLabelIds: ['INBOX'], the same pair the app uses. TRASH, SNOOZED and DRAFT are refused in either list with 422 label_not_directly_settable, because each needs a step this route cannot take. Use trash and snooze for those.

User label ids come from labels.list, and the system ids such as ARCHIVE, STARRED and UNREAD are taken in any case. An id in addLabelIds that names no label is refused with 422 label_not_found and nothing on the thread changes, so create the label with labels.create first. An unknown id in removeLabelIds is not an error, since the thread cannot carry it. Removals are applied before additions, so an id in both lists ends up on the thread.

Parameters

idstringRequired: Thread id.
patch.readboolean: true removes UNREAD, false adds it.
patch.addLabelIdsArray<string>: Label ids to put on the thread, at most 50, each naming a label, never TRASH, SNOOZED or DRAFT.
patch.removeLabelIdsArray<string>: Label ids to take off the thread, at most 50, never TRASH, SNOOZED or DRAFT.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

UpdatedThreadResource with id, addedLabelIds and removedLabelIds. Both lists echo the request, with system ids upper cased, plus the UNREAD change that read implies, not what actually changed.

Example

const updated = await nextmail.threads.update('CAHk7pQ2x9LmZ4-mail.example.com', {    read: true,    addLabelIds: ['ARCHIVE', 'USER_RECEIPTS'],    removeLabelIds: ['INBOX']}) console.log(updated.addedLabelIds, updated.removedLabelIds)

Notes

The SDK retries this call after a network failure or a retryable status, which is safe because adding a label already present or removing one already gone changes nothing.
The thread is looked up before the body is validated, so a wrong id is a 404 even when the patch is also invalid.
User label ids look like USER_RECEIPTS. Take them from labels.list rather than building them.

Also available in

API: PATCH /threads/{id}
Python: threads.update()
Ruby: threads.update
PHP: threads->update
Go: Threads.Update
Java: threads().update
C#: Threads.UpdateAsync
CLI: openemail threads update

`nextmail.threads.trash()`

Move a thread to the Bin

threads:write

Signature

trash(id: string, options?: RequestScope): Promise<TrashedThreadResource>

Adds TRASH and removes INBOX, SPAM, SNOOZED and ARCHIVE in one step, which is what the app's delete does. Doing half of that through update would leave the thread listed in both the Bin and its old folder, which is why update refuses TRASH.

Nothing is deleted. The thread stays readable with get and lists under folder: 'trash'. Calling this on a thread that is already in the Bin changes nothing and returns the same body, which is why the SDK retries it.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

TrashedThreadResource, { object: 'thread', id, trashed: true }.

Example

const result = await nextmail.threads.trash('CAHk7pQ2x9LmZ4-mail.example.com') console.log(result.id, result.trashed)

Notes

restore takes a thread back out of the Bin. update refuses TRASH in removeLabelIds as well as in addLabelIds.
Trashing a snoozed thread also cancels its scheduled wake, so it does not reappear in the inbox later.
A thread delivered to no address the key covers is a 404.

Also available in

API: POST /threads/{id}/trash
Python: threads.trash()
Ruby: threads.trash
PHP: threads->trash
Go: Threads.Trash
Java: threads().trash
C#: Threads.TrashAsync
CLI: openemail threads trash

`nextmail.threads.snooze()`

Hide a thread until a set time

threads:write

Signature

snooze(id: string, wakeAt: Date | string, options?: RequestScope): Promise<SnoozedThreadResource>

Adds SNOOZED, removes INBOX and stores a wake time, all in one call. Both halves matter: the label hides the thread and the stored wake time is what brings it back. A thread labelled SNOOZED any other way would never return, which is why update refuses that label.

wakeAt takes a Date or an ISO 8601 string. The SDK converts a Date with toISOString(), and the server answers 422 invalid_parameter on wakeAt when the value does not parse or is not in the future. Snoozing a thread that is already snoozed replaces its wake time.

Threads are woken by an hourly sweep, so one comes back at the first sweep after wakeAt, up to about an hour late. Opening the Snoozed folder in the app wakes overdue threads straight away. A thread always wakes into the inbox.

Parameters

idstringRequired: Thread id.
wakeAtDate | stringRequired: When the thread should return, a future instant.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

SnoozedThreadResource with id and snoozedUntil, the wake time normalised to a UTC ISO string.

Example

const wakeAt = new Date()wakeAt.setUTCDate(wakeAt.getUTCDate() + 1)wakeAt.setUTCHours(9, 0, 0, 0) const snoozed = await nextmail.threads.snooze('CAHk7pQ2x9LmZ4-mail.example.com', wakeAt) console.log(snoozed.snoozedUntil)

Notes

Only INBOX is removed, so a thread snoozed from another folder keeps that folder's label while it sleeps and wakes carrying both.
A string with no zone offset is read in the server's local zone, so send Z or an explicit offset.
The SDK retries this call, which is safe because a repeat stores the same wake time.

Also available in

API: POST /threads/{id}/snooze
Python: threads.snooze()
Ruby: threads.snooze
PHP: threads->snooze
Go: Threads.Snooze
Java: threads().snooze
C#: Threads.SnoozeAsync
CLI: openemail threads snooze

`nextmail.threads.unsnooze()`

Bring a snoozed thread back now

threads:write

Signature

unsnooze(id: string, options?: RequestScope): Promise<SnoozedThreadResource>

Adds INBOX, removes SNOOZED and deletes the stored wake time, so the thread returns immediately and the hourly sweep leaves it alone afterwards.

A thread that is not snoozed is left where it is, so an archived thread stays archived, and the response still reports snoozedUntil: null.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

SnoozedThreadResource with id and snoozedUntil set to null.

Example

const thread = await nextmail.threads.get('CAHk7pQ2x9LmZ4-mail.example.com') if (thread.labels.some((label) => label.id === 'SNOOZED')) {    const result = await nextmail.threads.unsnooze(thread.id)    console.log(result.snoozedUntil)}

Notes

Removing SNOOZED through update is refused with 422 label_not_directly_settable, because it would leave the wake time scheduled.
Safe to retry, and the SDK does: a second call applies the same labels and deletes a wake time that is already gone.

Also available in

API: POST /threads/{id}/unsnooze
Python: threads.unsnooze()
Ruby: threads.unsnooze
PHP: threads->unsnooze
Go: Threads.Unsnooze
Java: threads().unsnooze
C#: Threads.UnsnoozeAsync
CLI: openemail threads unsnooze

`nextmail.threads.mute()`

Mute a thread

threads:write

Signature

mute(id: string, options?: RequestScope): Promise<MutedThreadResource>

Mutes a conversation, as Mute does in the app. A thread in the inbox moves to the archive, and from then on new mail in it goes straight to the archive, unread, with no push, sound or desktop notice. A webhook for that mail carries muted: true.

Thread state belongs to the whole workspace, so the thread is muted for everyone on it, and mail addressed only to you does not bring it back. Calling it again changes nothing, which is why the SDK retries it. update with MUTE in addLabelIds does the same.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

MutedThreadResource, { object: 'thread', id, muted: true }.

Example

const muted = await nextmail.threads.mute('CAHk7pQ2x9LmZ4-mail.example.com') console.log(muted.id, muted.muted)

Notes

Only a thread in the inbox moves. One in Sent, the archive or Snoozed stays where it is.
A muted thread carries the built-in MUTE label, which get shows among its labels and is:muted finds in query.
unmute takes the mute off. A thread delivered to no address the key covers is a 404.

Also available in

API: POST /threads/{id}/mute
Python: threads.mute()
Ruby: threads.mute
PHP: threads->mute
Go: Threads.Mute
Java: threads().mute
C#: Threads.MuteAsync
CLI: openemail threads mute

`nextmail.threads.unmute()`

Take the mute off a thread

threads:write

Signature

unmute(id: string, options?: RequestScope): Promise<MutedThreadResource>

Takes the mute off, so the next message in the thread arrives in the inbox and alerts people again.

The thread stays where it is. Move it back with update and INBOX in addLabelIds if you want it in the inbox now. A thread that is not muted is left as it is, which is why the SDK retries this call.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

MutedThreadResource, { object: 'thread', id, muted: false }.

Example

const thread = await nextmail.threads.get('CAHk7pQ2x9LmZ4-mail.example.com') if (thread.labels.some((label) => label.id === 'MUTE')) {    const result = await nextmail.threads.unmute(thread.id)    console.log(result.muted)}

Notes

Unmuting is for the whole workspace, as muting is: the thread alerts everyone on it again.
A thread delivered to no address the key covers is a 404.

Also available in

API: POST /threads/{id}/unmute
Python: threads.unmute()
Ruby: threads.unmute
PHP: threads->unmute
Go: Threads.Unmute
Java: threads().unmute
C#: Threads.UnmuteAsync
CLI: openemail threads unmute

`nextmail.threads.listMessages()`

List the messages of a thread in a fixed shape

threads:read

Signature

listMessages(id: string, options?: RequestScope): Promise<Array<MailboxMessageResource>>

Returns every message on the thread, oldest first, as MailboxMessageResource: from, to, cc, bcc and replyTo as { name, email }, date as an ISO 8601 instant, messageId, inReplyTo and references, the body as text and html, the attachments without their bytes, the headers Nextmail keeps and encryption. Unsent draft replies are in the list with draft: true.

These fields are a contract: they are added to, never renamed or taken away, whatever the mailbox stores underneath. threads.get still returns each message the way the mailbox stored it, so use this when your code reads messages field by field.

text is the plain text body, or the text drawn from the HTML when the message came as HTML only. html is null for a plain text message. headers holds From, To, Cc, Reply-To, Subject, Date, Message-ID, In-Reply-To, References, List-Unsubscribe and List-Unsubscribe-Post when the message had them, and nothing else, because the rest of what it arrived with is not kept.

Parameters

idstringRequired: Thread id, as returned by list.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<MailboxMessageResource>, oldest first.

Example

const messages = await nextmail.threads.listMessages('thr_2b8e4c1a9d7f4e3b8a6c5d0e') for (const message of messages) {    console.log(message.date, message.from.email, message.subject)    console.log(message.text?.slice(0, 200))}

Notes

A thread delivered to no address the key covers is a 404, exactly like one that does not exist.
Read an attachment's bytes with listAttachments(id, message.id).

Also available in

API: GET /threads/{id}/messages
Python: threads.list_messages()
Ruby: threads.list_messages
PHP: threads->listMessages
Go: Threads.ListMessages
Java: threads().listMessages
C#: Threads.ListMessagesAsync
CLI: openemail threads list-messages

`nextmail.threads.getMessage()`

Read one message of a thread in a fixed shape

threads:read

Signature

getMessage(id: string, messageId: string, options?: RequestScope): Promise<MailboxMessageResource>

Returns one message as MailboxMessageResource, the shape listMessages lists. The thread is checked first and then the message, so a messageId that is not on that thread is a 404 even when it exists elsewhere in the mailbox.

The emailId of an email.received webhook is the messageId to pass here, beside its threadId.

Parameters

idstringRequired: Thread id the message belongs to.
messageIdstringRequired: The message, as id on a message listMessages returns.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

MailboxMessageResource.

Example

const message = await nextmail.threads.getMessage('thr_2b8e4c1a9d7f4e3b8a6c5d0e', 'msg_7c2e9a41b3d84f6e9a0c1d2e') console.log(message.from, message.date)console.log(message.attachments.map((file) => file.filename))

Notes

Both ids must match: a real message id paired with the wrong thread id is a 404 resource_not_found.
A thread delivered to no address the key covers is a 404 before the message is looked at.

Also available in

API: GET /threads/{id}/messages/{messageId}
Python: threads.get_message()
Ruby: threads.get_message
PHP: threads->getMessage
Go: Threads.GetMessage
Java: threads().getMessage
C#: Threads.GetMessageAsync
CLI: openemail threads get-message

`nextmail.threads.listAttachments()`

List a message's attachments with their content

threads:read

Signature

listAttachments(id: string, messageId: string, options?: RequestScope): Promise<Array<AttachmentResource>>

Returns the attachments of one message with each file's bytes inlined as base64 in content. The thread is checked first and then the message, so a messageId that is not on that thread is a 404 even when it exists elsewhere in the mailbox. Take message ids from the messages of threads.get.

This is the display list. The ciphertext of an encrypted envelope is in it and downloads like any other file, named encrypted-message.asc when it arrived without a name. The PGP/MIME version part and any detached signature are held out on purpose. Every part keeps its id in the message's encryption.parts, and for those two the id is a correlation key only: no route returns their bytes.

Every file comes back whole in a single response, with no size cap and no range reads, so a message carrying large files makes a large response.

Parameters

idstringRequired: Thread id the message belongs to.
messageIdstringRequired: Message id from that thread's messages.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<AttachmentResource>, each with attachmentId, filename, contentType, size and base64 content.

Example

const thread = await nextmail.threads.get('CAHk7pQ2x9LmZ4-mail.example.com')const latest = thread.messages[thread.messages.length - 1]const files = await nextmail.threads.listAttachments(thread.id, String(latest.id)) for (const file of files) {    const bytes = Buffer.from(file.content ?? '', 'base64')    console.log(file.filename, file.contentType, bytes.byteLength)}

Notes

When the stored bytes for a file cannot be found, content is an empty string rather than null, so check its length before decoding.
Both ids must match: a real message id paired with the wrong thread id is a 404 resource_not_found.
A thread delivered to no address the key covers is a 404 before the message is looked at.

Also available in

API: GET /threads/{id}/messages/{messageId}/attachments
Python: threads.list_attachments()
Ruby: threads.list_attachments
PHP: threads->listAttachments
Go: Threads.ListAttachments
Java: threads().listAttachments
C#: Threads.ListAttachmentsAsync
CLI: openemail threads list-attachments

`nextmail.threads.listNotes()`

List the notes on a thread

threads:read

Signature

listNotes(id: string, options?: RequestScope): Promise<Array<ThreadNoteResource>>

Resolves every note on one thread, the Notes panel of the reading pane: pinned notes first, then the rest in the order they were arranged.

Notes are private to a person. A key reads and writes the notes of the workspace owner, and an app those of the person who connected it. A key limited to particular addresses reaches only the notes on threads that arrived at them.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<ThreadNoteResource>, each with id, threadId, content, color, pinned, order, createdAt and updatedAt.

Example

const notes = await nextmail.threads.listNotes('CAHk7pQ2x9LmZ4-mail.example.com') for (const note of notes) console.log(note.pinned ? 'pinned' : '', note.content)

Notes

A thread delivered to no address the key covers is a 404.

Also available in

API: GET /threads/{id}/notes
Python: threads.list_notes()
Ruby: threads.list_notes
PHP: threads->listNotes
Go: Threads.ListNotes
Java: threads().listNotes
C#: Threads.ListNotesAsync
CLI: openemail threads list-notes

`nextmail.threads.createNote()`

Add a note to a thread

threads:write

Signature

createNote(id: string, body: ThreadNoteCreate, options?: RequestScope): Promise<ThreadNoteResource>

Pins a private note to a thread, as the Notes panel does. A new note goes after the others, and pinned keeps it at the top.

Parameters

idstringRequired: Thread id.
body.contentstringRequired: The text of the note, up to 20,000 characters. Leading and trailing spaces are trimmed.
body.colorThreadNoteColor: One of the eight the app offers: default, red, orange, yellow, green, blue, purple or pink. Defaults to default.
body.pinnedboolean: Keeps the note above the others. Defaults to false.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadNoteResource for the new note.

Example

const note = await nextmail.threads.createNote('CAHk7pQ2x9LmZ4-mail.example.com', {    content: 'Waiting on the signed contract before replying.',    color: 'yellow',    pinned: true}) console.log(note.id)

Notes

The SDK does not retry it, because a second call would add a second note.

Also available in

API: POST /threads/{id}/notes
Python: threads.create_note()
Ruby: threads.create_note
PHP: threads->createNote
Go: Threads.CreateNote
Java: threads().createNote
C#: Threads.CreateNoteAsync
CLI: openemail threads create-note

`nextmail.threads.updateNote()`

Change a note

threads:write

Signature

updateNote(id: string, noteId: string, patch: ThreadNoteUpdate, options?: RequestScope): Promise<ThreadNoteResource>

Changes the text of a note, its colour or whether it is pinned. Give at least one of the three. A note id that is not on this thread is a 404, even when the note exists on another thread.

Parameters

idstringRequired: Thread id.
noteIdstringRequired: The note's id, from listNotes.
patch.contentstring: The new text, up to 20,000 characters.
patch.colorThreadNoteColor: The new colour.
patch.pinnedboolean: Pins or unpins it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadNoteResource as it is now.

Example

const note = await nextmail.threads.updateNote('CAHk7pQ2x9LmZ4-mail.example.com', 'b3d1f0c2-7a4e-4f7b-9c1d-2e8f6a5b4c3d', { pinned: false }) console.log(note.pinned)

Notes

Safe to repeat: setting the same values twice leaves the note as it was.

Also available in

API: PATCH /threads/{id}/notes/{noteId}
Python: threads.update_note()
Ruby: threads.update_note
PHP: threads->updateNote
Go: Threads.UpdateNote
Java: threads().updateNote
C#: Threads.UpdateNoteAsync
CLI: openemail threads update-note

`nextmail.threads.deleteNote()`

Delete a note

threads:write

Signature

deleteNote(id: string, noteId: string, options?: RequestScope): Promise<DeletedThreadNoteResource>

Deletes a note for good. There is no bin for notes.

Parameters

idstringRequired: Thread id.
noteIdstringRequired: The note's id, from listNotes.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

DeletedThreadNoteResource, { object: 'note', id, threadId, deleted: true }.

Example

await nextmail.threads.deleteNote('CAHk7pQ2x9LmZ4-mail.example.com', 'b3d1f0c2-7a4e-4f7b-9c1d-2e8f6a5b4c3d')

Notes

The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.

Also available in

API: DELETE /threads/{id}/notes/{noteId}
Python: threads.delete_note()
Ruby: threads.delete_note
PHP: threads->deleteNote
Go: Threads.DeleteNote
Java: threads().deleteNote
C#: Threads.DeleteNoteAsync
CLI: openemail threads delete-note

`nextmail.threads.reorderNotes()`

Arrange the notes on a thread

threads:write

Signature

reorderNotes(id: string, ids: Array<string>, options?: RequestScope): Promise<Array<ThreadNoteResource>>

Sets the order of every note on a thread at once, first to last, as dragging them in the Notes panel does. Pinned notes still come first.

ids has to name every note on the thread exactly once. Anything else is a 422 invalid_parameter on ids, and nothing moves.

Parameters

idstringRequired: Thread id.
idsArray<string>Required: Every note id on the thread, in the order you want them.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<ThreadNoteResource> in the new order.

Example

const notes = await nextmail.threads.listNotes('CAHk7pQ2x9LmZ4-mail.example.com')const reversed = notes.map((note) => note.id).reverse() await nextmail.threads.reorderNotes('CAHk7pQ2x9LmZ4-mail.example.com', reversed)

Notes

Safe to repeat: the same order twice leaves the notes as they were.

Also available in

API: POST /threads/{id}/notes/reorder
Python: threads.reorder_notes()
Ruby: threads.reorder_notes
PHP: threads->reorderNotes
Go: Threads.ReorderNotes
Java: threads().reorderNotes
C#: Threads.ReorderNotesAsync
CLI: openemail threads reorder-notes

`nextmail.threads.counts()`

Count the mail in each folder

threads:read

Signature

counts(options?: ThreadCountsOptions): Promise<MailboxCountsResource>

Resolves what the sidebar of the app shows: how many conversations each folder holds and how many of them are unread, how many drafts are waiting, how many conversations each of your labels has in each folder, how many inbox conversations sit in each inbox tab, and how many inbox conversations arrived at each address of the workspace.

folders has one row per folder, named by its label id in lower case: inbox, sent, spam, archive, trash and snoozed, then draft, whose count is the drafts waiting to be sent and whose unread is always 0, then unread, whose count is the unread conversations in the inbox. labels has one row for each of your labels and each folder it has conversations in, { id, folder, count, unread }, so a label with nothing in a folder has no row for it. categories has one row for each inbox tab, { category, count, unread }, counting inbox conversations only: primary, promotions, updates, social and forums, where primary is everything not sorted into another tab. unlabelled counts the inbox conversations that carry none of your labels, with count, unread and the same count for each tab under categories, which is what the inbox of the app lists unless Labelled mail is ticked in its Filters menu. addresses counts the inbox per address the mail was delivered to, with null for mail that recorded none. team counts the team views of a shared inbox for the person the key or app acts for: assigned the open conversations assigned to them, unassigned the open conversations nobody has, each with count and unread, and mentions the conversations outside Spam and the bin where a team comment mentions them, with count, unread and unseen, the conversations with a mention newer than the last time they opened its comments in the app. A conversation is open while it is in the inbox.

A key limited to particular addresses counts only the mail that arrived at them and the drafts written from them. address narrows every count to one address, and one the key does not reach counts nothing rather than failing.

Parameters

options.addressstring: Count only the mail delivered to this address.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

MailboxCountsResource, { object: 'mailbox_counts', folders, addresses, labels, categories, unlabelled, team }, each folder { label, count, unread }, each address { address, count }, each label { id, folder, count, unread } and each category { category, count, unread }. unlabelled is { count, unread, categories } for the inbox conversations with no label. team is { assigned, unassigned, mentions }, each { count, unread }, and mentions also has unseen.

Example

const counts = await nextmail.threads.counts() const inbox = counts.folders.find((folder) => folder.label === 'inbox') console.log(`${inbox?.unread ?? 0} unread of ${inbox?.count ?? 0}`) for (const row of counts.addresses) console.log(row.address ?? '(none)', row.count) for (const row of counts.labels.filter((label) => label.folder === 'inbox')) console.log(row.id, row.unread) for (const tab of counts.categories) console.log(tab.category, tab.count, tab.unread) console.log(`${counts.team.unassigned.count} open and nobody has them`)

Notes

Read only, so the SDK retries it after a network failure like any other read.

Also available in

API: GET /threads/counts
Python: threads.counts()
Ruby: threads.counts
PHP: threads->counts
Go: Threads.Counts
Java: threads().counts
C#: Threads.CountsAsync
CLI: openemail threads counts

`nextmail.threads.summary()`

Read the summary of a thread

threads:read

Signature

summary(id: string, options?: RequestScope): Promise<ThreadAiSummaryResource>

Resolves the short AI summary the reading pane shows above a thread. A summary is written the first time it is asked for and then kept, and the first request after a newer message arrives writes it again, so reading one is cheap.

state is ready with the text in summary, pending while the first one is being written, failed when the last try did not work, or none when there is nothing to summarise, such as a thread holding a message that arrived encrypted, whose body Nextmail never reads. While a newer summary is being written, the one before it comes back as ready. A pending answer starts the writing, so ask again a few seconds later, and after a failed one asking again tries once more.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadAiSummaryResource, { object: 'thread_summary', threadId, state, summary }, with summary null unless state is ready.

Example

let result = await nextmail.threads.summary('CAHk7pQ2x9LmZ4-mail.example.com') if (result.state === 'pending') {    await new Promise((resolve) => setTimeout(resolve, 5000))    result = await nextmail.threads.summary('CAHk7pQ2x9LmZ4-mail.example.com')} console.log(result.summary ?? result.state)

Notes

Summaries spend no AI actions, whether one is written or only read.
A thread delivered to no address the key covers is a 404.

Also available in

API: GET /threads/{id}/summary
Python: threads.summary()
Ruby: threads.summary
PHP: threads->summary
Go: Threads.Summary
Java: threads().summary
C#: Threads.SummaryAsync
CLI: openemail threads summary

`nextmail.threads.replySuggestions()`

Suggest replies to a thread

threads:read

Signature

replySuggestions(id: string, options?: RequestScope): Promise<ReplySuggestionsResource>

Resolves up to three short replies to the latest message of the thread, the ones the reading pane offers under it. Each has a label, a few words that say what it answers, and a body, the reply itself in plain text, ready to send with emails.send or to keep with drafts.create. They are written in the language of that message and the voice of the mail this workspace sends, from the conversation, what was written to this correspondent before, what is known about their organisation and, when the message asks for a time, the busy times of the calendar.

Suggestions are written once for each new message and kept, so asking again is free until another message arrives. state is ready with the suggestions, pending while they are being written, so ask again a few seconds later, or none when the message needs no reply: your own reply came last, or it is a newsletter, an automated notice, mail from a no-reply address, spam or an encrypted message. Every thread is none in a workspace that turned replySuggestions off with settings.update.

sources names the knowledge base items the suggestions drew on: the pinned notes at the levels of the receiving address and the items whose passages matched the message, each a KnowledgeSourceRef with id, title, kind, scope and url. It is empty when none were used.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ReplySuggestionsResource, { object: 'reply_suggestions', threadId, messageId, state, suggestions, sources }, with messageId naming the message they answer, suggestions empty unless state is ready and sources the knowledge base items they drew on.

Example

let result = await nextmail.threads.replySuggestions('CAHk7pQ2x9LmZ4-mail.example.com') if (result.state === 'pending') {    await new Promise((resolve) => setTimeout(resolve, 5000))    result = await nextmail.threads.replySuggestions('CAHk7pQ2x9LmZ4-mail.example.com')} for (const suggestion of result.suggestions) {    console.log(`${suggestion.label}: ${suggestion.body}`)}

Notes

Writing suggestions spends none of the workspace's AI actions. A workspace has suggestions written for a limited number of new messages a day, and past it a thread reads none until the next day.
A thread delivered to no address the key covers is a 404.
A server without AI answers 409 ai_not_configured.

Also available in

API: GET /threads/{id}/reply-suggestions
Python: threads.reply_suggestions()
Ruby: threads.reply_suggestions
PHP: threads->replySuggestions
Go: Threads.ReplySuggestions
Java: threads().replySuggestions
C#: Threads.ReplySuggestionsAsync
CLI: openemail threads reply-suggestions

`nextmail.threads.restore()`

Take a thread out of the Bin

threads:write

Signature

restore(id: string, options?: RequestScope): Promise<RestoredThreadResource>

Puts a thread back in the inbox, out of the Bin and out of Spam, which is what Restore from Bin and Move to inbox do in the app. It is the undo of trash.

Calling it on a thread that is already in the inbox changes nothing and returns the same body, which is why the SDK retries it.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

RestoredThreadResource, { object: 'thread', id, restored: true }.

Example

await nextmail.threads.trash('CAHk7pQ2x9LmZ4-mail.example.com') const restored = await nextmail.threads.restore('CAHk7pQ2x9LmZ4-mail.example.com') console.log(restored.restored)

Notes

A thread that was archived before it went to the Bin comes back to the inbox, not to the archive.
A thread delivered to no address the key covers is a 404.

Also available in

API: POST /threads/{id}/restore
Python: threads.restore()
Ruby: threads.restore
PHP: threads->restore
Go: Threads.Restore
Java: threads().restore
C#: Threads.RestoreAsync
CLI: openemail threads restore

`nextmail.threads.delete()`

Delete a thread for good

threads:write

Signature

delete(id: string, options?: RequestScope): Promise<DeletedThreadResource>

Deletes every message in a thread, with its attachments, which is what Delete from Bin does in the app. It cannot be undone.

It works on a thread in any folder, so call trash instead when you only mean to throw the thread away: a trashed thread stays readable and restore brings it back.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

DeletedThreadResource, { object: 'thread', id, deleted: true }.

Example

await nextmail.threads.delete('CAHk7pQ2x9LmZ4-mail.example.com')

Notes

The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
A 500 thread_delete_failed means nothing was removed, so the call is safe to repeat.
A thread delivered to no address the key covers is a 404.

Also available in

API: DELETE /threads/{id}
Python: threads.delete()
Ruby: threads.delete
PHP: threads->delete
Go: Threads.Delete
Java: threads().delete
C#: Threads.DeleteAsync
CLI: openemail threads delete

`nextmail.threads.unsubscribe()`

Unsubscribe from the sender of a thread

threads:write

Signature

unsubscribe(id: string, options?: RequestScope): Promise<UnsubscribeResultResource>

Does what the Unsubscribe button of the reading pane does: finds the subscription behind the newest message of the thread that carries a List-Unsubscribe header and unsubscribes from it the way the sender asks for, with a one-click request or an unsubscribe email. A sender that only offers a page cannot be unsubscribed by a program, so method is link and url is the page a person has to open.

A thread with no unsubscribe header is a 422 unsubscribe_unsupported, and a thread delivered to no address the key covers is a 404.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

UnsubscribeResultResource, { object: 'unsubscribe', threadId, subscriptionId, method, url, binned }.

Example

const result = await nextmail.threads.unsubscribe('CAHk7pQ2x9LmZ4-mail.example.com') console.log(result.method)

Notes

The SDK does not retry it, because a second call can send a second unsubscribe email.

Also available in

API: POST /threads/{id}/unsubscribe
Python: threads.unsubscribe()
Ruby: threads.unsubscribe
PHP: threads->unsubscribe
Go: Threads.Unsubscribe
Java: threads().unsubscribe
C#: Threads.UnsubscribeAsync
CLI: openemail threads unsubscribe

`nextmail.threads.getEvent()`

Read the event a thread carries

calendar:read

Signature

getEvent(id: string, options?: RequestScope): Promise<CalendarEventResource>

Returns the calendar event that came with an invitation in the thread, as the invitation card of the reading pane shows it. Answer it with calendar.respondToEvent.

Parameters

idstringRequired: Thread id, as threads.list returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

CalendarEventResource, as calendar.getEvent returns it.

Example

const event = await nextmail.threads.getEvent('thr_6d1a9c4e2b7f30d85e1c4a92') console.log(event.summary, event.start)

Notes

A thread with no event, or one the key does not reach, is a 404.

Also available in

API: GET /threads/{id}/event
Python: threads.get_event()
Ruby: threads.get_event
PHP: threads->getEvent
Go: Threads.GetEvent
Java: threads().getEvent
C#: Threads.GetEventAsync
CLI: openemail threads get-event

`nextmail.threads.listSenderCategories()`

List the senders that always go to one inbox tab

threads:read

Signature

listSenderCategories(options?: RequestScope): Promise<Array<SenderCategoryResource>>

Resolves the senders whose mail always goes to one inbox tab, by address. New mail is sorted into Primary, Promotions, Updates, Social or Forums by plain rules, and a choice saved here wins over them. list takes category to read one tab.

The choices belong to the workspace and apply to every address in it. A workspace holds at most 2,000 of them, and they come back as one plain array with no paging.

Parameters

options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<SenderCategoryResource>, each { object: 'sender_category', sender, category, updatedAt }, with sender in lower case and category the tab their mail goes to.

Example

const choices = await nextmail.threads.listSenderCategories() for (const choice of choices) console.log(choice.sender, choice.category)

Notes

A key or an app limited to particular addresses or domains can read the choices but not change them.
Read only, so the SDK retries it after a network failure like any other read.

Also available in

API: GET /sender-categories
Python: threads.list_sender_categories()
Ruby: threads.list_sender_categories
PHP: threads->listSenderCategories
Go: Threads.ListSenderCategories
Java: threads().listSenderCategories
C#: Threads.ListSenderCategoriesAsync
CLI: openemail threads list-sender-categories

`nextmail.threads.setSenderCategory()`

Always sort a sender into one inbox tab

threads:write

Signature

setSenderCategory(email: string, category: InboxCategory, options?: RequestScope): Promise<SenderCategoryResource>

Saves the tab for one sender and moves the inbox threads whose newest message is from them, up to the newest 1,000, into it. Mail from them is sorted there from now on, whatever the rules would say. Saving again replaces the choice.

A workspace holds at most 2,000 choices, and the call past that is a 422 sender_category_limit_reached. They apply to every address in the workspace, so a key or an app limited to particular addresses or domains can read them but not change them, and gets a 422 capability_unsupported.

Parameters

emailstringRequired: The address of the sender, compared without case.
categoryInboxCategoryRequired: The inbox tab their mail goes to: primary, promotions, updates, social or forums.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

SenderCategoryResource, { object: 'sender_category', sender, category, updatedAt }, with sender in lower case.

Example

const choice = await nextmail.threads.setSenderCategory('[email protected]', 'promotions') console.log(choice.sender, choice.category, choice.updatedAt)

Notes

An address or a category that is not valid is a 422 invalid_parameter.
Choosing primary keeps a sender out of the other tabs, which is how to stop a newsletter you read from being sorted away.
The SDK retries this call after a network failure, which is safe because saving the same choice twice leaves the same choice.

Also available in

API: PUT /sender-categories/{email}
Python: threads.set_sender_category()
Ruby: threads.set_sender_category
PHP: threads->setSenderCategory
Go: Threads.SetSenderCategory
Java: threads().setSenderCategory
C#: Threads.SetSenderCategoryAsync
CLI: openemail threads set-sender-category

`nextmail.threads.clearSenderCategory()`

Remove the tab chosen for a sender

threads:write

Signature

clearSenderCategory(email: string, options?: RequestScope): Promise<DeletedSenderCategoryResource>

Removes the choice, so new mail from the sender is sorted by the rules again. Threads already sorted stay where they are.

Parameters

emailstringRequired: The address of the sender, compared without case.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

DeletedSenderCategoryResource, { object: 'sender_category', sender, deleted: true }, with sender in lower case.

Example

const removed = await nextmail.threads.clearSenderCategory('[email protected]') console.log(removed.sender, removed.deleted)

Notes

A sender with no saved choice is a 404. The SDK does not retry a delete, so a 404 on your own second attempt after a lost response means the first one worked.
A key or an app limited to particular addresses or domains cannot change the choices, and gets a 422 capability_unsupported.

Also available in

API: DELETE /sender-categories/{email}
Python: threads.clear_sender_category()
Ruby: threads.clear_sender_category
PHP: threads->clearSenderCategory
Go: Threads.ClearSenderCategory
Java: threads().clearSenderCategory
C#: Threads.ClearSenderCategoryAsync
CLI: openemail threads clear-sender-category

`nextmail.threads.getTeam()`

Read who has a thread

threads:read

Signature

getTeam(id: string, options?: RequestScope): Promise<ThreadTeamResource>

Resolves the thread as the team sees it: who it is assigned to, who marked it done, how many comments it has, who else is writing a reply in the app right now, and everyone who can see it.

Only people who can see a thread can be given it or mentioned on it: the workspace owner, members who reach every address, and members who hold its address or its domain. A key acts for the workspace owner.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadTeamResource with assignment, commentCount, replying and team.

Example

const team = await nextmail.threads.getTeam('CAHk7pQ2x9LmZ4-mail.example.com') console.log(team.assignment.assignee?.email ?? 'nobody', team.team.length)

Notes

A thread delivered to no address the key covers is a 404.

Also available in

API: GET /threads/{id}/team
Python: threads.get_team()
Ruby: threads.get_team
PHP: threads->getTeam
Go: Threads.GetTeam
Java: threads().getTeam
C#: Threads.GetTeamAsync
CLI: openemail threads get-team

`nextmail.threads.assign()`

Assign a thread

threads:write

Signature

assign(id: string, assigneeId: string, options?: RequestScope): Promise<ThreadAssignmentResource>

Gives the thread to one person, who is emailed unless they assigned it to themselves.

Parameters

idstringRequired: Thread id.
assigneeIdstringRequired: The user id of the person to give it to, as getTeam lists them in team.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadAssignmentResource, who has the thread now.

Example

const assignment = await nextmail.threads.assign('CAHk7pQ2x9LmZ4-mail.example.com', 'usr_2f9c1d') console.log(assignment.assignee?.email)

Notes

Somebody who cannot see the thread is a 422 invalid_parameter on assigneeId.

Also available in

API: PUT /threads/{id}/assignee
Python: threads.assign()
Ruby: threads.assign
PHP: threads->assign
Go: Threads.Assign
Java: threads().assign
C#: Threads.AssignAsync
CLI: openemail threads assign

`nextmail.threads.unassign()`

Unassign a thread

threads:write

Signature

unassign(id: string, options?: RequestScope): Promise<ThreadAssignmentResource>

Leaves the thread with nobody.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadAssignmentResource with assignee null.

Example

await nextmail.threads.unassign('CAHk7pQ2x9LmZ4-mail.example.com')

Also available in

API: DELETE /threads/{id}/assignee
Python: threads.unassign()
Ruby: threads.unassign
PHP: threads->unassign
Go: Threads.Unassign
Java: threads().unassign
C#: Threads.UnassignAsync
CLI: openemail threads unassign

`nextmail.threads.markDone()`

Mark a thread done

threads:write

Signature

markDone(id: string, options?: RequestScope): Promise<ThreadAssignmentResource>

Archives the thread for everyone and records who marked it done. A new reply brings it back to the inbox, and reopen moves it back by hand.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadAssignmentResource with doneBy and doneAt.

Example

const assignment = await nextmail.threads.markDone('CAHk7pQ2x9LmZ4-mail.example.com') console.log(assignment.doneAt)

Also available in

API: POST /threads/{id}/done
Python: threads.mark_done()
Ruby: threads.mark_done
PHP: threads->markDone
Go: Threads.MarkDone
Java: threads().markDone
C#: Threads.MarkDoneAsync
CLI: openemail threads mark-done

`nextmail.threads.reopen()`

Reopen a thread

threads:write

Signature

reopen(id: string, options?: RequestScope): Promise<ThreadAssignmentResource>

Moves a done thread back to the inbox for everyone.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadAssignmentResource with doneBy and doneAt null.

Example

await nextmail.threads.reopen('CAHk7pQ2x9LmZ4-mail.example.com')

Also available in

API: POST /threads/{id}/reopen
Python: threads.reopen()
Ruby: threads.reopen
PHP: threads->reopen
Go: Threads.Reopen
Java: threads().reopen
C#: Threads.ReopenAsync
CLI: openemail threads reopen

`nextmail.threads.listComments()`

List the comments on a thread

threads:read

Signature

listComments(id: string, options?: RequestScope): Promise<Array<ThreadCommentResource>>

Resolves the team comments on one thread, oldest first. Everyone who can see the thread reads them, and the sender never does.

Parameters

idstringRequired: Thread id.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

Array<ThreadCommentResource>, each with author, body, mentions, createdAt and editedAt.

Example

const comments = await nextmail.threads.listComments('CAHk7pQ2x9LmZ4-mail.example.com') for (const comment of comments) console.log(comment.author?.email, comment.body)

Notes

A thread delivered to no address the key covers is a 404.

Also available in

API: GET /threads/{id}/comments
Python: threads.list_comments()
Ruby: threads.list_comments
PHP: threads->listComments
Go: Threads.ListComments
Java: threads().listComments
C#: Threads.ListCommentsAsync
CLI: openemail threads list-comments

`nextmail.threads.createComment()`

Comment on a thread

threads:write

Signature

createComment(id: string, body: ThreadCommentCreate, options?: RequestScope): Promise<ThreadCommentResource>

Adds a comment for the team. Everybody in mentions is emailed.

Parameters

idstringRequired: Thread id.
body.bodystringRequired: What the comment says, up to 10,000 characters. Leading and trailing spaces are trimmed.
body.mentionsArray<string>: The user ids of people to mention, at most 20. Each has to be able to see the thread.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadCommentResource for the new comment.

Example

const comment = await nextmail.threads.createComment('CAHk7pQ2x9LmZ4-mail.example.com', {    body: 'Can you take this one?',    mentions: ['usr_2f9c1d']}) console.log(comment.id)

Notes

The SDK does not retry it, because a second call would add a second comment.
Somebody in mentions who cannot see the thread is a 422 invalid_parameter on mentions.

Also available in

API: POST /threads/{id}/comments
Python: threads.create_comment()
Ruby: threads.create_comment
PHP: threads->createComment
Go: Threads.CreateComment
Java: threads().createComment
C#: Threads.CreateCommentAsync
CLI: openemail threads create-comment

`nextmail.threads.updateComment()`

Change a comment

threads:write

Signature

updateComment(id: string, commentId: string, body: ThreadCommentCreate, options?: RequestScope): Promise<ThreadCommentResource>

Replaces the text and the mentions of a comment. Only its author can change it, and anybody newly mentioned is emailed.

Parameters

idstringRequired: Thread id.
commentIdstringRequired: The comment id, as listComments returns it.
body.bodystringRequired: The new text, up to 10,000 characters.
body.mentionsArray<string>: The user ids it mentions now, at most 20. Leave it out to mention nobody.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

ThreadCommentResource as it is now.

Example

await nextmail.threads.updateComment('CAHk7pQ2x9LmZ4-mail.example.com', 'tcm_8a1f', {    body: 'Done, sent the quote.'})

Notes

Someone else's comment, or one on another thread, is a 404.

Also available in

API: PATCH /threads/{id}/comments/{commentId}
Python: threads.update_comment()
Ruby: threads.update_comment
PHP: threads->updateComment
Go: Threads.UpdateComment
Java: threads().updateComment
C#: Threads.UpdateCommentAsync
CLI: openemail threads update-comment

`nextmail.threads.deleteComment()`

Delete a comment

threads:write

Signature

deleteComment(id: string, commentId: string, options?: RequestScope): Promise<DeletedThreadCommentResource>

Deletes a comment for good. Its author can delete it, and so can the workspace owner, which a key acts for.

Parameters

idstringRequired: Thread id.
commentIdstringRequired: The comment id, as listComments returns it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Returns

DeletedThreadCommentResource with deleted: true.

Example

await nextmail.threads.deleteComment('CAHk7pQ2x9LmZ4-mail.example.com', 'tcm_8a1f')

Also available in

API: DELETE /threads/{id}/comments/{commentId}
Python: threads.delete_comment()
Ruby: threads.delete_comment
PHP: threads->deleteComment
Go: Threads.DeleteComment
Java: threads().deleteComment
C#: Threads.DeleteCommentAsync
CLI: openemail threads delete-comment