openemail.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 and the invitations waiting for them. An API key acts for the workspace owner, and an app for the person who connected it.
account.getNotifications()
Read your notification settings
getNotifications(options?: RequestScope): Promise<NotificationSettingsResource>Resolves which kinds of email OpenEmail 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 openemail.account.getNotifications() for (const kind of settings.email) console.log(kind.label, kind.enabled)Notes
accountandbillingemail are always on, andrequiredsays so.
Also available in
account.setEmailNotification()
Turn a kind of email on or off
setEmailNotification(category: EmailNotificationCategory, body: EmailNotificationSet, options?: RequestScope): Promise<NotificationSettingsResource>enabled: false stops OpenEmail 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 openemail.account.setEmailNotification('product', { enabled: false })Notes
Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
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 openemail.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
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 openemail.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
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 openemail.account.removePhoto()Notes
Safe to replay, so the SDK retries it after a network failure.
Also available in
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 it gives them when this deployment offers 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 openemail.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
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 openemail.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
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 openemail.account.checkUsername('ada.lovelace') if (check.available) await openemail.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
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 openemail.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
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 openemail.account.listConnectedApps() for (const app of apps.filter((one) => one.status === 'expired')) { await openemail.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
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 openemail.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
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 openemail.account.listInvitations() if (first) { const joined = await openemail.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
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 openemail.account.declineInvitation('winv_6bb640f5b99e47deb758f1f5')Notes
Retried automatically on network failure, since declining twice changes nothing.