client.Account
Çdo metodë në këtë hapësirë emrash: nënshkrimi, parametrat, çfarë kthen dhe një shembull.
Metodat
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
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.
Parametrat
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
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.
Shembull
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");Shënime
accountandbillingemail are always on, andrequiredsays so.
E disponueshme edhe në
Account.SetEmailNotificationAsync
Turn a kind of email on or off
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.
Parametrat
categorystringE detyrueshmeaccount,billing,activityorproduct, also inOpenEmail\Constants\EmailNotificationCategories.enabledboolE detyrueshmeTrue to receive that email, false to stop it.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
The same object as Account.GetNotificationsAsync, as it is after the change.
Shembull
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")}");}Shënime
Retried automatically on network failure, since the same setting sent twice changes nothing.
E disponueshme edhe në
Account.SetPushMutedAsync
Mute a workspace on your phone
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.
Parametrat
workspaceIdstringE detyrueshmeA workspace id from
Workspaces.ListAsync.mutedboolE detyrueshmeTrue to mute it, false to let it notify again.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
The same object as Account.GetNotificationsAsync, with the new mutedWorkspaces.
Shembull
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() ?? [])}");Shënime
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.
E disponueshme edhe në
Account.SetPhotoAsync
Set your profile photo
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.
Parametrat
dataStreamE detyrueshmeThe image: a readable
Stream.contentTypestring?image/png,image/jpeg,image/webporimage/gif. Required, because aStreamcarries no type of its own.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with the new url.
Shembull
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"]}");Shënime
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.
E disponueshme edhe në
Account.RemovePhotoAsync
Remove your profile photo
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.
Parametrat
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with url null.
Shembull
var photo = await client.Account.RemovePhotoAsync(); Console.WriteLine($"{photo["url"]?.ToString() ?? "No photo, the app shows initials"}");Shënime
Safe to replay, so the SDK retries it after a network failure.
E disponueshme edhe në
Account.GetUsernameAsync
Read your username
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.
Parametrat
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with username, chosen and address.
Shembull
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"]}");}Shënime
The first read makes a username for an account that has none.
E disponueshme edhe në
Account.CheckUsernameAsync
Check a username
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.
Parametrat
usernamestringE detyrueshmeUp to 60 characters before it is tidied.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with username, status, available and a message that says why.
Shembull
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"]}");}Shënime
statusiscurrentfor the username the person already has, andavailableis false for it.
E disponueshme edhe në
Account.SetUsernameAsync
Choose your username
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.
Parametrat
usernamestringE detyrueshme3 to 30 lowercase letters, numbers and single dots once it is tidied.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with username, chosen set to true and address.
Shembull
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")}");}Shënime
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
E disponueshme edhe në
Account.ListConnectedAppsAsync
List your connected apps
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.
Parametrat
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A list of JsonObject items, each with clientId, name, kind, status, current, grant, tokenCount and elevatedUntil.
Shembull
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"}");}Shënime
A sign-in of the command line tool shows with
kindset tocli, and its device incliDevice.
E disponueshme edhe në
Account.RevokeConnectedAppAsync
Remove a connected app
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.
Parametrat
clientIdstringE detyrueshmeThe app's
clientIdfromAccount.ListConnectedAppsAsync.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with clientId, revoked set to true and tokensRevoked.
Shembull
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"); }}Shënime
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.
E disponueshme edhe në
Account.ListInvitationsAsync
List your invitations
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.
Parametrat
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A list of JsonObject items, each with id, workspaceId, workspaceName, roleName, inviterName, addresses, expiresAt and createdAt.
Shembull
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"]}");}Shënime
addressescounts the addresses and the whole domains the invitation gives together.
E disponueshme edhe në
Account.AcceptInvitationAsync
Accept an invitation
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.
Parametrat
invitationIdstringE detyrueshmeAn 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.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Shembull
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);}Shënime
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
E disponueshme edhe në
Account.DeclineInvitationAsync
Decline an invitation
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.
Parametrat
invitationIdstringE detyrueshmeAn invitation id from
Account.ListInvitationsAsync.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Kthen
A JsonObject with the invitation id and declined set to true.
Shembull
var declined = await client.Account.DeclineInvitationAsync("winv_6bb640f5b99e47deb758f1f5"); if ((bool?)declined["declined"] == true){ Console.WriteLine("Declined, and the sender has been told");}Shënime
Retried automatically on network failure, since declining twice changes nothing.