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

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

Read your notification settings

```python
def get_notifications(
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> NotificationSettingsResource
```

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**

- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`NotificationSettingsResource` with `email`, a list holding one `EmailNotificationSetting` for each kind of email, and `mutedWorkspaces`, a list of workspace ids.

**Example**

```python
from openemail import openemail

settings = openemail.account.get_notifications()

for kind in settings['email']:
    print(kind['label'], 'on' if kind['enabled'] else 'off')

print('Muted on the phone:', settings['mutedWorkspaces'])
```

**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); Ruby [`account.get_notifications`](https://openemail.uk/docs/ruby/reference/account#getNotifications); CLI [`openemail account get-notifications`](https://openemail.uk/docs/cli/reference/account#account-get-notifications).

### `account.set_email_notification()`

Turn a kind of email on or off

```python
def set_email_notification(
    category: EmailNotificationCategory,
    body: EmailNotificationSet,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> NotificationSettingsResource
```

`{'enabled': False}` stops OpenEmail sending the person that kind of email, and `{'enabled': 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` (`EmailNotificationCategory`, required): `account`, `billing`, `activity` or `product`.
- `body['enabled']` (`bool`, required): `True` to receive that email, `False` to stop it.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`NotificationSettingsResource` as it is after the change.

**Example**

```python
from openemail import openemail

settings = openemail.account.set_email_notification('product', {'enabled': False})

for kind in settings['email']:
    print(kind['category'], kind['enabled'])
```

**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); Ruby [`account.set_email_notification`](https://openemail.uk/docs/ruby/reference/account#setEmailNotification); CLI [`openemail account set-email-notification`](https://openemail.uk/docs/cli/reference/account#account-set-email-notification).

### `account.set_push_muted()`

Mute a workspace on your phone

```python
def set_push_muted(
    workspace_id: str,
    body: PushNotificationSet,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> NotificationSettingsResource
```

`{'muted': True}` stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and `{'muted': False}` lets it notify them again.

Scopes: `account:write`.

**Parameters**

- `workspace_id` (`str`, required): A workspace id from `workspaces.list`.
- `body['muted']` (`bool`, required): `True` to mute it, `False` to let it notify again.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`NotificationSettingsResource` with the new `mutedWorkspaces`.

**Example**

```python
from openemail import openemail

settings = openemail.account.set_push_muted(
    '10417196-e324-4283-af98-66ec62167c47', {'muted': True}
)

print(settings['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); Ruby [`account.set_push_muted`](https://openemail.uk/docs/ruby/reference/account#setPushMuted); CLI [`openemail account set-push-muted`](https://openemail.uk/docs/cli/reference/account#account-set-push-muted).

### `account.set_photo()`

Set your profile photo

```python
def set_photo(
    data: RawBody,
    *,
    content_type: ContactPhotoType | None = None,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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 `bytes`, a `bytearray` or a `memoryview`, such as what `Path('photo.jpg').read_bytes()` returns. Bytes carry no type of their own, so the type is read from `content_type=` alone. Without it the bytes go as `application/octet-stream` and the server refuses them with 422 `invalid_image`.

Scopes: `account:write`.

**Parameters**

- `data` (`RawBody`, required): The image as `bytes`, a `bytearray` or a `memoryview`.
- `content_type` (`ContactPhotoType`): `image/png`, `image/jpeg`, `image/webp` or `image/gif`, matching the bytes. Left out, the upload is refused with 422 `invalid_image`.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`AccountPhotoResource` with the new `url`.

**Example**

```python
from pathlib import Path

from openemail import openemail

photo = openemail.account.set_photo(Path('photo.jpg').read_bytes(), content_type='image/jpeg')

print(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`](https://openemail.uk/docs/api/reference/your-account#put-account-photo); TypeScript [`account.setPhoto()`](https://openemail.uk/docs/sdk/reference/account#setPhoto); Ruby [`account.set_photo`](https://openemail.uk/docs/ruby/reference/account#setPhoto); CLI [`openemail account set-photo`](https://openemail.uk/docs/cli/reference/account#account-set-photo).

### `account.remove_photo()`

Remove your profile photo

```python
def remove_photo(
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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.

Scopes: `account:write`.

**Parameters**

- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`AccountPhotoResource` with `url` set to `None`.

**Example**

```python
from openemail import openemail

photo = openemail.account.remove_photo()

print(photo['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); Ruby [`account.remove_photo`](https://openemail.uk/docs/ruby/reference/account#removePhoto); CLI [`openemail account remove-photo`](https://openemail.uk/docs/cli/reference/account#account-remove-photo).

### `account.get_username()`

Read your username

```python
def get_username(
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> UsernameResource
```

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**

- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`UsernameResource` with `username`, `chosen` and `address`.

**Example**

```python
from openemail import openemail

account = openemail.account.get_username()

print(account['username'], 'chosen' if account['chosen'] else 'made for you')
print(account['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); Ruby [`account.get_username`](https://openemail.uk/docs/ruby/reference/account#getUsername); CLI [`openemail account get-username`](https://openemail.uk/docs/cli/reference/account#account-get-username).

### `account.check_username()`

Check a username

```python
def check_username(
    username: str,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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.

Scopes: `account:read`.

**Parameters**

- `username` (`str`, required): Up to 60 characters before it is tidied.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

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

**Example**

```python
from openemail import openemail

check = openemail.account.check_username('Ada Lovelace')

if check['available']:
    print(check['username'], 'is free')
else:
    print(check['status'], 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`](https://openemail.uk/docs/api/reference/your-account#get-account-username-availability); TypeScript [`account.checkUsername()`](https://openemail.uk/docs/sdk/reference/account#checkUsername); Ruby [`account.check_username`](https://openemail.uk/docs/ruby/reference/account#checkUsername); CLI [`openemail account check-username`](https://openemail.uk/docs/cli/reference/account#account-check-username).

### `account.set_username()`

Choose your username

```python
def set_username(
    username: str,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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 `check_username`.

Scopes: `account:write`.

**Parameters**

- `username` (`str`, required): 3 to 30 lowercase letters, numbers and single dots once it is tidied.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`UsernameResource` with `chosen` set to `True`.

**Example**

```python
from openemail import OpenEmailApiError, openemail

try:
    account = openemail.account.set_username('ada.lovelace')
except OpenEmailApiError as error:
    if error.code == 'username_taken':
        print('Someone else has that one, try another')
    elif error.code == 'username_locked':
        print('Your username is already chosen for good')
    else:
        raise
else:
    print(account['username'], account['address'])
```

**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); Ruby [`account.set_username`](https://openemail.uk/docs/ruby/reference/account#setUsername); CLI [`openemail account set-username`](https://openemail.uk/docs/cli/reference/account#account-set-username).

### `account.list_connected_apps()`

List your connected apps

```python
def list_connected_apps(
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> builtins.list[ConnectedAppResource]
```

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**

- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`list[ConnectedAppResource]`, each with `clientId`, `name`, `kind`, `status`, `grant` and `tokenCount`.

**Example**

```python
from openemail import openemail

apps = openemail.account.list_connected_apps()

for app in apps:
    print(app['name'], app['kind'], app['status'], '(this app)' if app['current'] else '')
```

**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); Ruby [`account.list_connected_apps`](https://openemail.uk/docs/ruby/reference/account#listConnectedApps); CLI [`openemail account list-connected-apps`](https://openemail.uk/docs/cli/reference/account#account-list-connected-apps).

### `account.revoke_connected_app()`

Remove a connected app

```python
def revoke_connected_app(
    client_id: str,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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.

Scopes: `account:write`.

**Parameters**

- `client_id` (`str`, required): The app's `clientId` from `list_connected_apps`.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`RevokedConnectedAppResource` with `revoked` set to `True` and `tokensRevoked`.

**Example**

```python
from openemail import openemail

revoked = openemail.account.revoke_connected_app('kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE')

print(revoked['clientId'], 'lost', revoked['tokensRevoked'], 'tokens')
```

**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); Ruby [`account.revoke_connected_app`](https://openemail.uk/docs/ruby/reference/account#revokeConnectedApp); CLI [`openemail account revoke-connected-app`](https://openemail.uk/docs/cli/reference/account#account-revoke-connected-app).

### `account.list_invitations()`

List your invitations

```python
def list_invitations(
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> builtins.list[ReceivedInvitationResource]
```

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.list_invitations` instead.

Scopes: `account:read`.

**Parameters**

- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`list[ReceivedInvitationResource]`, each with `id`, `workspaceName`, `roleName`, `inviterName`, `addresses` and `expiresAt`.

**Example**

```python
from openemail import openemail

invitations = openemail.account.list_invitations()

for invitation in invitations:
    print(invitation['workspaceName'], invitation['roleName'], invitation['expiresAt'])
```

**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); Ruby [`account.list_invitations`](https://openemail.uk/docs/ruby/reference/account#listInvitations); CLI [`openemail account list-invitations`](https://openemail.uk/docs/cli/reference/account#account-list-invitations).

### `account.accept_invitation()`

Accept an invitation

```python
def accept_invitation(
    invitation_id: str,
    *,
    activate: bool | None = None,
    api_key: str | None = None,
    timeout: float | None = None,
) -> AcceptedInvitationResource
```

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

- `invitation_id` (`str`, required): An invitation id from `list_invitations`.
- `activate` (`bool`): `True` to make it the workspace the app opens. Defaults to `False`.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

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

**Example**

```python
from openemail import openemail

invitations = openemail.account.list_invitations()

if invitations:
    joined = openemail.account.accept_invitation(invitations[0]['id'], activate=True)

    print(joined['workspaceName'], joined['addressesGranted'], joined['activated'])
```

**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); Ruby [`account.accept_invitation`](https://openemail.uk/docs/ruby/reference/account#acceptInvitation); CLI [`openemail account accept-invitation`](https://openemail.uk/docs/cli/reference/account#account-accept-invitation).

### `account.decline_invitation()`

Decline an invitation

```python
def decline_invitation(
    invitation_id: str,
    *,
    api_key: str | None = None,
    timeout: float | None = None,
) -> 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`.

Scopes: `account:write`.

**Parameters**

- `invitation_id` (`str`, required): An invitation id from `list_invitations`.
- `api_key` (`str`): Overrides the client's API key for this call only.
- `timeout` (`float`): Seconds this call may take, the response included, before it raises `OpenEmailNetworkError` with `is_timeout`. It overrides the client's `timeout` for this call, and `0` turns the limit off.

**Returns**

`DeclinedInvitationResource` with `declined` set to `True`.

**Example**

```python
from openemail import openemail

declined = openemail.account.decline_invitation('winv_6bb640f5b99e47deb758f1f5')

print(declined['id'], declined['declined'])
```

**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); Ruby [`account.decline_invitation`](https://openemail.uk/docs/ruby/reference/account#declineInvitation); CLI [`openemail account decline-invitation`](https://openemail.uk/docs/cli/reference/account#account-decline-invitation).