---
title: "client.account"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/ruby/reference/account"
area: "Ruby"
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, the invitations waiting for them, the devices they are signed in on, their passkeys and their security log. An API key acts for the workspace owner, and an app for the person who connected it.

### `account.get_notifications`

Read your notification settings

```ruby
get_notifications(api_key: nil) -> Hash
```

Returns which kinds of email Nextmail 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` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `email`, an Array with one Hash for each kind of email, each with `category`, `label`, `description`, `required` and `enabled`, and `mutedWorkspaces`.

**Example**

```ruby
settings = client.account.get_notifications

settings[:email].each { |kind| puts "#{kind[:label]} #{kind[:enabled]}" }
```

**Notes**

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

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

### `account.set_email_notification`

Turn a kind of email on or off

```ruby
set_email_notification(category, body = nil, api_key: nil, **fields) -> Hash
```

`enabled: false` stops Nextmail 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`.
- `enabled` (`Boolean`, required): True to receive that email, false to stop it.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

The same Hash as `account.get_notifications`, as it is after the change.

**Example**

```ruby
client.account.set_email_notification("product", enabled: false)
```

**Notes**

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

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

### `account.set_push_muted`

Mute a workspace on your phone

```ruby
set_push_muted(workspace_id, body = nil, api_key: nil, **fields) -> Hash
```

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

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

**Returns**

The same Hash as `account.get_notifications`, with the new `mutedWorkspaces`.

**Example**

```ruby
settings = client.account.set_push_muted("10417196-e324-4283-af98-66ec62167c47", muted: true)

p 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://nextmail.sh/docs/api/reference/your-account#put-account-notifications-push-workspaceid); TypeScript [`nextmail.account.setPushMuted()`](https://nextmail.sh/docs/sdk/reference/account#setPushMuted); Python [`account.set_push_muted()`](https://nextmail.sh/docs/python/reference/account#setPushMuted); PHP [`account->setPushMuted`](https://nextmail.sh/docs/php/reference/account#setPushMuted); Go [`Account.SetPushMuted`](https://nextmail.sh/docs/go/reference/account#setPushMuted); Java [`account().setPushMuted`](https://nextmail.sh/docs/java/reference/account#setPushMuted); C# [`Account.SetPushMutedAsync`](https://nextmail.sh/docs/csharp/reference/account#setPushMuted); CLI [`nextmail account set-push-muted`](https://nextmail.sh/docs/cli/reference/account#account-set-push-muted).

### `account.set_photo`

Set your profile photo

```ruby
set_photo(data, content_type: nil, api_key: nil) -> Hash
```

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 binary `String`, an `IO` or a `Pathname`. The type is read from `content_type:`, or, when that is left out, from the `content_type` of `data` itself or the extension of its file name. Without either the bytes go as `application/octet-stream` and the server refuses them with 422 `invalid_image`.

Scopes: `account:write`.

**Parameters**

- `data` (`String, IO or Pathname`, required): The image: a binary `String`, an `IO` or a `Pathname`.
- `content_type` (`String`): `image/png`, `image/jpeg`, `image/webp` or `image/gif`. Required unless `data` carries its type, as an object with a `content_type` or a `Pathname` or `File` named with the extension of the type.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with the new `url`.

**Example**

```ruby
photo = client.account.set_photo(File.binread("photo.jpg"), content_type: "image/jpeg")

puts 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://nextmail.sh/docs/api/reference/your-account#put-account-photo); TypeScript [`nextmail.account.setPhoto()`](https://nextmail.sh/docs/sdk/reference/account#setPhoto); Python [`account.set_photo()`](https://nextmail.sh/docs/python/reference/account#setPhoto); PHP [`account->setPhoto`](https://nextmail.sh/docs/php/reference/account#setPhoto); Go [`Account.SetPhoto`](https://nextmail.sh/docs/go/reference/account#setPhoto); Java [`account().setPhoto`](https://nextmail.sh/docs/java/reference/account#setPhoto); C# [`Account.SetPhotoAsync`](https://nextmail.sh/docs/csharp/reference/account#setPhoto); CLI [`nextmail account set-photo`](https://nextmail.sh/docs/cli/reference/account#account-set-photo).

### `account.remove_photo`

