---
title: "client.account()"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://openemail.uk/docs/java/reference/account"
area: "Java"
category: "Reference"
---

# 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().getNotifications`

Read your notification settings

```java
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.

Scopes: `account:read`.

**Parameters**

- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

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.

**Example**

```java
Map<String, Object> settings = client.account().getNotifications();

System.out.println(settings.get("email"));
```

**Notes**

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

Also available in: API [`GET /account/notifications`](https://openemail.uk/docs/api/reference/your-account#get-account-notifications); TypeScript [`account.getNotifications()`](https://openemail.uk/docs/sdk/reference/account#getNotifications); Python [`account.get_notifications()`](https://openemail.uk/docs/python/reference/account#getNotifications); Ruby [`account.get_notifications`](https://openemail.uk/docs/ruby/reference/account#getNotifications); PHP [`account->getNotifications`](https://openemail.uk/docs/php/reference/account#getNotifications); Go [`Account.GetNotifications`](https://openemail.uk/docs/go/reference/account#getNotifications); C# [`Account.GetNotificationsAsync`](https://openemail.uk/docs/csharp/reference/account#getNotifications); CLI [`openemail account get-notifications`](https://openemail.uk/docs/cli/reference/account#account-get-notifications).

### `account().setEmailNotification`

Turn a kind of email on or off

```java
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`.

Scopes: `account:write`.

**Parameters**

- `category` (`String`, required): `account`, `billing`, `activity` or `product`, also in `uk.openemail.constants.EmailNotificationCategories`.
- `body.enabled` (`boolean`, required): True to receive that email, false to stop it.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

The same map as `account().getNotifications`, as it is after the change.

**Example**

```java
Map<String, Object> result = client.account().setEmailNotification("product", Body.of("enabled", false));

System.out.println(result.get("object"));
```

**Notes**

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

Also available in: API [`PUT /account/notifications/email/{category}`](https://openemail.uk/docs/api/reference/your-account#put-account-notifications-email-category); TypeScript [`account.setEmailNotification()`](https://openemail.uk/docs/sdk/reference/account#setEmailNotification); Python [`account.set_email_notification()`](https://openemail.uk/docs/python/reference/account#setEmailNotification); Ruby [`account.set_email_notification`](https://openemail.uk/docs/ruby/reference/account#setEmailNotification); PHP [`account->setEmailNotification`](https://openemail.uk/docs/php/reference/account#setEmailNotification); Go [`Account.SetEmailNotification`](https://openemail.uk/docs/go/reference/account#setEmailNotification); C# [`Account.SetEmailNotificationAsync`](https://openemail.uk/docs/csharp/reference/account#setEmailNotification); CLI [`openemail account set-email-notification`](https://openemail.uk/docs/cli/reference/account#account-set-email-notification).

### `account().setPushMuted`

Mute a workspace on your phone

```java
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.

Scopes: `account:write`.

**Parameters**

- `workspaceId` (`String`, required): A workspace id from `workspaces().list`.
- `body.muted` (`boolean`, required): True to mute it, false to let it notify again.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

The same map as `account().getNotifications`, with the new `mutedWorkspaces`.

**Example**

```java
Map<String, Object> settings = client.account().setPushMuted("10417196-e324-4283-af98-66ec62167c47", Body.of("muted", true));

System.out.println(settings.get("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: API [`PUT /account/notifications/push/{workspaceId}`](https://openemail.uk/docs/api/reference/your-account#put-account-notifications-push-workspaceid); TypeScript [`account.setPushMuted()`](https://openemail.uk/docs/sdk/reference/account#setPushMuted); Python [`account.set_push_muted()`](https://openemail.uk/docs/python/reference/account#setPushMuted); Ruby [`account.set_push_muted`](https://openemail.uk/docs/ruby/reference/account#setPushMuted); PHP [`account->setPushMuted`](https://openemail.uk/docs/php/reference/account#setPushMuted); Go [`Account.SetPushMuted`](https://openemail.uk/docs/go/reference/account#setPushMuted); C# [`Account.SetPushMutedAsync`](https://openemail.uk/docs/csharp/reference/account#setPushMuted); CLI [`openemail account set-push-muted`](https://openemail.uk/docs/cli/reference/account#account-set-push-muted).

### `account().setPhoto`

Set your profile photo

```java
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`.

Scopes: `account:write`.

**Parameters**

- `data` (`byte[]`, required): The image as a byte array.
- `options.contentType` (`String`): `image/png`, `image/jpeg`, `image/webp` or `image/gif`. Required, since a byte array carries no type of its own.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with the new `url`.

**Example**

```java
Map<String, Object> photo = client.account().setPhoto(Files.readAllBytes(Path.of("me.jpg")), RequestOptions.of("contentType", "image/jpeg"));

