client.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
Map<String, Object> getNotifications(RequestOptions options)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.
المعلمات
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with email, a list with one map for each kind of email (category, label, description, required and enabled), and mutedWorkspaces, a list of workspace ids.
مثال
Map<String, Object> settings = client.account().getNotifications(); System.out.println(settings.get("email"));ملاحظات
accountandbillingemail are always on, andrequiredsays so.
متاح أيضًا في
account().setEmailNotification
Turn a kind of email on or off
Map<String, Object> setEmailNotification(String category, Map<String, Object> body, RequestOptions options)"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.
المعلمات
categoryStringمطلوبaccount,billing,activityorproduct, also inuk.openemail.constants.EmailNotificationCategories.body.enabledbooleanمطلوبTrue to receive that email, false to stop it.
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
The same map as account().getNotifications, as it is after the change.
مثال
Map<String, Object> result = client.account().setEmailNotification("product", Body.of("enabled", false)); System.out.println(result.get("object"));ملاحظات
Retried automatically on network failure, since the same setting sent twice changes nothing.
متاح أيضًا في
account().setPushMuted
Mute a workspace on your phone
Map<String, Object> setPushMuted(String workspaceId, Map<String, Object> body, RequestOptions options)"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.apiKeyStringOverrides the client's API key for this call only.
يُرجع
The same map as account().getNotifications, with the new mutedWorkspaces.
مثال
Map<String, Object> settings = client.account().setPushMuted("10417196-e324-4283-af98-66ec62167c47", Body.of("muted", true)); System.out.println(settings.get("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.
متاح أيضًا في
account().setPhoto
Set your profile photo
Map<String, Object> setPhoto(byte[] data, RequestOptions options)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 byte array. The type is read from contentType. Without any of these the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
المعلمات
databyte[]مطلوبThe image as a byte array.
options.contentTypeStringimage/png,image/jpeg,image/webporimage/gif. Required, since a byte array carries no type of its own.options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with the new url.
مثال
Map<String, Object> photo = client.account().setPhoto(Files.readAllBytes(Path.of("me.jpg")), RequestOptions.of("contentType", "image/jpeg")); System.out.println(photo.get("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.
متاح أيضًا في
account().removePhoto
Remove your profile photo
Map<String, Object> removePhoto(RequestOptions options)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.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with url null.
مثال
Map<String, Object> result = client.account().removePhoto(); System.out.println(result.get("url"));ملاحظات
Safe to replay, so the SDK retries it after a network failure.
متاح أيضًا في
account().getUsername
Read your username
Map<String, Object> getUsername(RequestOptions options)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.
المعلمات
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with username, chosen and address.
مثال
Map<String, Object> result = client.account().getUsername(); System.out.println(result.get("address"));ملاحظات
The first read makes a username for an account that has none.
متاح أيضًا في
account().checkUsername
Check a username
Map<String, Object> checkUsername(String username, RequestOptions options)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.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with username, status, available and a message that says why.
مثال
Map<String, Object> check = client.account().checkUsername("ada.lovelace"); System.out.println(check.get("available") + " " + check.get("message"));ملاحظات
statusiscurrentfor the username the person already has, andavailableis false for it.
متاح أيضًا في
account().setUsername
Choose your username
Map<String, Object> setUsername(String username, RequestOptions options)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().checkUsername.
المعلمات
usernameStringمطلوب3 to 30 lowercase letters, numbers and single dots once it is tidied.
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with username, chosen set to true and address.
مثال
Map<String, Object> check = client.account().checkUsername("ada.lovelace"); if (Boolean.FALSE.equals(check.get("taken"))) { System.out.println(check.get("username") + " is free");} Map<String, Object> username = client.account().setUsername("ada.lovelace"); System.out.println(username.get("username"));ملاحظات
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
متاح أيضًا في
account().listConnectedApps
List your connected apps
List<Map<String, Object>> listConnectedApps(RequestOptions options)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.
المعلمات
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A list of maps, each with clientId, name, kind, status, current, grant, tokenCount and elevatedUntil.
مثال
List<Map<String, Object>> apps = client.account().listConnectedApps(); for (Map<String, Object> connectedApp : apps) { System.out.println(connectedApp.get("name") + " " + connectedApp.get("status"));}ملاحظات
A sign-in of the command line tool shows with
kindset tocli, and its device incliDevice.
متاح أيضًا في
account().revokeConnectedApp
Remove a connected app
Map<String, Object> revokeConnectedApp(String clientId, RequestOptions options)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
clientIdfromaccount().listConnectedApps.options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with clientId, revoked set to true and tokensRevoked.
مثال
for (Map<String, Object> app : client.account().listConnectedApps()) { Map<String, Object> revoked = client.account().revokeConnectedApp((String) app.get("clientId")); System.out.println(revoked.get("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.
متاح أيضًا في
account().listInvitations
List your invitations
List<Map<String, Object>> listInvitations(RequestOptions options)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().listInvitations instead.
المعلمات
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A list of maps, each with id, workspaceId, workspaceName, roleName, inviterName, addresses, expiresAt and createdAt.
مثال
List<Map<String, Object>> invitations = client.account().listInvitations(); for (Map<String, Object> invitation : invitations) { System.out.println(invitation.get("workspaceName") + " " + invitation.get("roleName"));}ملاحظات
addressescounts the addresses and the whole domains the invitation gives together.
متاح أيضًا في
account().acceptInvitation
Accept an invitation
Map<String, Object> acceptInvitation(String invitationId, RequestOptions options)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.
المعلمات
invitationIdStringمطلوبAn invitation id from
account().listInvitations.options.activatebooleanTrue to make it the workspace the app opens. Defaults to false.
options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
مثال
List<Map<String, Object>> items = client.account().listInvitations(); Map<String, Object> joined = client.account().acceptInvitation((String) items.get(0).get("id"), RequestOptions.of("activate", true)); System.out.println(joined.get("workspaceName"));ملاحظات
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
متاح أيضًا في
account().declineInvitation
Decline an invitation
Map<String, Object> declineInvitation(String invitationId, RequestOptions options)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
account().listInvitations.options.apiKeyStringOverrides the client's API key for this call only.
يُرجع
A map with the invitation id and declined set to true.
مثال
Map<String, Object> result = client.account().declineInvitation("winv_6bb640f5b99e47deb758f1f5"); System.out.println(result.get("id"));ملاحظات
Retried automatically on network failure, since declining twice changes nothing.