SDK

openemail.contacts

Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.

Méthodes

The workspace address book: people it has written to, plus anybody you save yourself.

`contacts.list()`

List the workspace contacts, most recently seen first

contacts:readParcourt les résultats page par page

Signature

list(options?: ContactListOptions): Promise<Page<ContactResource>>

Returns one page of the workspace address book, ordered by lastSeenAt with the most recent first and contacts that have never been mailed last. source says where a row came from: manual for a contact somebody saved, in the app or through create, and auto for an address recorded when a member sent mail to it from the app composer. A saved contact stays manual when it is mailed later.

options.source narrows the page to one origin, so { source: 'manual' } is the contacts somebody saved on purpose and { source: 'auto' } the ones the composer recorded. options.q searches the name and the address.

This lists saved contacts only. listPeople lists everyone the Contacts page in the app shows, the addresses seen in mail included, with thread counts.

Paging is keyset. options.limit takes 1 to 200 and defaults to 50, and nextCursor goes back as options.cursor while hasMore is true. Never build a cursor yourself.

Contacts belong to the whole workspace rather than to any one address, so a key limited to particular addresses or domains reads and writes the same book as every other key. An app connected by a member who reaches only some addresses is refused with 422 capability_unsupported on addressAllowlist, on every contacts, audiences and broadcasts route.

Paramètres

options.limitnumber: Rows per page, a whole number from 1 to 200. The server defaults to 50.
options.cursorstring: The nextCursor from the previous page. Never build one yourself.
options.sourceContactSource: manual or auto. Leave it out for the whole book.
options.qstring: Searches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

Page<ContactResource> with items, hasMore and nextCursor. Each contact has email, name, source, notes, photoUrl and lastSeenAt.

Exemple

const saved = await openemail.contacts.list({ source: 'manual', limit: 200 }) console.log(saved.items.map((contact) => contact.name ?? contact.email))

Remarques

Mail sent through this API adds no contacts. Only sends from the app composer record recipients, and create is the way to add one deliberately.
Every member of the workspace reads and writes the same book, so a contact saved by one person is visible to the rest.
A contact that has never been mailed has lastSeenAt null and sorts last, after every contact with a date.
Addresses are stored lower cased.

Aussi disponible dans

API: GET /contacts
CLI: openemail contacts list

`contacts.listAll()`

Collect the whole address book into one array

contacts:readParcourt les résultats page par page

Signature

listAll(options?: ContactListOptions): Promise<Array<ContactResource>>

Follows nextCursor from page to page and resolves with every contact in the workspace, most recently seen first and never-mailed contacts last. It takes the same source and q filters as list.

Everything is held in memory before the promise settles, and an address book grows with every recipient the composer records. Prefer iterate when you can stop early. limit sets the page size of each request, not the total.

Paramètres

options.sourceContactSource: manual or auto. Leave it out for the whole book.
options.qstring: Searches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

Array<ContactResource> holding every contact across all pages.

Exemple

const saved = await openemail.contacts.listAll({ source: 'manual', limit: 200 }) console.log(`${saved.length} contacts saved on purpose`)

Remarques

A failure on any page rejects the whole call, and the contacts already fetched are discarded.

Aussi disponible dans

API: GET /contacts

`contacts.iterate()`

Stream the address book one contact at a time

contacts:readParcourt les résultats page par page

Signature

iterate(options?: ContactListOptions): AsyncGenerator<ContactResource, void, undefined>

Returns an async generator that yields contacts individually, most recently seen first, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Paramètres

options.sourceContactSource: manual or auto. Leave it out for the whole book.
options.qstring: Searches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
options.limitnumber: Page size per request, from 1 to 200, defaulting to 50 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

AsyncGenerator<ContactResource, void, undefined> yielding one contact per step.

Exemple

for await (const contact of openemail.contacts.iterate({ source: 'auto' })) {    if (contact.lastSeenAt === null) break     console.log(contact.email, contact.lastSeenAt)}

Remarques

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Aussi disponible dans

API: GET /contacts

`contacts.get()`

Read one contact by email address

contacts:read

Signature