Remove your profile photo

```ruby
remove_photo(api_key: nil) -> Hash
```

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` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `url` nil.

**Example**

```ruby
client.account.remove_photo
```

**Notes**

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

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

### `account.get_username`

Read your username

```ruby
get_username(api_key: nil) -> Hash
```

Returns the person's username, whether they chose it or it was made for them from their name, and the free address that comes with it, when there is one. A username the person chose never changes.

Scopes: `account:read`.

**Parameters**

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

**Returns**

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

**Example**

```ruby
username, chosen, address = client.account.get_username.values_at(:username, :chosen, :address)

puts username, chosen ? "chosen" : "made for you", address
```

**Notes**

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

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

### `account.check_username`

Check a username

```ruby
check_username(username, api_key: nil) -> Hash
```

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.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```ruby
check = client.account.check_username("ada.lovelace")

puts check[:message] unless check[:available]
```

**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://nextmail.sh/docs/api/reference/your-account#get-account-username-availability); TypeScript [`nextmail.account.checkUsername()`](https://nextmail.sh/docs/sdk/reference/account#checkUsername); Python [`account.check_username()`](https://nextmail.sh/docs/python/reference/account#checkUsername); PHP [`account->checkUsername`](https://nextmail.sh/docs/php/reference/account#checkUsername); Go [`Account.CheckUsername`](https://nextmail.sh/docs/go/reference/account#checkUsername); Java [`account().checkUsername`](https://nextmail.sh/docs/java/reference/account#checkUsername); C# [`Account.CheckUsernameAsync`](https://nextmail.sh/docs/csharp/reference/account#checkUsername); CLI [`nextmail account check-username`](https://nextmail.sh/docs/cli/reference/account#account-check-username).

### `account.set_username`

Choose your username

```ruby
set_username(username, api_key: nil) -> Hash
```

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` (`String`, required): 3 to 30 lowercase letters, numbers and single dots once it is tidied.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

The same Hash as `account.get_username`, with `chosen` set to true.

**Example**

```ruby
check = client.account.check_username("ada.lovelace")

if check[:available] == false
  puts check[:message]
else
  client.account.set_username(check[:username])
end
```

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

### `account.list_connected_apps`

List your connected apps

```ruby
list_connected_apps(api_key: nil) -> Array<Hash>
```

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` (`String`): Overrides the client's API key for this call only.

**Returns**

An Array of Hashes, each with `clientId`, `name`, `kind`, `status`, `grant` and `tokenCount`.

**Example**

```ruby
apps = client.account.list_connected_apps

apps.each do |app|
  label = app[:current] ? "(this app)" : ""
  puts "#{app[:name]} #{app[:status]} #{label}"
end
```

**Notes**

- A sign-in of the command line tool shows as `kind: "cli"`, with its device in `cliDevice`.

Also available in: API [`GET /account/connected-apps`](https://nextmail.sh/docs/api/reference/your-account#get-account-connected-apps); TypeScript [`nextmail.account.listConnectedApps()`](https://nextmail.sh/docs/sdk/reference/account#listConnectedApps); Python [`account.list_connected_apps()`](https://nextmail.sh/docs/python/reference/account#listConnectedApps); PHP [`account->listConnectedApps`](https://nextmail.sh/docs/php/reference/account#listConnectedApps); Go [`Account.ListConnectedApps`](https://nextmail.sh/docs/go/reference/account#listConnectedApps); Java [`account().listConnectedApps`](https://nextmail.sh/docs/java/reference/account#listConnectedApps); C# [`Account.ListConnectedAppsAsync`](https://nextmail.sh/docs/csharp/reference/account#listConnectedApps); CLI [`nextmail account list-connected-apps`](https://nextmail.sh/docs/cli/reference/account#account-list-connected-apps).

### `account.list_connected_app_requests`

Read the request log of a connected app

```ruby
list_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::Page
```

Returns one page of the REST calls an app the person connected made with the access they gave it, newest first, as Request log in the menu of the app under Account, Connected apps shows them. Each call has its method, path, status, how long it took and the error code of a refusal, and never a body, a query string or the address it came from. The command line tool signed in from a browser is in it too. Calls made under an earlier connection of the same app are not: connecting it again starts a new log. `failed_only:`, `statuses:`, `since:` and `until:` narrow it, and they combine.

Scopes: `account:read`.

**Parameters**

- `client_id` (`String`, required): The app's `clientId` from `list_connected_apps`.
- `failed_only` (`Boolean`): Only calls answered with a status of 400 or more.
- `statuses` (`Array<Integer>`): Only calls answered with one of these HTTP status codes, such as `[401, 403]`. At most 20, each from 100 to 599, sent comma-separated as `status`.
- `since` (`Time, Date or String`): Only calls at or after this instant. A `Time` is sent as ISO 8601 in UTC, and a String must already be ISO 8601.
- `until` (`Time, Date or String`): Only calls before this instant. It has to be later than `since`, or the server answers 400 `invalid_parameter`.
- `limit` (`Integer`): Calls per page, a whole number from 1 to 100. The server defaults to 25.
- `cursor` (`String`): The `next_cursor` of the previous page, passed back unchanged. Leave it out for the first page.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

The `Nextmail::Page` of Hashes, with `items`, `has_more?` and `next_cursor`. Each item has `id`, `clientId`, `workspaceId`, `requestId`, `method`, `path`, `status`, `errorCode`, `durationMs`, `userAgent` and `createdAt`.

**Example**

```ruby
page = client.account.list_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", failed_only: true, limit: 50)

