nextmail.account
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The account of the person behind the key or the app: the email notifications they get and the workspaces muted on their phone, their profile photo and username, the apps they connected, the invitations waiting for them, the devices they are signed in on, their passkeys and their security log. An API key acts for the workspace owner, and an app for the person who connected it.
nextmail.account.getNotifications()
Read your notification settings
getNotifications(options?: RequestScope): Promise<NotificationSettingsResource>Resolves which kinds of email Nextmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. An API key answers for the workspace owner, and an app for the person who connected it.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
NotificationSettingsResource with email, one EmailNotificationSetting for each kind of email, and mutedWorkspaces.
Example
const settings = await nextmail.account.getNotifications() for (const kind of settings.email) console.log(kind.label, kind.enabled)Notes
accountandbillingemail are always on, andrequiredsays so.
Also available in
nextmail.account.setEmailNotification()
Turn a kind of email on or off
setEmailNotification(category: EmailNotificationCategory, body: EmailNotificationSet, options?: RequestScope): Promise<NotificationSettingsResource>enabled: false stops Nextmail sending the person that kind of email, and true starts it again. activity and product can be turned off. account and billing cannot, and asking to is a 422 invalid_parameter on category.
Parameters
categoryEmailNotificationCategoryRequiredaccount,billing,activityorproduct.body.enabledbooleanRequiredTrue to receive that email, false to stop it.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
NotificationSettingsResource as it is after the change.
Example
await nextmail.account.setEmailNotification('product', { enabled: false })Notes
Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
nextmail.account.setPushMuted()
Mute a workspace on your phone
setPushMuted(workspaceId: string, body: PushNotificationSet, options?: RequestScope): Promise<NotificationSettingsResource>muted: true stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and false lets it notify them again.
Parameters
workspaceIdstringRequiredA workspace id from
workspaces.list.body.mutedbooleanRequiredTrue to mute it, false to let it notify again.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
NotificationSettingsResource with the new mutedWorkspaces.
Example
const settings = await nextmail.account.setPushMuted('10417196-e324-4283-af98-66ec62167c47', { muted: true }) console.log(settings.mutedWorkspaces)Notes
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
nextmail.account.setPhoto()
Set your profile photo
setPhoto(data: RawBody, options?: AccountPhotoOptions): Promise<AccountPhotoResource>Sends the image bytes as the request body, replacing the person's profile photo, as Account, Profile does. 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 and keeps the first frame of an animation.
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.
Parameters
dataRawBodyRequiredThe image: a
Blob,ArrayBufferorUint8Array.options.contentTypeContactPhotoTypeimage/png,image/jpeg,image/webporimage/gif. Required unlessdatais aBlobwith a type.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AccountPhotoResource with the new url.
Example
const file = Bun.file('me.jpg') const photo = await nextmail.account.setPhoto(await file.arrayBuffer(), { contentType: 'image/jpeg' }) console.log(photo.url)Notes
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.
Also available in
nextmail.account.removePhoto()
Remove your profile photo
removePhoto(options?: RequestScope): Promise<AccountPhotoResource>Removes the profile photo and deletes the stored image, so the app shows the person's initials again. Removing it when there is none changes nothing.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AccountPhotoResource with url null.
Example
await nextmail.account.removePhoto()Notes
Safe to replay, so the SDK retries it after a network failure.
Also available in
nextmail.account.getUsername()
Read your username
getUsername(options?: RequestScope): Promise<UsernameResource>Resolves the person's username, whether they chose it or it was made for them from their name, and the free address that comes with it, when there is one. A username the person chose never changes.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
UsernameResource with username, chosen and address.
Example
const { username, chosen, address } = await nextmail.account.getUsername() console.log(username, chosen ? 'chosen' : 'made for you', address)Notes
The first read makes a username for an account that has none.
Also available in
nextmail.account.checkUsername()
Check a username
checkUsername(username: string, options?: RequestScope): Promise<UsernameAvailabilityResource>Says whether the person could choose a username, without choosing it, and why not when they could not. The username is lowercased and its spaces become dots before it is checked, as the app does, and username in the answer is the form that was checked.
Parameters
usernamestringRequiredUp to 60 characters before it is tidied.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
UsernameAvailabilityResource with status, available and a message that says why.
Example
const check = await nextmail.account.checkUsername('ada.lovelace') if (!check.available) console.log(check.message)Notes
statusiscurrentfor the username the person already has, andavailableis false for it.
Also available in
nextmail.account.setUsername()
Choose your username
setUsername(username: string, options?: RequestScope): Promise<UsernameResource>Sets the person's username for good, and with it their free address. Once chosen it never changes: a second choice is refused with 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with checkUsername.
Parameters
usernamestringRequired3 to 30 lowercase letters, numbers and single dots once it is tidied.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
UsernameResource with chosen: true.
Example
const check = await nextmail.account.checkUsername('ada.lovelace') if (check.available) await nextmail.account.setUsername(check.username)Notes
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
Also available in
nextmail.account.listConnectedApps()
List your connected apps
listConnectedApps(options?: RequestScope): Promise<Array<ConnectedAppResource>>Resolves every app the person connected with OAuth, as Account, Connected apps lists them: the workspace and the permissions each may reach, until when, how many tokens it holds, and until when it may make changes that ask for a verification code without one. current marks the app making the call.
What an app may reach is changed in the app, never through an app.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Array<ConnectedAppResource>, each with clientId, name, kind, status, grant and tokenCount.
Example
const apps = await nextmail.account.listConnectedApps() for (const app of apps) console.log(app.name, app.status, app.current ? '(this app)' : '')Notes
A sign-in of the command line tool shows as
kind: 'cli', with its device incliDevice.
Also available in
nextmail.account.listConnectedAppRequests()
Read the request log of a connected app
listConnectedAppRequests(clientId: string, options?: ConnectedAppRequestListOptions): Promise<Page<ConnectedAppRequestResource>>Resolves one page of the REST calls an app the person connected made with the access they gave it, newest first, as Request log in the menu of the app under Account, Connected apps shows them. Each call has its method, path, status, how long it took and the error code of a refusal, and never a body, a query string or the address it came from. The command line tool signed in from a browser is in it too. Calls made under an earlier connection of the same app are not: connecting it again starts a new log. failedOnly, statuses, since and until narrow it, and they combine.
Parameters
clientIdstringRequiredThe app's
clientId, fromlistConnectedApps.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.statusesArray<number>Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.options.sinceDate | stringOnly calls at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberCalls per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorof the previous page, passed back unchanged. Leave it out for the first page.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Page<ConnectedAppRequestResource> with items, hasMore and nextCursor. Each item has id, clientId, workspaceId, requestId, method, path, status, errorCode, durationMs, userAgent and createdAt.
Example
const [app] = await nextmail.account.listConnectedApps()const page = await nextmail.account.listConnectedAppRequests(app.clientId, { failedOnly: true, limit: 50 }) for (const call of page.items) console.log(call.createdAt, call.method, call.path, call.status, call.errorCode ?? '')Notes
An app the person never connected is a 404
resource_not_found, and a cursor this log did not hand out is a 400invalid_cursor.Calls made with an API key are in the request log of that key,
keys.listRequests, not here.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- Python
account.list_connected_app_requests()- Ruby
account.list_connected_app_requests- PHP
account->listConnectedAppRequests- Go
Account.ListConnectedAppRequests- Java
account().listConnectedAppRequests- C#
Account.ListConnectedAppRequestsAsync- CLI
nextmail account list-connected-app-requests
nextmail.account.listAllConnectedAppRequests()
Collect the whole request log of a connected app into one array
listAllConnectedAppRequests(clientId: string, options?: ConnectedAppRequestListOptions): Promise<Array<ConnectedAppRequestResource>>Walks every page of listConnectedAppRequests under the same filters. The log is never pruned, so give it a window unless you mean to read a busy app's whole history, or use iterateConnectedAppRequests to stop early.
Parameters
clientIdstringRequiredThe app's
clientId, fromlistConnectedApps.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.statusesArray<number>Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.options.sinceDate | stringOnly calls at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest call.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
Array<ConnectedAppRequestResource>, newest first.
Example
const [app] = await nextmail.account.listConnectedApps()const today = await nextmail.account.listAllConnectedAppRequests(app.clientId, { since: new Date(Date.now() - 24 * 60 * 60 * 1000), limit: 100 }) console.log(today.length, 'calls today')Notes
If any page fails the promise rejects and the calls already fetched are discarded.
Also available in
nextmail.account.iterateConnectedAppRequests()
Stream the request log of a connected app one call at a time
iterateConnectedAppRequests(clientId: string, options?: ConnectedAppRequestListOptions): AsyncGenerator<ConnectedAppRequestResource, void, undefined>An async generator over listConnectedAppRequests under the same filters, fetching a page only when the one before is drained.
Parameters
clientIdstringRequiredThe app's
clientId, fromlistConnectedApps.options.failedOnlybooleanOnly calls answered with a status of 400 or more.
options.statusesArray<number>Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.options.sinceDate | stringOnly calls at or after this instant. A
Dateis sent as ISO 8601, and a string must already be one.options.untilDate | stringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.options.limitnumberPage size per request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest call.
options.signalAbortSignalCancels the request in flight and ends the iteration.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
AsyncGenerator<ConnectedAppRequestResource, void, undefined> yielding one call per step.
Example
const [app] = await nextmail.account.listConnectedApps() for await (const call of nextmail.account.iterateConnectedAppRequests(app.clientId, { failedOnly: true })) { console.log('last refused call', call.createdAt, call.path, call.errorCode) break}Notes
Breaking out of the loop stops the walk, and no further page is fetched.
Also available in
nextmail.account.revokeConnectedApp()
Remove a connected app
revokeConnectedApp(clientId: string, options?: RequestScope): Promise<RevokedConnectedAppResource>Deletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again, as removing it in Account, Connected apps does. Removing the app making the call disconnects it.
Parameters
clientIdstringRequiredThe app's
clientIdfromlistConnectedApps.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
RevokedConnectedAppResource with revoked: true and tokensRevoked.
Example
const apps = await nextmail.account.listConnectedApps() for (const app of apps.filter((one) => one.status === 'expired')) { await nextmail.account.revokeConnectedApp(app.clientId)}Notes
An app the person never connected is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the app is already gone.
Also available in
nextmail.account.listSessions()
List your signed-in devices
listSessions(options?: RequestScope): Promise<Array<SessionResource>>Resolves every browser and phone the person is signed in on, as Account, Security lists them, most recently used first: the browser and system, the country and city it was last used from, how it signed in and when.
No address is ever recorded, only the place. A key or an app is not a signed-in device, so current is always false here.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Array<SessionResource>, each with id, device, authMethod, country, city, createdAt, lastActiveAt and expiresAt.
Example
const sessions = await nextmail.account.listSessions() for (const session of sessions) console.log(session.device.browser ?? session.device.os, session.city, session.lastActiveAt)Notes
lastActiveAtis accurate to within ten minutes.authMethodis null for a device that signed in before it was recorded.
Also available in
nextmail.account.revokeSession()
Sign out one device
revokeSession(sessionId: string, options?: RequestScope): Promise<RevokedSessionResource>Signs one browser or phone out, as Sign out next to it in Account, Security does. Its next request is refused at once, and a phone stops getting notifications. It is written to the person's security log.
Parameters
sessionIdstringRequiredThe device's
idfromlistSessions.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
RevokedSessionResource with revoked: true.
Example
const sessions = await nextmail.account.listSessions()const stale = sessions.filter((session) => Date.parse(session.lastActiveAt) < Date.now() - 30 * 24 * 60 * 60 * 1000) for (const session of stale) await nextmail.account.revokeSession(session.id)Notes
A device that is not signed in to the account is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the device is already signed out.
Also available in
nextmail.account.revokeSessions()
Sign out everywhere
revokeSessions(options?: SessionSweepOptions): Promise<SessionSweepResource>Signs the person out of every browser and phone at once, for when a device is lost or a password may have leaked. Each one is refused on its next request.
With connectedApps: true every connected app is removed as well, except the app making the call. A key or an app is not a signed-in device, so the call never ends its own access.
Parameters
options.connectedAppsbooleanAlso removes every connected app, apart from the one making the call. Left out, apps stay.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
SessionSweepResource with sessionsRevoked and appsRevoked.
Example
const swept = await nextmail.account.revokeSessions({ connectedApps: true }) console.log(swept.sessionsRevoked, 'devices and', swept.appsRevoked, 'apps signed out')Notes
Safe to repeat: a second call finds nothing left and answers zero for both counts.
Also available in
nextmail.account.listSecurityEvents()
Read your security log
listSecurityEvents(options?: ListOptions): Promise<Page<SecurityEventResource>>Resolves one page of what happened to the sign-in of the account, newest first: each sign-in with its device and place, devices signed out, password changes and resets, two-factor turned on or off, and passkeys added or removed. Nothing is ever removed from it.
Parameters
options.limitnumberPage size, from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorof the previous page. Leave it out for the first page.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Page<SecurityEventResource> with items, hasMore and nextCursor. Each item has kind, at, device, country, city, authMethod and detail.
Example
const page = await nextmail.account.listSecurityEvents({ limit: 50 }) for (const event of page.items) console.log(event.at, event.kind, event.city ?? '')Notes
A sign-in from a device not seen before has
detail.newDevice: true, and the person is told by email.A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
nextmail.account.listAllSecurityEvents()
Collect your whole security log into one array
listAllSecurityEvents(options?: ListOptions): Promise<Array<SecurityEventResource>>Walks every page of listSecurityEvents. The log is never pruned, so use iterateSecurityEvents to stop early on an old account.
Parameters
options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest entry.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
Array<SecurityEventResource>, newest first.
Example
const events = await nextmail.account.listAllSecurityEvents({ limit: 100 })const signIns = events.filter((event) => event.kind === 'sign-in') console.log(signIns.length, 'sign-ins on record')Notes
If any page fails the promise rejects and the entries already fetched are discarded.
Also available in
nextmail.account.iterateSecurityEvents()
Stream your security log one entry at a time
iterateSecurityEvents(options?: ListOptions): AsyncGenerator<SecurityEventResource, void, undefined>An async generator over listSecurityEvents, fetching a page only when the one before is drained.
Parameters
options.limitnumberPage size for each request, 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk from this cursor instead of the newest entry.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
An async generator of SecurityEventResource, newest first.
Example
for await (const event of nextmail.account.iterateSecurityEvents()) { if (event.kind === 'password-changed') { console.log('Password last changed', event.at) break }}Notes
Breaking out of the loop stops the walk, and no further page is fetched.
Also available in
nextmail.account.listPasskeys()
List your passkeys
listPasskeys(options?: RequestScope): Promise<Array<PasskeyResource>>Resolves the passkeys that can sign in to the account, oldest first, each with its name, whether it is synced between the person's devices and when it was last used.
A passkey is added on the device that holds it, in Account, Security, never through the API.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Array<PasskeyResource>, each with id, name, synced, transports, createdAt and lastUsedAt.
Example
const passkeys = await nextmail.account.listPasskeys() for (const passkey of passkeys) console.log(passkey.name, passkey.lastUsedAt ?? 'never used')Notes
The key itself is never returned, only its name and when it was used.
Also available in
nextmail.account.renamePasskey()
Rename a passkey
renamePasskey(passkeyId: string, name: string, options?: RequestScope): Promise<PasskeyResource>Gives a passkey a name the person will recognise, such as the device that holds it.
Parameters
passkeyIdstringRequiredThe passkey's
idfromlistPasskeys.namestringRequiredThe new name, 1 to 60 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
PasskeyResource with its new name.
Example
const [passkey] = await nextmail.account.listPasskeys() if (passkey) await nextmail.account.renamePasskey(passkey.id, 'Work laptop')Notes
A passkey that is not on the account is a 404
resource_not_found.A name that is empty or longer than 60 characters is a 422
invalid_parameter.
Also available in
nextmail.account.removePasskey()
Remove a passkey
removePasskey(passkeyId: string, options?: RequestScope): Promise<RemovedPasskeyResource>Removes a passkey, so it can no longer sign in or confirm a change. The person is told by email, and it is written to their security log. The passkey stays on the device until they delete it there.
Parameters
passkeyIdstringRequiredThe passkey's
idfromlistPasskeys.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
RemovedPasskeyResource with removed: true.
Example
const passkeys = await nextmail.account.listPasskeys()const unused = passkeys.filter((passkey) => passkey.lastUsedAt === null) for (const passkey of unused) await nextmail.account.removePasskey(passkey.id)Notes
A passkey that is not on the account is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the passkey is already gone.
Also available in
nextmail.account.listInvitations()
List your invitations
listInvitations(options?: RequestScope): Promise<Array<ReceivedInvitationResource>>Resolves the invitations to join a workspace that are waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out. The invitations a workspace sent are members.listInvitations instead.
Parameters
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Array<ReceivedInvitationResource>, each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Example
const invitations = await nextmail.account.listInvitations() for (const invitation of invitations) console.log(invitation.workspaceName, invitation.roleName)Notes
addressescounts the addresses and the whole domains the invitation gives together.
Also available in
nextmail.account.acceptInvitation()
Accept an invitation
acceptInvitation(invitationId: string, options?: InvitationAcceptOptions): Promise<AcceptedInvitationResource>Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. options.activate also makes it the workspace the app opens for the person.
A workspace that asks everyone in it to sign in with two-factor authentication is refused with 403 two_factor_required until the person turns it on. An invitation that expired, was withdrawn or went to another address is a 422, and one that is not waiting any more a 404 invitation_not_found.
Parameters
invitationIdstringRequiredAn invitation id from
listInvitations.options.activatebooleanTrue to make it the workspace the app opens. Defaults to false.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
AcceptedInvitationResource with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Example
const [first] = await nextmail.account.listInvitations() if (first) { const joined = await nextmail.account.acceptInvitation(first.id, { activate: true }) console.log(joined.workspaceName)}Notes
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
Also available in
nextmail.account.declineInvitation()
Decline an invitation
declineInvitation(invitationId: string, options?: RequestScope): Promise<DeclinedInvitationResource>Turns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation the person already accepted is refused with 409 invitation_accepted.
Parameters
invitationIdstringRequiredAn invitation id from
listInvitations.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
DeclinedInvitationResource with declined: true.
Example
await nextmail.account.declineInvitation('winv_6bb640f5b99e47deb758f1f5')Notes
Retried automatically on network failure, since declining twice changes nothing.
Google Workspace
Fastmail