get(email: string, options?: RequestScope): Promise<ContactDetailResource>

Looks up a contact by address in the workspace address book. The address is trimmed and lower cased before the lookup, so [email protected] finds [email protected], and the SDK URL encodes it for the path.

A 404 means only that the address is not in the book. It says nothing about whether mail has been exchanged with it, since received mail never creates contacts.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource with email, name, source, notes, photoUrl and lastSeenAt, plus audiences, every audience the contact is in as { id, name, builtin }. builtin is default on the audience every contact belongs to and null on one somebody created.

Exemple

try {    const contact = await openemail.contacts.get('[email protected]')    console.log(contact.name, contact.notes)} catch (error) {    if (error instanceof OpenEmailApiError && error.isNotFound) console.log('not in the address book')    else throw error}

Remarques

name is null for an address recorded automatically without a display name, and notes is free text somebody set in the app or through update.
The address is the contact's identity here and on every other contacts route. There is no id in the public contract.

Aussi disponible dans

API: GET /contacts/{email}
CLI: openemail contacts get

`contacts.create()`

Save a contact in the workspace address book

contacts:write

Signature

create(body: ContactCreate, options?: RequestScope): Promise<ContactDetailResource>

Adds one address to the workspace address book and returns the saved row. email is trimmed and lower cased before it is stored, so [email protected] and [email protected] are the same contact.

The contact is saved with source set to manual, the same value a contact typed into the app carries, and it joins the default audience as it is written. Every contact is in that audience for as long as it exists, so there is nothing to add afterwards. Name audiences of your own in audienceIds to put it in them in the same call, or add it later with audiences.addContact. Sending audienceIds also requires the audiences:write scope, since it writes memberships as well as a contact.

An address can be in the book once. A second create for an address that is already there is refused with 409 contact_exists rather than merged, so a retry cannot quietly overwrite a name somebody edited in the app. Read the existing row with get and change it with update.

Paramètres

body.emailstringObligatoire: The address to save, trimmed and lower cased before it is stored.
body.namestring | null: Display name. Leave it out to save the contact without one.
body.notesstring | null: Free text kept with the contact and shown beside it in the app.
body.audienceIdsArray<string>: Up to 25 audience ids to put the new contact in. The default audience is joined whether or not it is named. When this is present the key also needs audiences:write, or the call is refused with 403 before anything is saved.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource with email, name, source as manual, notes and lastSeenAt, which is null until mail goes to the address from the app composer, plus audiences, every audience the contact is now in, the default one included.

Exemple

const contact = await openemail.contacts.create({    email: '[email protected]',    name: 'Grace Hopper',    notes: 'Met at the compiler workshop'}) console.log(contact.email, contact.source)

Remarques

The SDK does not retry a create after a network failure. If you retry by hand after a lost response, a 409 contact_exists means the first attempt landed.
Contacts belong to the workspace, so the contact this creates is the one every member and every other key sees.
An id in audienceIds that is not an audience of this workspace fails the whole create. Nothing is saved.

Aussi disponible dans

API: POST /contacts
CLI: openemail contacts create

`contacts.update()`

Change a contact's name or notes

contacts:write

Signature

update(email: string, patch: ContactPatch, options?: RequestScope): Promise<ContactDetailResource>

Changes the fields you send and leaves the rest alone. A key you leave out keeps its stored value, and an explicit null clears it, so { notes: null } empties the notes while {} changes nothing.

The address cannot be changed. It is the contact's identity, its path segment and the unique key of the book, so moving a contact to a new address is a delete and a create, and that new contact starts with no audience membership beyond the default one.

source and lastSeenAt are the server's to set and are not accepted here. A contact recorded automatically stays auto after you give it a name.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
patch.namestring | null: New display name. Null clears it.
patch.notesstring | null: New notes. Null clears them.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource as it stands after the change, with audiences alongside it.

Exemple

const contact = await openemail.contacts.update('[email protected]', {    name: 'Grace Hopper',    notes: null}) console.log(contact.name, contact.notes)

Remarques