page.items.each do |call|
  puts call.values_at(:createdAt, :method, :path, :status, :errorCode).join(" ")
end
```

**Notes**

- An app the person never connected is a 404 `resource_not_found`, and a cursor this log did not hand out is a 400 `invalid_cursor`.
- Calls made with an API key are in the request log of that key, `keys.list_requests`, not here.

Also available in: API [`GET /account/connected-apps/{clientId}/requests`](https://nextmail.sh/docs/api/reference/your-account#get-account-connected-apps-clientid-requests); TypeScript [`nextmail.account.listConnectedAppRequests()`](https://nextmail.sh/docs/sdk/reference/account#listConnectedAppRequests); Python [`account.list_connected_app_requests()`](https://nextmail.sh/docs/python/reference/account#listConnectedAppRequests); PHP [`account->listConnectedAppRequests`](https://nextmail.sh/docs/php/reference/account#listConnectedAppRequests); Go [`Account.ListConnectedAppRequests`](https://nextmail.sh/docs/go/reference/account#listConnectedAppRequests); Java [`account().listConnectedAppRequests`](https://nextmail.sh/docs/java/reference/account#listConnectedAppRequests); C# [`Account.ListConnectedAppRequestsAsync`](https://nextmail.sh/docs/csharp/reference/account#listConnectedAppRequests); CLI [`nextmail account list-connected-app-requests`](https://nextmail.sh/docs/cli/reference/account#account-list-connected-app-requests).

### `account.list_all_connected_app_requests`

Collect the whole request log of a connected app into one Array

```ruby
list_all_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>
```

Walks every page of `list_connected_app_requests` under the same filters. The log is never pruned, so give it a window unless you mean to read a busy app's whole history, or use `iterate_connected_app_requests` to stop early.

Scopes: `account:read`.

**Parameters**

- `client_id` (`String`, required): The app's `clientId` from `list_connected_apps`.
- `failed_only` (`Boolean`): Only calls answered with a status of 400 or more.
- `statuses` (`Array<Integer>`): Only calls answered with one of these HTTP status codes, such as `[401, 403]`. At most 20, each from 100 to 599, sent comma-separated as `status`.
- `since` (`Time, Date or String`): Only calls at or after this instant. A `Time` is sent as ISO 8601 in UTC, and a String must already be ISO 8601.
- `until` (`Time, Date or String`): Only calls before this instant. It has to be later than `since`, or the server answers 400 `invalid_parameter`.
- `limit` (`Integer`): Page size for each request, 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk from this cursor instead of the newest call.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Array of Hashes, one per call with the fields `list_connected_app_requests` returns, newest first.

**Example**

```ruby
today = client.account.list_all_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", since: Time.now - (24 * 60 * 60), limit: 100)

