SDK

openemail.account

كل دالّة في مساحة الأسماء هذه: توقيعها ومعلماتها وما تُرجعه ومثال عليها.

الدوالّ

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

account:read

التوقيع

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.

المعلمات

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

يُرجع

NotificationSettingsResource with email, one EmailNotificationSetting for each kind of email, and mutedWorkspaces.

مثال

const settings = await openemail.account.getNotifications() for (const kind of settings.email) console.log(kind.label, kind.enabled)

ملاحظات

account and billing email are always on, and required says so.

متاح أيضًا في

API: GET /account/notifications
CLI: openemail account get-notifications

`account.setEmailNotification()`

Turn a kind of email on or off

account:write

التوقيع

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.

المعلمات

categoryEmailNotificationCategoryمطلوب: account, billing, activity or product.
body.enabledbooleanمطلوب: True to receive that email, false to stop it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

NotificationSettingsResource as it is after the change.

مثال

await openemail.account.setEmailNotification('product', { enabled: false })

ملاحظات

Retried automatically on network failure, since the same setting sent twice changes nothing.

متاح أيضًا في

API: PUT /account/notifications/email/{category}
CLI: openemail account set-email-notification

`account.setPushMuted()`

Mute a workspace on your phone

account:write

التوقيع

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.

المعلمات

workspaceIdstringمطلوب: A workspace id from workspaces.list.
body.mutedbooleanمطلوب: True to mute it, false to let it notify again.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

NotificationSettingsResource with the new mutedWorkspaces.

مثال

const settings = await openemail.account.setPushMuted('10417196-e324-4283-af98-66ec62167c47', { muted: true }) console.log(settings.mutedWorkspaces)

ملاحظات

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.

متاح أيضًا في

API: PUT /account/notifications/push/{workspaceId}
CLI: openemail account set-push-muted

`account.setPhoto()`

Set your profile photo

account:write

التوقيع

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.

المعلمات

dataRawBodyمطلوب: 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.

يُرجع

AccountPhotoResource with the new url.

مثال

const file = Bun.file('me.jpg') const photo = await openemail.account.setPhoto(await file.arrayBuffer(), { contentType: 'image/jpeg' }) console.log(photo.url)

ملاحظات

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.

متاح أيضًا في

API: PUT /account/photo
CLI: openemail account set-photo

`account.removePhoto()`

Remove your profile photo

account:write

التوقيع

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.

المعلمات

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

يُرجع

AccountPhotoResource with url null.

مثال

await openemail.account.removePhoto()

ملاحظات

Safe to replay, so the SDK retries it after a network failure.

متاح أيضًا في

API: DELETE /account/photo
CLI: openemail account remove-photo

`account.getUsername()`

Read your username

account:read

التوقيع

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.

المعلمات

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

يُرجع

UsernameResource with username, chosen and address.

مثال

const { username, chosen, address } = await openemail.account.getUsername() console.log(username, chosen ? 'chosen' : 'made for you', address)

ملاحظات

The first read makes a username for an account that has none.

متاح أيضًا في

API: GET /account/username
CLI: openemail account get-username

`account.checkUsername()`

Check a username

account:read

التوقيع

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.

المعلمات

usernamestringمطلوب: Up to 60 characters before it is tidied.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

UsernameAvailabilityResource with status, available and a message that says why.

مثال

const check = await openemail.account.checkUsername('ada.lovelace') if (!check.available) console.log(check.message)

ملاحظات

status is current for the username the person already has, and available is false for it.

متاح أيضًا في

API: GET /account/username/availability
CLI: openemail account check-username

`account.setUsername()`

Choose your username

account:write

التوقيع

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.

المعلمات

usernamestringمطلوب: 3 to 30 lowercase letters, numbers and single dots once it is tidied.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

UsernameResource with chosen: true.

مثال

const check = await openemail.account.checkUsername('ada.lovelace') if (check.available) await openemail.account.setUsername(check.username)

ملاحظات

Not retried automatically: a retry after a lost response would be refused with username_locked, because the first call already chose it.

متاح أيضًا في

API: PUT /account/username
CLI: openemail account set-username

`account.listConnectedApps()`

List your connected apps

account:read

التوقيع

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.

المعلمات

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

يُرجع

Array<ConnectedAppResource>, each with clientId, name, kind, status, grant and tokenCount.

مثال

const apps = await openemail.account.listConnectedApps() for (const app of apps) console.log(app.name, app.status, app.current ? '(this app)' : '')

ملاحظات

A sign-in of the command line tool shows as kind: 'cli', with its device in cliDevice.

متاح أيضًا في

API: GET /account/connected-apps
CLI: openemail account list-connected-apps

`account.revokeConnectedApp()`

Remove a connected app

account:write

التوقيع

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.

المعلمات

clientIdstringمطلوب: The app's clientId from listConnectedApps.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

RevokedConnectedAppResource with revoked: true and tokensRevoked.

مثال

const apps = await openemail.account.listConnectedApps() for (const app of apps.filter((one) => one.status === 'expired')) {    await openemail.account.revokeConnectedApp(app.clientId)}

ملاحظات

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.

متاح أيضًا في

API: DELETE /account/connected-apps/{clientId}
CLI: openemail account revoke-connected-app

`account.listInvitations()`

List your invitations

account:read

التوقيع

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.

المعلمات

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

يُرجع

Array<ReceivedInvitationResource>, each with id, workspaceName, roleName, inviterName, addresses and expiresAt.

مثال

const invitations = await openemail.account.listInvitations() for (const invitation of invitations) console.log(invitation.workspaceName, invitation.roleName)

ملاحظات

addresses counts the addresses and the whole domains the invitation gives together.

متاح أيضًا في

API: GET /account/invitations
CLI: openemail account list-invitations

`account.acceptInvitation()`

Accept an invitation

account:write

التوقيع

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.

المعلمات

invitationIdstringمطلوب: An invitation id from listInvitations.
options.activateboolean: True to make it the workspace the app opens. Defaults to false.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

AcceptedInvitationResource with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.

مثال

const [first] = await openemail.account.listInvitations() if (first) {    const joined = await openemail.account.acceptInvitation(first.id, { activate: true })     console.log(joined.workspaceName)}

ملاحظات

Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.

متاح أيضًا في

API: POST /account/invitations/{invitationId}/accept
CLI: openemail account accept-invitation

`account.declineInvitation()`

Decline an invitation

account:write

التوقيع

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.

المعلمات

invitationIdstringمطلوب: An invitation id from listInvitations.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

يُرجع

DeclinedInvitationResource with declined: true.

مثال

await openemail.account.declineInvitation('winv_6bb640f5b99e47deb758f1f5')

ملاحظات

Retried automatically on network failure, since declining twice changes nothing.

متاح أيضًا في

API: POST /account/invitations/{invitationId}/decline
CLI: openemail account decline-invitation

openemail.account

الدوالّ

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

المعلمات

يُرجع

مثال

ملاحظات

متاح أيضًا في

صندوق بريدك،بشروطك أنت.

صندوق بريدك،
بشروطك أنت.