The SDK retries this call after a network failure, since the same patch sent twice leaves the same contact.
An address that is not in the book is a 404, the same as get.
Audience membership is not touched here. Use setAudiences to set the whole list, or audiences.addContact and audiences.removeContact for one audience.

Aussi disponible dans

API: PATCH /contacts/{email}
CLI: openemail contacts update

`contacts.delete()`

Delete somebody from the contacts and hide the address

contacts:write

Signature

delete(email: string, options?: RequestScope): Promise<DeletedContactResource>

Does what Delete does on the Contacts page in the app. A saved contact goes with its notes, its photo and every audience it was in, the default one included. The address is then hidden: listPeople leaves it out, and mail sent to it from the app composer no longer records it as a contact. The address can be one that was only ever seen in mail, which is how you take somebody off the people list, and wasSaved says which it was.

Nothing else moves: the mail exchanged with the address stays in the mailbox, and the address can still be written to. There is no undo. create or save afterwards brings the address back as a new contact with no name, no notes and no membership beyond the default audience.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

DeletedContactResource, { object: 'contact', email, deleted: true, wasSaved }.

Exemple

const removed = await openemail.contacts.delete('[email protected]') console.log(removed.email, removed.deleted)

Remarques

An address that is not in the book is no longer a 404: it is hidden and answers with wasSaved false. Something that is not an address is a 422 invalid_contact.
The SDK does not retry a delete, though a second attempt is harmless: it answers with wasSaved false.
deleteMany deletes up to 200 addresses in one call.

Aussi disponible dans

API: DELETE /contacts/{email}
CLI: openemail contacts delete

`contacts.setAudiences()`

Set exactly which audiences a contact is in

audiences:write

Signature

setAudiences(email: string, body: ContactAudiencesSet, options?: RequestScope): Promise<ContactDetailResource>

Makes the contact's audiences match the list you send, the way the audience picker on a contact does in the app. The contact joins every listed audience it is not in yet and leaves every other one, in one transaction, and memberships it keeps keep their addedAt.

The default audience is always kept, whether or not you name it, so { audienceIds: [] } leaves the contact in the default audience alone. To add or remove one audience without restating the rest, use audiences.addContact or audiences.removeContact.

The address is trimmed and lower cased, the SDK URL encodes it for the path, and it has to be a contact already: an address that is not in the book is a 404 contact_not_found on email. Create it with create, which takes audienceIds too. An id that is not an audience of this workspace is a 404 audience_not_found on audienceIds, and nothing is changed.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
body.audienceIdsArray<string>Obligatoire: Every audience the contact should be in, up to 100 ids. A repeated id counts once. More than 100 is a 422 invalid_parameter on audienceIds, and an empty id is the same error on that entry, such as audienceIds.0.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource as it stands after the change, with audiences, every audience the contact is now in as { id, name, builtin }, the default one included.

Exemple

const contact = await openemail.contacts.setAudiences('[email protected]', {    audienceIds: ['aud_9f2c4b7e1a0d63d84c5f2e7b', 'aud_1c4e7a9b2d0f36e85a7c1b4d']}) console.log(contact.audiences.map((audience) => audience.name))

Remarques

audiences:write is the only scope checked, because this writes memberships rather than the contact.
Safe to replay: sending the same list again changes nothing. The SDK retries it after a network failure.
Read the current list with get first when you mean to add one audience to what the contact already has, or use audiences.addContact.

Aussi disponible dans

API: PUT /contacts/{email}/audiences
CLI: openemail contacts set-audiences

`contacts.listPeople()`

List everyone on the Contacts page, saved or seen in mail

contacts:readParcourt les résultats page par page

Signature

listPeople(options?: PersonListOptions): Promise<PeoplePage>

Returns one page of the people the Contacts page in the app lists: the saved contacts, and every address seen in mail as the sender or a recipient of a thread's newest message. Each row says whether it is saved, how many threads it shares with the mailbox and when mail last moved (lastAt). A person seen in mail and saved is one row. list is the saved contacts alone.

The addresses seen in mail are included only when the key also holds threads:read, because they are read out of the mail. Without it the page holds the saved contacts and seen is false. Deleted addresses and the mailbox's own addresses are never listed.