puts "#{today.size} calls today"
```

**Notes**

- If any page fails, the error is raised and the calls already fetched are discarded.

Also available in: API [`GET /account/connected-apps/{clientId}/requests`](https://nextmail.sh/docs/api/reference/your-account#get-account-connected-apps-clientid-requests); TypeScript [`nextmail.account.listAllConnectedAppRequests()`](https://nextmail.sh/docs/sdk/reference/account#listAllConnectedAppRequests); Python [`account.list_all_connected_app_requests()`](https://nextmail.sh/docs/python/reference/account#listAllConnectedAppRequests); PHP [`account->listAllConnectedAppRequests`](https://nextmail.sh/docs/php/reference/account#listAllConnectedAppRequests); Go [`Account.ListAllConnectedAppRequests`](https://nextmail.sh/docs/go/reference/account#listAllConnectedAppRequests); Java [`account().listAllConnectedAppRequests`](https://nextmail.sh/docs/java/reference/account#listAllConnectedAppRequests); C# [`Account.ListAllConnectedAppRequestsAsync`](https://nextmail.sh/docs/csharp/reference/account#listAllConnectedAppRequests).

### `account.iterate_connected_app_requests`

Stream the request log of a connected app one call at a time

```ruby
iterate_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>
```

An Enumerator over `list_connected_app_requests` under the same filters, fetching a page only when the one before is drained. Given a block, it yields each call to the block instead.

Scopes: `account:read`.

**Parameters**

- `client_id` (`String`, required): The app's `clientId` from `list_connected_apps`.
- `failed_only` (`Boolean`): Only calls answered with a status of 400 or more.
- `statuses` (`Array<Integer>`): Only calls answered with one of these HTTP status codes, such as `[401, 403]`. At most 20, each from 100 to 599, sent comma-separated as `status`.
- `since` (`Time, Date or String`): Only calls at or after this instant. A `Time` is sent as ISO 8601 in UTC, and a String must already be ISO 8601.
- `until` (`Time, Date or String`): Only calls before this instant. It has to be later than `since`, or the server answers 400 `invalid_parameter`.
- `limit` (`Integer`): Page size for each request, 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk from this cursor instead of the newest call.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Enumerator of Hashes, one call per step (or yields each one to a block).

**Example**

```ruby
refused = client.account.iterate_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", failed_only: true).first

puts "last refused call at #{refused[:createdAt]}" if refused
```

Also available in: API [`GET /account/connected-apps/{clientId}/requests`](https://nextmail.sh/docs/api/reference/your-account#get-account-connected-apps-clientid-requests); TypeScript [`nextmail.account.iterateConnectedAppRequests()`](https://nextmail.sh/docs/sdk/reference/account#iterateConnectedAppRequests); Python [`account.iterate_connected_app_requests()`](https://nextmail.sh/docs/python/reference/account#iterateConnectedAppRequests); PHP [`account->iterateConnectedAppRequests`](https://nextmail.sh/docs/php/reference/account#iterateConnectedAppRequests); Go [`Account.IterateConnectedAppRequests`](https://nextmail.sh/docs/go/reference/account#iterateConnectedAppRequests); Java [`account().iterateConnectedAppRequests`](https://nextmail.sh/docs/java/reference/account#iterateConnectedAppRequests); C# [`Account.IterateConnectedAppRequestsAsync`](https://nextmail.sh/docs/csharp/reference/account#iterateConnectedAppRequests).

### `account.revoke_connected_app`

Remove a connected app

```ruby
revoke_connected_app(client_id, api_key: nil) -> Hash
```

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` (`String`, required): The app's `clientId` from `list_connected_apps`.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `revoked` set to true and `tokensRevoked`.

**Example**

```ruby
revoked = client.account.revoke_connected_app("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR")

puts revoked[:tokensRevoked]
```

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

### `account.list_sessions`

List your signed-in devices

```ruby
list_sessions(api_key: nil) -> Array<Hash>
```

Returns every browser and phone the person is signed in on, as Account, Security lists them, most recently used first: the browser and system, the country and city it was last used from, how it signed in and when.

No address is ever recorded, only the place. A key or an app is not a signed-in device, so `current` is always false here.

Scopes: `account:read`.

**Parameters**

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

**Returns**

An Array of Hashes, each with `id`, `device`, `authMethod`, `country`, `city`, `createdAt`, `lastActiveAt` and `expiresAt`.