System.out.println(photo.get("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`](https://openemail.uk/docs/api/reference/your-account#put-account-photo); TypeScript [`account.setPhoto()`](https://openemail.uk/docs/sdk/reference/account#setPhoto); Python [`account.set_photo()`](https://openemail.uk/docs/python/reference/account#setPhoto); Ruby [`account.set_photo`](https://openemail.uk/docs/ruby/reference/account#setPhoto); PHP [`account->setPhoto`](https://openemail.uk/docs/php/reference/account#setPhoto); Go [`Account.SetPhoto`](https://openemail.uk/docs/go/reference/account#setPhoto); C# [`Account.SetPhotoAsync`](https://openemail.uk/docs/csharp/reference/account#setPhoto); CLI [`openemail account set-photo`](https://openemail.uk/docs/cli/reference/account#account-set-photo).

### `account().removePhoto`

Remove your profile photo

```java
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.

Scopes: `account:write`.

**Parameters**

- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with `url` null.

**Example**

```java
Map<String, Object> result = client.account().removePhoto();

System.out.println(result.get("url"));
```

**Notes**

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

Also available in: API [`DELETE /account/photo`](https://openemail.uk/docs/api/reference/your-account#delete-account-photo); TypeScript [`account.removePhoto()`](https://openemail.uk/docs/sdk/reference/account#removePhoto); Python [`account.remove_photo()`](https://openemail.uk/docs/python/reference/account#removePhoto); Ruby [`account.remove_photo`](https://openemail.uk/docs/ruby/reference/account#removePhoto); PHP [`account->removePhoto`](https://openemail.uk/docs/php/reference/account#removePhoto); Go [`Account.RemovePhoto`](https://openemail.uk/docs/go/reference/account#removePhoto); C# [`Account.RemovePhotoAsync`](https://openemail.uk/docs/csharp/reference/account#removePhoto); CLI [`openemail account remove-photo`](https://openemail.uk/docs/cli/reference/account#account-remove-photo).

### `account().getUsername`

Read your username

```java
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.

Scopes: `account:read`.

**Parameters**

- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with `username`, `chosen` and `address`.

**Example**

```java
Map<String, Object> result = client.account().getUsername();

System.out.println(result.get("address"));
```

**Notes**

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

Also available in: API [`GET /account/username`](https://openemail.uk/docs/api/reference/your-account#get-account-username); TypeScript [`account.getUsername()`](https://openemail.uk/docs/sdk/reference/account#getUsername); Python [`account.get_username()`](https://openemail.uk/docs/python/reference/account#getUsername); Ruby [`account.get_username`](https://openemail.uk/docs/ruby/reference/account#getUsername); PHP [`account->getUsername`](https://openemail.uk/docs/php/reference/account#getUsername); Go [`Account.GetUsername`](https://openemail.uk/docs/go/reference/account#getUsername); C# [`Account.GetUsernameAsync`](https://openemail.uk/docs/csharp/reference/account#getUsername); CLI [`openemail account get-username`](https://openemail.uk/docs/cli/reference/account#account-get-username).

### `account().checkUsername`

Check a username

```java
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.

Scopes: `account:read`.

**Parameters**

- `username` (`String`, required): Up to 60 characters before it is tidied.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```java
Map<String, Object> check = client.account().checkUsername("ada.lovelace");

System.out.println(check.get("available") + " " + check.get("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`](https://openemail.uk/docs/api/reference/your-account#get-account-username-availability); TypeScript [`account.checkUsername()`](https://openemail.uk/docs/sdk/reference/account#checkUsername); Python [`account.check_username()`](https://openemail.uk/docs/python/reference/account#checkUsername); Ruby [`account.check_username`](https://openemail.uk/docs/ruby/reference/account#checkUsername); PHP [`account->checkUsername`](https://openemail.uk/docs/php/reference/account#checkUsername); Go [`Account.CheckUsername`](https://openemail.uk/docs/go/reference/account#checkUsername); C# [`Account.CheckUsernameAsync`](https://openemail.uk/docs/csharp/reference/account#checkUsername); CLI [`openemail account check-username`](https://openemail.uk/docs/cli/reference/account#account-check-username).

### `account().setUsername`

Choose your username

```java
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`.

Scopes: `account:write`.

**Parameters**

- `username` (`String`, required): 3 to 30 lowercase letters, numbers and single dots once it is tidied.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with `username`, `chosen` set to true and `address`.

**Example**

```java
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"));
```

**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`](https://openemail.uk/docs/api/reference/your-account#put-account-username); TypeScript [`account.setUsername()`](https://openemail.uk/docs/sdk/reference/account#setUsername); Python [`account.set_username()`](https://openemail.uk/docs/python/reference/account#setUsername); Ruby [`account.set_username`](https://openemail.uk/docs/ruby/reference/account#setUsername); PHP [`account->setUsername`](https://openemail.uk/docs/php/reference/account#setUsername); Go [`Account.SetUsername`](https://openemail.uk/docs/go/reference/account#setUsername); C# [`Account.SetUsernameAsync`](https://openemail.uk/docs/csharp/reference/account#setUsername); CLI [`openemail account set-username`](https://openemail.uk/docs/cli/reference/account#account-set-username).

### `account().listConnectedApps`

List your connected apps

```java
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.

Scopes: `account:read`.

**Parameters**

- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```java
List<Map<String, Object>> apps = client.account().listConnectedApps();

for (Map<String, Object> connectedApp : apps) {
    System.out.println(connectedApp.get("name") + " " + connectedApp.get("status"));
}
```

**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`](https://openemail.uk/docs/api/reference/your-account#get-account-connected-apps); TypeScript [`account.listConnectedApps()`](https://openemail.uk/docs/sdk/reference/account#listConnectedApps); Python [`account.list_connected_apps()`](https://openemail.uk/docs/python/reference/account#listConnectedApps); Ruby [`account.list_connected_apps`](https://openemail.uk/docs/ruby/reference/account#listConnectedApps); PHP [`account->listConnectedApps`](https://openemail.uk/docs/php/reference/account#listConnectedApps); Go [`Account.ListConnectedApps`](https://openemail.uk/docs/go/reference/account#listConnectedApps); C# [`Account.ListConnectedAppsAsync`](https://openemail.uk/docs/csharp/reference/account#listConnectedApps); CLI [`openemail account list-connected-apps`](https://openemail.uk/docs/cli/reference/account#account-list-connected-apps).

### `account().revokeConnectedApp`

Remove a connected app

```java
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.

Scopes: `account:write`.

**Parameters**

- `clientId` (`String`, required): The app's `clientId` from `account().listConnectedApps`.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with `clientId`, `revoked` set to true and `tokensRevoked`.

**Example**

```java
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"));
}
```

**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}`](https://openemail.uk/docs/api/reference/your-account#delete-account-connected-apps-clientid); TypeScript [`account.revokeConnectedApp()`](https://openemail.uk/docs/sdk/reference/account#revokeConnectedApp); Python [`account.revoke_connected_app()`](https://openemail.uk/docs/python/reference/account#revokeConnectedApp); Ruby [`account.revoke_connected_app`](https://openemail.uk/docs/ruby/reference/account#revokeConnectedApp); PHP [`account->revokeConnectedApp`](https://openemail.uk/docs/php/reference/account#revokeConnectedApp); Go [`Account.RevokeConnectedApp`](https://openemail.uk/docs/go/reference/account#revokeConnectedApp); C# [`Account.RevokeConnectedAppAsync`](https://openemail.uk/docs/csharp/reference/account#revokeConnectedApp); CLI [`openemail account revoke-connected-app`](https://openemail.uk/docs/cli/reference/account#account-revoke-connected-app).

### `account().listInvitations`

List your invitations

```java
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.

Scopes: `account:read`.

**Parameters**

- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```java
List<Map<String, Object>> invitations = client.account().listInvitations();

for (Map<String, Object> invitation : invitations) {
    System.out.println(invitation.get("workspaceName") + " " + invitation.get("roleName"));
}
```

**Notes**

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

Also available in: API [`GET /account/invitations`](https://openemail.uk/docs/api/reference/your-account#get-account-invitations); TypeScript [`account.listInvitations()`](https://openemail.uk/docs/sdk/reference/account#listInvitations); Python [`account.list_invitations()`](https://openemail.uk/docs/python/reference/account#listInvitations); Ruby [`account.list_invitations`](https://openemail.uk/docs/ruby/reference/account#listInvitations); PHP [`account->listInvitations`](https://openemail.uk/docs/php/reference/account#listInvitations); Go [`Account.ListInvitations`](https://openemail.uk/docs/go/reference/account#listInvitations); C# [`Account.ListInvitationsAsync`](https://openemail.uk/docs/csharp/reference/account#listInvitations); CLI [`openemail account list-invitations`](https://openemail.uk/docs/cli/reference/account#account-list-invitations).

### `account().acceptInvitation`

Accept an invitation

```java
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`.

Scopes: `account:write`.

**Parameters**

- `invitationId` (`String`, required): An invitation id from `account().listInvitations`.
- `options.activate` (`boolean`): True to make it the workspace the app opens. Defaults to false.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with `workspaceId`, `workspaceName`, `addressesGranted`, `domainsGranted` and `activated`.

**Example**

```java
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"));
```

**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`](https://openemail.uk/docs/api/reference/your-account#post-account-invitations-invitationid-accept); TypeScript [`account.acceptInvitation()`](https://openemail.uk/docs/sdk/reference/account#acceptInvitation); Python [`account.accept_invitation()`](https://openemail.uk/docs/python/reference/account#acceptInvitation); Ruby [`account.accept_invitation`](https://openemail.uk/docs/ruby/reference/account#acceptInvitation); PHP [`account->acceptInvitation`](https://openemail.uk/docs/php/reference/account#acceptInvitation); Go [`Account.AcceptInvitation`](https://openemail.uk/docs/go/reference/account#acceptInvitation); C# [`Account.AcceptInvitationAsync`](https://openemail.uk/docs/csharp/reference/account#acceptInvitation); CLI [`openemail account accept-invitation`](https://openemail.uk/docs/cli/reference/account#account-accept-invitation).

### `account().declineInvitation`

Decline an invitation

```java
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`.

Scopes: `account:write`.

**Parameters**

- `invitationId` (`String`, required): An invitation id from `account().listInvitations`.
- `options.apiKey` (`String`): Overrides the client's API key for this call only.

**Returns**

A map with the invitation `id` and `declined` set to true.

**Example**

```java
Map<String, Object> result = client.account().declineInvitation("winv_6bb640f5b99e47deb758f1f5");

System.out.println(result.get("id"));
```

**Notes**

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

Also available in: API [`POST /account/invitations/{invitationId}/decline`](https://openemail.uk/docs/api/reference/your-account#post-account-invitations-invitationid-decline); TypeScript [`account.declineInvitation()`](https://openemail.uk/docs/sdk/reference/account#declineInvitation); Python [`account.decline_invitation()`](https://openemail.uk/docs/python/reference/account#declineInvitation); Ruby [`account.decline_invitation`](https://openemail.uk/docs/ruby/reference/account#declineInvitation); PHP [`account->declineInvitation`](https://openemail.uk/docs/php/reference/account#declineInvitation); Go [`Account.DeclineInvitation`](https://openemail.uk/docs/go/reference/account#declineInvitation); C# [`Account.DeclineInvitationAsync`](https://openemail.uk/docs/csharp/reference/account#declineInvitation); CLI [`openemail account decline-invitation`](https://openemail.uk/docs/cli/reference/account#account-decline-invitation).