sort is recent, newest mail first and saved contacts never seen in mail after them, name, by name or else by address, ignoring case, or threads, most threads first. blockedBy on each row names the workspace blocklist rule that blocks it, and blocked: true narrows the page to those rows.

Paging is keyset. options.limit takes 1 to 100 and defaults to 25, and nextCursor goes back as options.cursor, with the same sort, q and blocked, while hasMore is true.

Paramètres

options.qstring: Searches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
options.emailstring: One address only, matched case insensitively: the way to read one person's thread count and last mail.
options.sortPeopleSort: recent (the default), name or threads.
options.blockedboolean: true for only the people the workspace blocklist blocks, whole-domain rules included.
options.limitnumber: Rows per page, 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page. Never build one yourself.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

PeoplePage: items, hasMore, nextCursor and seen. Each PersonResource has email, displayEmail, name, saved, source, notes, photoUrl, threads, lastAt, createdAt, updatedAt and blockedBy.

Exemple

const page = await openemail.contacts.listPeople({ sort: 'threads', limit: 50 }) for (const person of page.items) {    console.log(person.name ?? person.email, person.threads, person.saved ? 'saved' : 'seen in mail')}

Remarques

email is lower cased and is what every other contacts method takes. displayEmail keeps the capitals the newest message wrote.
A malformed or stale cursor is a 400 invalid_cursor. Start again without one.
A key limited to particular addresses or domains gets the saved contacts alone, with seen false, even when it holds threads:read, because the addresses seen in mail would be read from the mail of every address in the workspace.

Aussi disponible dans

API: GET /contacts/people
CLI: openemail contacts list-people

`contacts.listAllPeople()`

Collect everyone on the Contacts page into one array

contacts:readParcourt les résultats page par page

Signature

listAllPeople(options?: PersonListOptions): Promise<Array<PersonResource>>

Follows nextCursor from page to page and resolves with every person listPeople would list, in the same order and with the same filters. It is how you count the people a blocklist blocks: (await openemail.contacts.listAllPeople({ blocked: true })).length.

Everything is held in memory before the promise settles, and a busy mailbox has seen a great many addresses. Prefer iteratePeople when you can stop early.

Paramètres

options.qstring: Searches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
options.emailstring: One address only, matched case insensitively: the way to read one person's thread count and last mail.
options.sortPeopleSort: recent (the default), name or threads.
options.blockedboolean: true for only the people the workspace blocklist blocks, whole-domain rules included.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

Array<PersonResource> holding every person across all pages.

Exemple

const blocked = await openemail.contacts.listAllPeople({ blocked: true, limit: 100 }) console.log(`${blocked.length} people are blocked`)

Remarques

A failure on any page rejects the whole call, and the people already fetched are discarded.
seen is not reported here. Read one page with listPeople to learn whether the key reads the people seen in mail.

Aussi disponible dans

API: GET /contacts/people

`contacts.iteratePeople()`

Stream everyone on the Contacts page one person at a time

contacts:readParcourt les résultats page par page

Signature

iteratePeople(options?: PersonListOptions): AsyncGenerator<PersonResource, void, undefined>

Returns an async generator that yields the people listPeople lists, one at a time, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Paramètres

options.qstring: Searches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
options.emailstring: One address only, matched case insensitively: the way to read one person's thread count and last mail.
options.sortPeopleSort: recent (the default), name or threads.
options.blockedboolean: true for only the people the workspace blocklist blocks, whole-domain rules included.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

AsyncGenerator<PersonResource, void, undefined> yielding one person per step.

Exemple

for await (const person of openemail.contacts.iteratePeople({ sort: 'recent' })) {    if (!person.saved && (person.threads ?? 0) > 5) await openemail.contacts.save(person.email)}

Remarques

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Aussi disponible dans

API: GET /contacts/people

`contacts.save()`

Save an address as a contact, or keep one that was recorded

contacts:write

Signature

save(email: string, body?: ContactSave, options?: RequestScope): Promise<ContactDetailResource>

