client.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.GetNotificationsAsync`

Read your notification settings

account:read

Signature

Task<JsonObject> GetNotificationsAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns 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

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

Returns

A JsonObject with email, a list with one object for each kind of email (category, label, description, required and enabled), and mutedWorkspaces, a list of workspace ids.

Example

var settings = await client.Account.GetNotificationsAsync(); foreach (var setting in settings["email"]?.AsArray() ?? []){    Console.WriteLine($"{setting?["category"]}: {((bool?)setting?["enabled"] == true ? "on" : "off")}{((bool?)setting?["required"] == true ? ", always on" : "")}");} Console.WriteLine($"{settings["mutedWorkspaces"]?.AsArray().Count} workspaces muted on the phone");

Notes

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

Also available in

API: GET /account/notifications
TypeScript: account.getNotifications()
Python: account.get_notifications()
Ruby: account.get_notifications
PHP: account->getNotifications
Go: Account.GetNotifications
Java: account().getNotifications
CLI: openemail account get-notifications

`Account.SetEmailNotificationAsync`

Turn a kind of email on or off

account:write

Signature

Task<JsonObject> SetEmailNotificationAsync(    string category,    IReadOnlyDictionary<string, object?> body,    string? apiKey = null,    CancellationToken cancellationToken = default)

["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

categorystringRequired: account, billing, activity or product, also in OpenEmail\Constants\EmailNotificationCategories.
enabledboolRequired: True to receive that email, false to stop it.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

The same object as Account.GetNotificationsAsync, as it is after the change.

Example

using OpenEmail.Constants; var settings = await client.Account.SetEmailNotificationAsync(EmailNotificationCategories.Product, new Body { ["enabled"] = false }); foreach (var setting in settings["email"]?.AsArray() ?? []){    Console.WriteLine($"{setting?["label"]}: {((bool?)setting?["enabled"] == true ? "on" : "off")}");}

Notes

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

Also available in

API: PUT /account/notifications/email/{category}
TypeScript: account.setEmailNotification()
Python: account.set_email_notification()
Ruby: account.set_email_notification
PHP: account->setEmailNotification
Go: Account.SetEmailNotification
Java: account().setEmailNotification
CLI: openemail account set-email-notification

`Account.SetPushMutedAsync`

Mute a workspace on your phone

account:write

Signature

Task<JsonObject> SetPushMutedAsync(    string workspaceId,    IReadOnlyDictionary<string, object?> body,    string? apiKey = null,    CancellationToken cancellationToken = default)

["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

workspaceIdstringRequired: A workspace id from Workspaces.ListAsync.
mutedboolRequired: True to mute it, false to let it notify again.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

The same object as Account.GetNotificationsAsync, with the new mutedWorkspaces.

Example

var settings = await client.Account.SetPushMutedAsync("10417196-e324-4283-af98-66ec62167c47", new Body { ["muted"] = true }); Console.WriteLine($"Muted on the phone: {string.Join(", ", settings["mutedWorkspaces"]?.AsArray() ?? [])}");

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

API: PUT /account/notifications/push/{workspaceId}
TypeScript: account.setPushMuted()
Python: account.set_push_muted()
Ruby: account.set_push_muted
PHP: account->setPushMuted
Go: Account.SetPushMuted
Java: account().setPushMuted
CLI: openemail account set-push-muted

`Account.SetPhotoAsync`

Set your profile photo

account:write

Signature

Task<JsonObject> SetPhotoAsync(    Stream data,    string? contentType = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 readable Stream. The type is read from contentType:. Without it the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.

Parameters

dataStreamRequired: The image: a readable Stream.
contentTypestring?: image/png, image/jpeg, image/webp or image/gif. Required, because a Stream carries no type of its own.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with the new url.

Example

await using var photoFile = File.OpenRead("photo.jpg"); var photo = await client.Account.SetPhotoAsync(photoFile, contentType: "image/jpeg"); Console.WriteLine($"New photo at {photo["url"]}"); await using var avatar = File.OpenRead("avatar.png"); photo = await client.Account.SetPhotoAsync(avatar); Console.WriteLine($"Replaced by {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

API: PUT /account/photo
TypeScript: account.setPhoto()
Python: account.set_photo()
Ruby: account.set_photo
PHP: account->setPhoto
Go: Account.SetPhoto
Java: account().setPhoto
CLI: openemail account set-photo

`Account.RemovePhotoAsync`

Remove your profile photo

account:write

Signature

Task<JsonObject> RemovePhotoAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

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

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

Returns

A JsonObject with url null.

Example

var photo = await client.Account.RemovePhotoAsync(); Console.WriteLine($"{photo["url"]?.ToString() ?? "No photo, the app shows initials"}");

Notes

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

Also available in

API: DELETE /account/photo
TypeScript: account.removePhoto()
Python: account.remove_photo()
Ruby: account.remove_photo
PHP: account->removePhoto
Go: Account.RemovePhoto
Java: account().removePhoto
CLI: openemail account remove-photo

`Account.GetUsernameAsync`

Read your username

account:read

Signature

Task<JsonObject> GetUsernameAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns 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

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

Returns

A JsonObject with username, chosen and address.

Example

var username = await client.Account.GetUsernameAsync(); Console.WriteLine($"{username["username"]}{((bool?)username["chosen"] == true ? ", chosen" : ", made from the name")}"); if (username["address"] is not null){    Console.WriteLine($"Free address: {username["address"]}");}

Notes

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

Also available in

API: GET /account/username
TypeScript: account.getUsername()
Python: account.get_username()
Ruby: account.get_username
PHP: account->getUsername
Go: Account.GetUsername
Java: account().getUsername
CLI: openemail account get-username

`Account.CheckUsernameAsync`

Check a username

account:read

Signature

Task<JsonObject> CheckUsernameAsync(    string username,    string? apiKey = null,    CancellationToken cancellationToken = default)

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

usernamestringRequired: Up to 60 characters before it is tidied.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with username, status, available and a message that says why.

Example

using OpenEmail.Constants; var check = await client.Account.CheckUsernameAsync("Ada Lovelace"); if ((bool?)check["available"] == true){    Console.WriteLine($"{check["username"]} is free");}else if ((string?)check["status"] == UsernameStatuses.Current){    Console.WriteLine("That is already your username");}else{    Console.WriteLine($"{check["message"]}");}

Notes

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

Also available in

API: GET /account/username/availability
TypeScript: account.checkUsername()
Python: account.check_username()
Ruby: account.check_username
PHP: account->checkUsername
Go: Account.CheckUsername
Java: account().checkUsername
CLI: openemail account check-username

`Account.SetUsernameAsync`

Choose your username

account:write

Signature

Task<JsonObject> SetUsernameAsync(    string username,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 Account.CheckUsernameAsync.

Parameters

usernamestringRequired: 3 to 30 lowercase letters, numbers and single dots once it is tidied.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with username, chosen set to true and address.

Example

try{    var username = await client.Account.SetUsernameAsync("ada.lovelace");     Console.WriteLine($"You are {username["username"]}, with the address {username["address"]?.ToString() ?? "none"}");}catch (OpenEmailApiException error) when (error.IsConflict){    Console.WriteLine($"{(error.Code == "username_locked" ? "Your username is already chosen" : "That username is taken")}");}

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

API: PUT /account/username
TypeScript: account.setUsername()
Python: account.set_username()
Ruby: account.set_username
PHP: account->setUsername
Go: Account.SetUsername
Java: account().setUsername
CLI: openemail account set-username

`Account.ListConnectedAppsAsync`

List your connected apps

account:read

Signature

Task<IReadOnlyList<JsonObject>> ListConnectedAppsAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns 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

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

Returns

A list of JsonObject items, each with clientId, name, kind, status, current, grant, tokenCount and elevatedUntil.

Example

foreach (var app in (await client.Account.ListConnectedAppsAsync())){    Console.WriteLine($"{app["name"]}{((bool?)app["current"] == true ? " (this app)" : "")}: {app["status"]}, {app["tokenCount"]} tokens");    Console.WriteLine($"  reaches {app["grant"]?["workspaceName"]?.ToString() ?? "nothing"} until {app["accessUntil"]?.ToString() ?? "it is removed"}");}

Notes

A sign-in of the command line tool shows with kind set to cli, and its device in cliDevice.

Also available in

API: GET /account/connected-apps
TypeScript: account.listConnectedApps()
Python: account.list_connected_apps()
Ruby: account.list_connected_apps
PHP: account->listConnectedApps
Go: Account.ListConnectedApps
Java: account().listConnectedApps
CLI: openemail account list-connected-apps

`Account.RevokeConnectedAppAsync`

Remove a connected app

account:write

Signature

Task<JsonObject> RevokeConnectedAppAsync(    string clientId,    string? apiKey = null,    CancellationToken cancellationToken = default)

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

clientIdstringRequired: The app's clientId from Account.ListConnectedAppsAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with clientId, revoked set to true and tokensRevoked.

Example

foreach (var app in (await client.Account.ListConnectedAppsAsync())){    if ((int?)app["tokenCount"] == 0 && (bool?)app["current"] != true)    {        var revoked = await client.Account.RevokeConnectedAppAsync(app["clientId"]!.GetValue<string>());         Console.WriteLine($"Removed {app["name"]}, {revoked["tokensRevoked"]} tokens revoked");    }}

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

API: DELETE /account/connected-apps/{clientId}
TypeScript: account.revokeConnectedApp()
Python: account.revoke_connected_app()
Ruby: account.revoke_connected_app
PHP: account->revokeConnectedApp
Go: Account.RevokeConnectedApp
Java: account().revokeConnectedApp
CLI: openemail account revoke-connected-app

`Account.ListInvitationsAsync`

List your invitations

account:read

Signature

Task<IReadOnlyList<JsonObject>> ListInvitationsAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns 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.ListInvitationsAsync instead.

Parameters

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

Returns

A list of JsonObject items, each with id, workspaceId, workspaceName, roleName, inviterName, addresses, expiresAt and createdAt.

Example

foreach (var invitation in (await client.Account.ListInvitationsAsync())){    Console.WriteLine($"{invitation["inviterName"]} invited you to {invitation["workspaceName"]} as {invitation["roleName"]}");    Console.WriteLine($"  {invitation["addresses"]} addresses, answer by {invitation["expiresAt"]}");}

Notes

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

Also available in

API: GET /account/invitations
TypeScript: account.listInvitations()
Python: account.list_invitations()
Ruby: account.list_invitations
PHP: account->listInvitations
Go: Account.ListInvitations
Java: account().listInvitations
CLI: openemail account list-invitations

`Account.AcceptInvitationAsync`

Accept an invitation

account:write

Signature

Task<JsonObject> AcceptInvitationAsync(    string invitationId,    bool? activate = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Joins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. 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

invitationIdstringRequired: An invitation id from Account.ListInvitationsAsync.
activatebool?: True to make it the workspace the app opens. Defaults to false.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.

Example

try{    var joined = await client.Account.AcceptInvitationAsync("winv_6bb640f5b99e47deb758f1f5", activate: true);     Console.WriteLine($"Joined {joined["workspaceName"]} with {joined["addressesGranted"]} addresses and {joined["domainsGranted"]} domains");}catch (OpenEmailApiException error) when (error.IsPermission){    Console.WriteLine(error.Code == "two_factor_required" ? "Turn on two-factor sign-in first" : error.Message);}

Notes

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

Also available in

API: POST /account/invitations/{invitationId}/accept
TypeScript: account.acceptInvitation()
Python: account.accept_invitation()
Ruby: account.accept_invitation
PHP: account->acceptInvitation
Go: Account.AcceptInvitation
Java: account().acceptInvitation
CLI: openemail account accept-invitation

`Account.DeclineInvitationAsync`

Decline an invitation

account:write

Signature

Task<JsonObject> DeclineInvitationAsync(    string invitationId,    string? apiKey = null,    CancellationToken cancellationToken = default)

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

invitationIdstringRequired: An invitation id from Account.ListInvitationsAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Returns

A JsonObject with the invitation id and declined set to true.

Example

var declined = await client.Account.DeclineInvitationAsync("winv_6bb640f5b99e47deb758f1f5"); if ((bool?)declined["declined"] == true){    Console.WriteLine("Declined, and the sender has been told");}

Notes

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

Also available in

API: POST /account/invitations/{invitationId}/decline
TypeScript: account.declineInvitation()
Python: account.decline_invitation()
Ruby: account.decline_invitation
PHP: account->declineInvitation
Go: Account.DeclineInvitation
Java: account().declineInvitation
CLI: openemail account decline-invitation

client.Account

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.