**Example**

```ruby
sessions = client.account.list_sessions

sessions.each do |session|
  device = session.dig(:device, :browser) || session.dig(:device, :os)
  puts "#{device} #{session[:city]} #{session[:lastActiveAt]}"
end
```

**Notes**

- `lastActiveAt` is accurate to within ten minutes.
- `authMethod` is nil for a device that signed in before it was recorded.

Also available in: API [`GET /account/sessions`](https://nextmail.sh/docs/api/reference/your-account#get-account-sessions); TypeScript [`nextmail.account.listSessions()`](https://nextmail.sh/docs/sdk/reference/account#listSessions); Python [`account.list_sessions()`](https://nextmail.sh/docs/python/reference/account#listSessions); PHP [`account->listSessions`](https://nextmail.sh/docs/php/reference/account#listSessions); Go [`Account.ListSessions`](https://nextmail.sh/docs/go/reference/account#listSessions); Java [`account().listSessions`](https://nextmail.sh/docs/java/reference/account#listSessions); C# [`Account.ListSessionsAsync`](https://nextmail.sh/docs/csharp/reference/account#listSessions); CLI [`nextmail account list-sessions`](https://nextmail.sh/docs/cli/reference/account#account-list-sessions).

### `account.revoke_session`

Sign out one device

```ruby
revoke_session(session_id, api_key: nil) -> Hash
```

Signs one browser or phone out, as Sign out next to it in Account, Security does. Its next request is refused at once, and a phone stops getting notifications. It is written to the person's security log.

Scopes: `account:write`.

**Parameters**

- `session_id` (`String`, required): The device's `id` from `list_sessions`.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `revoked` set to true.

**Example**

```ruby
sessions = client.account.list_sessions
abroad = sessions.reject { |session| session[:country] == "GB" }

abroad.each { |session| client.account.revoke_session(session[:id]) }
```

**Notes**

- A device that is not signed in to the account is a 404 `resource_not_found`.
- Not retried automatically. A retry after a lost response is a 404, since the device is already signed out.

Also available in: API [`DELETE /account/sessions/{sessionId}`](https://nextmail.sh/docs/api/reference/your-account#delete-account-sessions-sessionid); TypeScript [`nextmail.account.revokeSession()`](https://nextmail.sh/docs/sdk/reference/account#revokeSession); Python [`account.revoke_session()`](https://nextmail.sh/docs/python/reference/account#revokeSession); PHP [`account->revokeSession`](https://nextmail.sh/docs/php/reference/account#revokeSession); Go [`Account.RevokeSession`](https://nextmail.sh/docs/go/reference/account#revokeSession); Java [`account().revokeSession`](https://nextmail.sh/docs/java/reference/account#revokeSession); C# [`Account.RevokeSessionAsync`](https://nextmail.sh/docs/csharp/reference/account#revokeSession); CLI [`nextmail account revoke-session`](https://nextmail.sh/docs/cli/reference/account#account-revoke-session).

### `account.revoke_sessions`

Sign out everywhere

```ruby
revoke_sessions(connected_apps: nil, api_key: nil) -> Hash
```

Signs the person out of every browser and phone at once, for when a device is lost or a password may have leaked. Each one is refused on its next request.

With `connected_apps: true` every connected app is removed as well, except the app making the call. A key or an app is not a signed-in device, so the call never ends its own access.

Scopes: `account:write`.

**Parameters**

- `connected_apps` (`Boolean`): Also removes every connected app, apart from the one making the call. Left out, apps stay.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `sessionsRevoked` and `appsRevoked`.

**Example**

```ruby
swept = client.account.revoke_sessions(connected_apps: true)

puts "#{swept[:sessionsRevoked]} devices and #{swept[:appsRevoked]} apps signed out"
```

**Notes**

- Safe to repeat: a second call finds nothing left and answers zero for both counts.

Also available in: API [`DELETE /account/sessions`](https://nextmail.sh/docs/api/reference/your-account#delete-account-sessions); TypeScript [`nextmail.account.revokeSessions()`](https://nextmail.sh/docs/sdk/reference/account#revokeSessions); Python [`account.revoke_sessions()`](https://nextmail.sh/docs/python/reference/account#revokeSessions); PHP [`account->revokeSessions`](https://nextmail.sh/docs/php/reference/account#revokeSessions); Go [`Account.RevokeSessions`](https://nextmail.sh/docs/go/reference/account#revokeSessions); Java [`account().revokeSessions`](https://nextmail.sh/docs/java/reference/account#revokeSessions); C# [`Account.RevokeSessionsAsync`](https://nextmail.sh/docs/csharp/reference/account#revokeSessions); CLI [`nextmail account revoke-sessions`](https://nextmail.sh/docs/cli/reference/account#account-revoke-sessions).

### `account.list_security_events`

Read your security log

```ruby
list_security_events(limit: nil, cursor: nil, api_key: nil) -> Nextmail::Page
```

Returns one page of what happened to the sign-in of the account, newest first: each sign-in with its device and place, devices signed out, password changes and resets, two-factor turned on or off, and passkeys added or removed. Nothing is ever removed from it.

Scopes: `account:read`.

**Parameters**

- `limit` (`Integer`): Page size, from 1 to 100. The server defaults to 25.
- `cursor` (`String`): The `next_cursor` of the previous page. Leave it out for the first page.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

The `Nextmail::Page` of Hashes with `items`, `has_more?` and `next_cursor`. Each item has `kind`, `at`, `device`, `country`, `city`, `authMethod` and `detail`.

**Example**

```ruby
page = client.account.list_security_events(limit: 50)

page.items.each { |event| puts "#{event[:at]} #{event[:kind]} #{event[:city]}" }
```

**Notes**

- A sign-in from a device not seen before has `newDevice` set to true in `detail`, and the person is told by email.
- A cursor that names nothing in this list is 400 `invalid_cursor`.

Also available in: API [`GET /account/security-events`](https://nextmail.sh/docs/api/reference/your-account#get-account-security-events); TypeScript [`nextmail.account.listSecurityEvents()`](https://nextmail.sh/docs/sdk/reference/account#listSecurityEvents); Python [`account.list_security_events()`](https://nextmail.sh/docs/python/reference/account#listSecurityEvents); PHP [`account->listSecurityEvents`](https://nextmail.sh/docs/php/reference/account#listSecurityEvents); Go [`Account.ListSecurityEvents`](https://nextmail.sh/docs/go/reference/account#listSecurityEvents); Java [`account().listSecurityEvents`](https://nextmail.sh/docs/java/reference/account#listSecurityEvents); C# [`Account.ListSecurityEventsAsync`](https://nextmail.sh/docs/csharp/reference/account#listSecurityEvents); CLI [`nextmail account list-security-events`](https://nextmail.sh/docs/cli/reference/account#account-list-security-events).

### `account.list_all_security_events`

Collect your whole security log into one Array

```ruby
list_all_security_events(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>
```

Walks every page of `list_security_events`. The log is never pruned, so use `iterate_security_events` to stop early on an old account.

Scopes: `account:read`.

**Parameters**

- `limit` (`Integer`): Page size for each request, 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk from this cursor instead of the newest entry.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Array of Hashes, newest first.

**Example**

```ruby
events = client.account.list_all_security_events(limit: 100)
sign_ins = events.count { |event| event[:kind] == "sign-in" }

puts "#{sign_ins} sign-ins on record"
```

**Notes**

- If any page fails, the error is raised and the entries already fetched are discarded.

Also available in: API [`GET /account/security-events`](https://nextmail.sh/docs/api/reference/your-account#get-account-security-events); TypeScript [`nextmail.account.listAllSecurityEvents()`](https://nextmail.sh/docs/sdk/reference/account#listAllSecurityEvents); Python [`account.list_all_security_events()`](https://nextmail.sh/docs/python/reference/account#listAllSecurityEvents); PHP [`account->listAllSecurityEvents`](https://nextmail.sh/docs/php/reference/account#listAllSecurityEvents); Go [`Account.ListAllSecurityEvents`](https://nextmail.sh/docs/go/reference/account#listAllSecurityEvents); Java [`account().listAllSecurityEvents`](https://nextmail.sh/docs/java/reference/account#listAllSecurityEvents); C# [`Account.ListAllSecurityEventsAsync`](https://nextmail.sh/docs/csharp/reference/account#listAllSecurityEvents).

### `account.iterate_security_events`

Stream your security log one entry at a time

```ruby
iterate_security_events(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>
```

An Enumerator over `list_security_events`, fetching a page only when the one before is drained. Given a block, it yields each entry to the block instead.

Scopes: `account:read`.

**Parameters**

- `limit` (`Integer`): Page size for each request, 1 to 100. The server defaults to 25.
- `cursor` (`String`): Starts the walk from this cursor instead of the newest entry.
- `api_key` (`String`): Overrides the client API key for every page of this walk.

**Returns**

An Enumerator of Hashes, newest first (or yields each one to a block).

**Example**

```ruby
changed = client.account.iterate_security_events.find { |event| event[:kind] == "password-changed" }

puts "Password last changed #{changed[:at]}" if changed
```

**Notes**

- Breaking out of the loop stops the walk, and no further page is fetched.

Also available in: API [`GET /account/security-events`](https://nextmail.sh/docs/api/reference/your-account#get-account-security-events); TypeScript [`nextmail.account.iterateSecurityEvents()`](https://nextmail.sh/docs/sdk/reference/account#iterateSecurityEvents); Python [`account.iterate_security_events()`](https://nextmail.sh/docs/python/reference/account#iterateSecurityEvents); PHP [`account->iterateSecurityEvents`](https://nextmail.sh/docs/php/reference/account#iterateSecurityEvents); Go [`Account.IterateSecurityEvents`](https://nextmail.sh/docs/go/reference/account#iterateSecurityEvents); Java [`account().iterateSecurityEvents`](https://nextmail.sh/docs/java/reference/account#iterateSecurityEvents); C# [`Account.IterateSecurityEventsAsync`](https://nextmail.sh/docs/csharp/reference/account#iterateSecurityEvents).

### `account.list_passkeys`

List your passkeys

```ruby
list_passkeys(api_key: nil) -> Array<Hash>
```

Returns the passkeys that can sign in to the account, oldest first, each with its name, whether it is synced between the person's devices and when it was last used.

A passkey is added on the device that holds it, in Account, Security, never through the API.

Scopes: `account:read`.

**Parameters**

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

**Returns**

An Array of Hashes, each with `id`, `name`, `synced`, `transports`, `createdAt` and `lastUsedAt`.

**Example**

```ruby
passkeys = client.account.list_passkeys

passkeys.each { |passkey| puts "#{passkey[:name]} #{passkey[:lastUsedAt] || "never used"}" }
```

**Notes**

- The key itself is never returned, only its name and when it was used.

Also available in: API [`GET /account/passkeys`](https://nextmail.sh/docs/api/reference/your-account#get-account-passkeys); TypeScript [`nextmail.account.listPasskeys()`](https://nextmail.sh/docs/sdk/reference/account#listPasskeys); Python [`account.list_passkeys()`](https://nextmail.sh/docs/python/reference/account#listPasskeys); PHP [`account->listPasskeys`](https://nextmail.sh/docs/php/reference/account#listPasskeys); Go [`Account.ListPasskeys`](https://nextmail.sh/docs/go/reference/account#listPasskeys); Java [`account().listPasskeys`](https://nextmail.sh/docs/java/reference/account#listPasskeys); C# [`Account.ListPasskeysAsync`](https://nextmail.sh/docs/csharp/reference/account#listPasskeys); CLI [`nextmail account list-passkeys`](https://nextmail.sh/docs/cli/reference/account#account-list-passkeys).

### `account.rename_passkey`

Rename a passkey

```ruby
rename_passkey(passkey_id, name, api_key: nil) -> Hash
```

Gives a passkey a name the person will recognise, such as the device that holds it.

Scopes: `account:write`.

**Parameters**

- `passkey_id` (`String`, required): The passkey's `id` from `list_passkeys`.
- `name` (`String`, required): The new name, 1 to 60 characters.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

The same Hash as an item of `list_passkeys`, with its new `name`.

**Example**

```ruby
passkey = client.account.list_passkeys.first

client.account.rename_passkey(passkey[:id], "Work laptop") if passkey
```

**Notes**

- A passkey that is not on the account is a 404 `resource_not_found`.
- A name that is empty or longer than 60 characters is a 422 `invalid_parameter`.

Also available in: API [`PATCH /account/passkeys/{passkeyId}`](https://nextmail.sh/docs/api/reference/your-account#patch-account-passkeys-passkeyid); TypeScript [`nextmail.account.renamePasskey()`](https://nextmail.sh/docs/sdk/reference/account#renamePasskey); Python [`account.rename_passkey()`](https://nextmail.sh/docs/python/reference/account#renamePasskey); PHP [`account->renamePasskey`](https://nextmail.sh/docs/php/reference/account#renamePasskey); Go [`Account.RenamePasskey`](https://nextmail.sh/docs/go/reference/account#renamePasskey); Java [`account().renamePasskey`](https://nextmail.sh/docs/java/reference/account#renamePasskey); C# [`Account.RenamePasskeyAsync`](https://nextmail.sh/docs/csharp/reference/account#renamePasskey); CLI [`nextmail account rename-passkey`](https://nextmail.sh/docs/cli/reference/account#account-rename-passkey).

### `account.remove_passkey`

Remove a passkey

```ruby
remove_passkey(passkey_id, api_key: nil) -> Hash
```

Removes a passkey, so it can no longer sign in or confirm a change. The person is told by email, and it is written to their security log. The passkey stays on the device until they delete it there.

Scopes: `account:write`.

**Parameters**

- `passkey_id` (`String`, required): The passkey's `id` from `list_passkeys`.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `removed` set to true.

**Example**

```ruby
passkeys = client.account.list_passkeys
unused = passkeys.select { |passkey| passkey[:lastUsedAt].nil? }

unused.each { |passkey| client.account.remove_passkey(passkey[:id]) }
```

**Notes**

- A passkey that is not on the account is a 404 `resource_not_found`.
- Not retried automatically. A retry after a lost response is a 404, since the passkey is already gone.

Also available in: API [`DELETE /account/passkeys/{passkeyId}`](https://nextmail.sh/docs/api/reference/your-account#delete-account-passkeys-passkeyid); TypeScript [`nextmail.account.removePasskey()`](https://nextmail.sh/docs/sdk/reference/account#removePasskey); Python [`account.remove_passkey()`](https://nextmail.sh/docs/python/reference/account#removePasskey); PHP [`account->removePasskey`](https://nextmail.sh/docs/php/reference/account#removePasskey); Go [`Account.RemovePasskey`](https://nextmail.sh/docs/go/reference/account#removePasskey); Java [`account().removePasskey`](https://nextmail.sh/docs/java/reference/account#removePasskey); C# [`Account.RemovePasskeyAsync`](https://nextmail.sh/docs/csharp/reference/account#removePasskey); CLI [`nextmail account remove-passkey`](https://nextmail.sh/docs/cli/reference/account#account-remove-passkey).

### `account.list_invitations`

List your invitations

```ruby
list_invitations(api_key: nil) -> Array<Hash>
```

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` (`String`): Overrides the client's API key for this call only.

**Returns**

An Array of Hashes, each with `id`, `workspaceName`, `roleName`, `inviterName`, `addresses` and `expiresAt`.

**Example**

```ruby
invitations = client.account.list_invitations

invitations.each { |invitation| puts "#{invitation[:workspaceName]} #{invitation[:roleName]}" }
```

**Notes**

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

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

### `account.accept_invitation`

Accept an invitation

```ruby
accept_invitation(invitation_id, activate: nil, api_key: nil) -> Hash
```

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` (`String`, required): An invitation id from `list_invitations`.
- `activate` (`Boolean`): True to make it the workspace the app opens. Defaults to false.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```ruby
first = client.account.list_invitations.first

if first
  joined = client.account.accept_invitation(first[:id], activate: true)
  puts joined[:workspaceName]
end
```

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

### `account.decline_invitation`

Decline an invitation

```ruby
decline_invitation(invitation_id, api_key: nil) -> Hash
```

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` (`String`, required): An invitation id from `list_invitations`.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `declined` set to true.

**Example**

```ruby
client.account.decline_invitation("winv_6bb640f5b99e47deb758f1f5")
```

**Notes**

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

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