Does what Add to contacts and Keep in contacts do in the app, and is safe to call whatever state the address is in. An address that is not a contact yet becomes one with source manual. A contact recorded from a send becomes manual. A contact already saved keeps what it has. A deleted address is brought back.

body.name replaces the stored name and leaving it out keeps it. body.notes replaces the stored notes and null clears them. Unlike create, an address already in the book is not an error, and unlike update, an address not in the book is not one either.

Paramètres

emailstringObligatoire: The address, trimmed and lower cased on the server.
body.namestring: Up to 200 characters. Left out, the stored name is kept.
body.notesstring | null: Up to 5,000 characters. null clears the notes; left out, they are kept.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource, the contact as it stands after the save, with audiences.

Exemple

const contact = await openemail.contacts.save('[email protected]', { name: 'Grace Hopper' }) console.log(contact.source)

Remarques

The server answers 201 for a new contact and 200 for one that was there. The SDK resolves the same way for both, so compare createdAt with updatedAt if you need to tell them apart.
Safe to replay, so the SDK retries it after a network failure.
A new contact joins the default audience, as it does from create.

Aussi disponible dans

API: PUT /contacts/{email}
CLI: openemail contacts save

`contacts.deleteMany()`

Delete up to 200 contacts in one call

contacts:write

Signature

deleteMany(emails: Array<string>, options?: RequestScope): Promise<ContactBatchDeleteResource>

Deletes every address in emails the way delete deletes one: a saved contact goes with its notes, its photo and every audience membership, and every address is hidden, so mail sent to it from the app composer does not record it again. Addresses that were only seen in mail are hidden too.

An entry that is not an address comes back in invalid and the rest still go through. A repeated address counts once. There is no undo.

Paramètres

emailsArray<string>Obligatoire: 1 to 200 addresses, matched case insensitively. More than 200, or none, is a 422 on emails.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactBatchDeleteResource, { object: 'contact_batch_delete', deleted, saved, invalid }. deleted counts the addresses deleted and hidden, saved how many of them were saved contacts.

Exemple

const result = await openemail.contacts.deleteMany(['[email protected]', '[email protected]']) console.log(`${result.deleted} deleted, ${result.saved} of them saved contacts`)

Remarques

Safe to replay: deleting an address twice leaves it deleted and hidden, so the SDK retries it after a network failure.
No mail is deleted, and nobody is unsubscribed from anything.

Aussi disponible dans

API: POST /contacts/batch-delete
CLI: openemail contacts delete-many

`contacts.setPhoto()`

Upload the photo shown for a contact

contacts:write

Signature

setPhoto(email: string, data: RawBody, options?: ContactPhotoOptions): Promise<ContactDetailResource>

Sends the image bytes as the request body, replacing any photo the contact had. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP, keeps the first frame of an animation, and answers with the contact and its new photoUrl.

data is a Blob, an ArrayBuffer or a Uint8Array. The type is read from options.contentType, or from a Blob's own type when that is left out. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.

The address has to be a saved contact already: save it first.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
dataRawBodyObligatoire: The image: a Blob, ArrayBuffer or Uint8Array.
options.contentTypeContactPhotoType: image/png, image/jpeg, image/webp or image/gif. Required unless data is a Blob with a type.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource with the new photoUrl.

Exemple

const file = Bun.file('grace.jpg') const contact = await openemail.contacts.setPhoto('[email protected]', await file.arrayBuffer(), { contentType: 'image/jpeg' }) console.log(contact.photoUrl)

Remarques

An address that is not a saved contact is a 404 contact_not_found.
A busy image service answers 503 image_busy, which the SDK retries like any other 503.
Every upload gets a new URL, so a cached old photo never shows under the new one.

Aussi disponible dans

API: PUT /contacts/{email}/photo
CLI: openemail contacts set-photo

`contacts.removePhoto()`

Remove a contact photo

contacts:write

Signature

removePhoto(email: string, options?: RequestScope): Promise<ContactDetailResource>

Takes the photo off the contact and deletes the stored image, the way Remove does on a contact in the app. The contact answers with photoUrl null. Removing a photo from a contact that has none changes nothing.

Paramètres

emailstringObligatoire: The contact's address, matched case insensitively.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactDetailResource with photoUrl null.

Exemple

await openemail.contacts.removePhoto('[email protected]')

Remarques

An address that is not a saved contact is a 404 contact_not_found.
Safe to replay, so the SDK retries it after a network failure.

Aussi disponible dans

API: DELETE /contacts/{email}/photo
CLI: openemail contacts remove-photo

`contacts.block()`

Block an address

settings:write

Signature

block(email: string, options?: RequestScope): Promise<ContactBlockResource>

Puts the address on the workspace blocklist, the same list settings.update edits as blockedSenders, so mail from it is refused from then on. This is Block on a contact in the app. A plus tag is dropped: blocking [email protected] blocks [email protected], and every tag of it.

When a rule already blocks the address, a whole-domain rule included, nothing is added: created is false and blockedBy names that rule. The address does not have to be a contact.

Paramètres

emailstringObligatoire: The address to block.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactBlockResource, { object: 'contact_block', email, blocked: true, blockedBy, created }.

Exemple

const result = await openemail.contacts.block('[email protected]') console.log(result.created ? 'blocked' : `already blocked by ${result.blockedBy?.rule}`)

Remarques

It needs settings:write rather than contacts:write, because it writes the blocklist rather than the contact.
Safe to replay, so the SDK retries it after a network failure.
An address with fewer than two letters or numbers is refused with 422 blocklist_entry_too_broad.
A key limited to particular addresses or domains gets 422 capability_unsupported on addressAllowlist, because the blocklist belongs to the whole workspace and filters the mail of every address in it.

Aussi disponible dans

API: POST /contacts/{email}/block
CLI: openemail contacts block

`contacts.unblock()`

Unblock an address

settings:write

Signature

unblock(email: string, options?: RequestScope): Promise<ContactBlockResource>

Takes every workspace blocklist rule that blocks the address off the list and lists them in removed. This is Unblock on a contact in the app.

When one of them is a whole-domain rule, in blockedDomains, everybody at that domain is unblocked with it, so check removed when that matters. Rules set for one address or one domain in the settings are not touched. An address that no rule blocks answers with removed empty.

Paramètres

emailstringObligatoire: The address to unblock.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactBlockResource, { object: 'contact_block', email, blocked: false, removed }, each entry of removed a { rule, list }.

Exemple

const result = await openemail.contacts.unblock('[email protected]') for (const hit of result.removed ?? []) console.log(hit.list, hit.rule)

Remarques

Safe to replay, so the SDK retries it after a network failure.
A key limited to particular addresses or domains gets 422 capability_unsupported on addressAllowlist, because the blocklist belongs to the whole workspace and filters the mail of every address in it.

Aussi disponible dans

API: DELETE /contacts/{email}/block
CLI: openemail contacts unblock

`contacts.listThreads()`

List the conversations with one person

threads:readParcourt les résultats page par page

Signature

listThreads(email: string, options?: ContactThreadListOptions): Promise<Page<ContactThreadResource>>

Returns one page of the threads the address wrote or was written to, in every folder: the Mail tab on a contact in the app. Each row is a summary, subject, from, receivedAt, messageCount, hasUnread and labels, and threads.get reads the messages behind its id.

options.limit takes 1 to 100 and defaults to 25. Pass nextCursor back as options.cursor, with the same q and sort, while hasMore is true.

Paramètres

emailstringObligatoire: The address. It does not have to be a saved contact.
options.qstring: Searches inside those threads, with the mailbox search syntax, up to 200 characters.
options.sortContactThreadSort: newest (the default), oldest, sender or subject.
options.limitnumber: Threads per page, 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page. Never build one yourself.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

Page<ContactThreadResource> with items, hasMore and nextCursor.

Exemple

const page = await openemail.contacts.listThreads('[email protected]', { q: 'invoice' }) for (const thread of page.items) console.log(thread.receivedAt, thread.subject)

Remarques

It needs threads:read, because it reads mail rather than the contact.
A key limited to particular addresses or domains gets 422 capability_unsupported on addressAllowlist, because a contact's threads and activity are read from the mail of every address in the workspace.

Aussi disponible dans

API: GET /contacts/{email}/threads
CLI: openemail contacts list-threads

`contacts.listAllThreads()`

Collect every conversation with one person into one array

threads:readParcourt les résultats page par page

Signature

listAllThreads(email: string, options?: ContactThreadListOptions): Promise<Array<ContactThreadResource>>

Follows nextCursor from page to page and resolves with every thread listThreads would list for the address, in the same order.

Everything is held in memory before the promise settles. Prefer iterateThreads when you can stop early.

Paramètres

emailstringObligatoire: The address. It does not have to be a saved contact.
options.qstring: Searches inside those threads, with the mailbox search syntax, up to 200 characters.
options.sortContactThreadSort: newest (the default), oldest, sender or subject.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

Array<ContactThreadResource> holding every thread across all pages.

Exemple

const threads = await openemail.contacts.listAllThreads('[email protected]') console.log(`${threads.length} conversations with Ada`)

Remarques

A failure on any page rejects the whole call, and the threads already fetched are discarded.

Aussi disponible dans

API: GET /contacts/{email}/threads

`contacts.iterateThreads()`

Stream the conversations with one person one thread at a time

threads:readParcourt les résultats page par page

Signature

iterateThreads(email: string, options?: ContactThreadListOptions): AsyncGenerator<ContactThreadResource, void, undefined>

Returns an async generator that yields the threads listThreads lists for the address, one at a time, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.

Paramètres

emailstringObligatoire: The address. It does not have to be a saved contact.
options.qstring: Searches inside those threads, with the mailbox search syntax, up to 200 characters.
options.sortContactThreadSort: newest (the default), oldest, sender or subject.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A cursor from an earlier page to start after.
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.

Retourne

AsyncGenerator<ContactThreadResource, void, undefined> yielding one thread per step.

Exemple

for await (const thread of openemail.contacts.iterateThreads('[email protected]')) {    if (thread.hasUnread) console.log('unread:', thread.subject)}

Remarques

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Aussi disponible dans

API: GET /contacts/{email}/threads

`contacts.activity()`

Read how mail with one person has gone over a window

threads:read

Signature

activity(email: string, options?: ContactActivityOptions): Promise<ContactActivityResource>

Returns the numbers behind the Activity tab on a contact in the app, over a window that ends now: messages received from the address and sent to it per bucket, the threads that moved, the threads whose newest message is theirs and so waits on a reply from the mailbox, when each side last wrote, and the median time each side takes to answer, in milliseconds.

options.minutes sets how far back the window reaches, 90 days by default. grain sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offsetMinutes shifts the boundaries so days break where the reader's day does. buckets is sparse and oldest first. Mail in the bin or in spam is left out.

Paramètres

emailstringObligatoire: The address. It does not have to be a saved contact.
options.minutesnumber: Window length in minutes, from 1 to about 20 years. The server defaults to 90 days.
options.grainTrackingGrain: Bucket width: minute, hour or day, defaulting to day.
options.offsetMinutesnumber: Minutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass -new Date().getTimezoneOffset() for the local zone.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Retourne

ContactActivityResource, { object: 'contact_activity', email, since, until, grain, buckets, totals, replyTime }. totals has received, sent, threads, waiting, lastReceivedAt and lastSentAt; replyTime has yours and theirs, each null when there is no reply to measure.

Exemple

const activity = await openemail.contacts.activity('[email protected]', { minutes: 30 * 24 * 60 }) console.log(`${activity.totals.received} in, ${activity.totals.sent} out, ${activity.totals.waiting} waiting on you`)

Remarques

It needs threads:read, because it reads mail rather than the contact.
Read only, so the SDK retries it after a network failure like any other read.
A key limited to particular addresses or domains gets 422 capability_unsupported on addressAllowlist, because a contact's threads and activity are read from the mail of every address in the workspace.

Aussi disponible dans

API: GET /contacts/{email}/activity
CLI: openemail contacts activity