--- title: "nextmail account" description: "Every command in this namespace, with its arguments, flags and examples." url: "https://nextmail.sh/docs/cli/reference/account" area: "CLI" category: "Reference" --- # nextmail account Every command in this namespace, with its arguments, flags and examples. ## Commands ### `nextmail account get-notifications` Read your notification settings ```bash nextmail account get-notifications [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account get-notifications ``` Print the raw JSON ```bash nextmail account get-notifications --json ``` 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); Ruby [`account.get_notifications`](https://nextmail.sh/docs/ruby/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). ### `nextmail account set-email-notification` Turn a kind of email on or off ```bash nextmail account set-email-notification --enabled [flags] nextmail account set-email-notification --data [flags] ``` `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`. - Needs a sign-in. **Arguments** - `` (required): `account`, `billing`, `activity` or `product`. **Flags** - `--enabled`: True to receive that email, false to stop it. Required, here or in `--data`. - `--data `: The whole `body` as JSON, inline, from a file with @path, or - for standard input. Flags override its keys. **Examples** ```bash nextmail account set-email-notification product --no-enabled ``` Read the whole body from a JSON file ```bash nextmail account set-email-notification product --data @account.json ``` 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); Ruby [`account.set_email_notification`](https://nextmail.sh/docs/ruby/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). ### `nextmail account set-push-muted` Mute a workspace on your phone ```bash nextmail account set-push-muted --muted [flags] nextmail account set-push-muted --data [flags] ``` `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`. - Needs a sign-in. **Arguments** - `` (required): A workspace id from `workspaces.list`. **Flags** - `--muted`: True to mute it, false to let it notify again. Required, here or in `--data`. - `--data `: The whole `body` as JSON, inline, from a file with @path, or - for standard input. Flags override its keys. **Examples** ```bash nextmail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --muted ``` Read the whole body from a JSON file ```bash nextmail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --data @account.json ``` 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); Ruby [`account.set_push_muted`](https://nextmail.sh/docs/ruby/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). ### `nextmail account set-photo` Set your profile photo ```bash nextmail account set-photo [flags] ``` 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 `Blob`, an `ArrayBuffer` or a `Uint8Array`. The type is read from `--content-type`, or from a `Blob`'s own type when that is left out. Without either the bytes go as `application/octet-stream` and the server refuses them with 422 `invalid_image`. - Scopes: `account:write`. - Needs a sign-in. **Arguments** - `` (required): The image: a `Blob`, `ArrayBuffer` or `Uint8Array`. **Flags** - `--content-type `: `image/png`, `image/jpeg`, `image/webp` or `image/gif`. Required unless `data` is a `Blob` with a type. **Examples** The required values only ```bash nextmail account set-photo ./photo.jpg ``` With optional flags ```bash nextmail account set-photo ./photo.jpg --content-type image/jpeg ``` 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); Ruby [`account.set_photo`](https://nextmail.sh/docs/ruby/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). ### `nextmail account remove-photo` Remove your profile photo ```bash nextmail account remove-photo [flags] ``` 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`. - Needs a sign-in. - Asks you to confirm. **Examples** ```bash nextmail account remove-photo ``` Skip the confirmation, for scripts ```bash nextmail account remove-photo --yes ``` 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); Ruby [`account.remove_photo`](https://nextmail.sh/docs/ruby/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). ### `nextmail account get-username` Read your username ```bash nextmail account get-username [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account get-username ``` Print the raw JSON ```bash nextmail account get-username --json ``` 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); Ruby [`account.get_username`](https://nextmail.sh/docs/ruby/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). ### `nextmail account check-username` Check a username ```bash nextmail account check-username [flags] ``` 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`. - Needs a sign-in. **Arguments** - `` (required): Up to 60 characters before it is tidied. **Examples** ```bash nextmail account check-username ada.lovelace ``` Print the raw JSON ```bash nextmail account check-username ada.lovelace --json ``` 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); Ruby [`account.check_username`](https://nextmail.sh/docs/ruby/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). ### `nextmail account set-username` Choose your username ```bash nextmail account set-username [flags] ``` 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 `checkUsername`. - Scopes: `account:write`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): 3 to 30 lowercase letters, numbers and single dots once it is tidied. **Examples** ```bash nextmail account set-username ada.lovelace ``` Skip the confirmation, for scripts ```bash nextmail account set-username ada.lovelace --yes ``` 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); Ruby [`account.set_username`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-connected-apps` List your connected apps ```bash nextmail account list-connected-apps [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account list-connected-apps ``` Print the raw JSON ```bash nextmail account list-connected-apps --json ``` 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); Ruby [`account.list_connected_apps`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-connected-app-requests` Read the request log of a connected app ```bash nextmail account list-connected-app-requests [flags] ``` Resolves 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. Add `--all` to walk every page: a table on a terminal, one JSON object per line when piped or with `--ndjson`, and one `{ items, hasMore, nextCursor }` document with `--json`. `--max ` stops after that many items. - Scopes: `account:read`. - Needs a sign-in. **Arguments** - `` (required): The app's `clientId`, from `listConnectedApps`. **Flags** - `--failed-only`: Only calls answered with a status of 400 or more. - `--statuses ` (repeatable): 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 `: Only calls at or after this instant. A `Date` is sent as ISO 8601, and a string must already be one. - `--until `: Only calls before this instant. It has to be later than `since`, or the server answers 400 `invalid_parameter`. - `--limit ` (default `25`): Calls per page, a whole number from 1 to 100. The server defaults to 25. - `--cursor `: The `nextCursor` of the previous page, passed back unchanged. Leave it out for the first page. - `--all`: Fetch every page and stream the items as they arrive. - `--max `: Stop after this many items. Implies `--all`. - `--ndjson`: Print every item as one JSON object per line. Implies `--all` **Examples** The required values only ```bash nextmail account list-connected-app-requests client_4c1b257a ``` With optional flags ```bash nextmail account list-connected-app-requests client_4c1b257a --failed-only --limit 50 ``` Walk every page and stop after 100 items ```bash nextmail account list-connected-app-requests client_4c1b257a --all --max 100 ``` One JSON object per line when piped ```bash nextmail account list-connected-app-requests client_4c1b257a --all > account.ndjson ``` 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); Ruby [`account.list_connected_app_requests`](https://nextmail.sh/docs/ruby/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). ### `nextmail account revoke-connected-app` Remove a connected app ```bash nextmail account revoke-connected-app [flags] ``` 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`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): The app's `clientId` from `listConnectedApps`. **Examples** ```bash nextmail account revoke-connected-app client_4c1b257a ``` Skip the confirmation, for scripts ```bash nextmail account revoke-connected-app client_4c1b257a --yes ``` 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); Ruby [`account.revoke_connected_app`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-sessions` List your signed-in devices ```bash nextmail account list-sessions [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account list-sessions ``` Print the raw JSON ```bash nextmail account list-sessions --json ``` 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); Ruby [`account.list_sessions`](https://nextmail.sh/docs/ruby/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). ### `nextmail account revoke-session` Sign out one device ```bash nextmail account revoke-session [flags] ``` 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`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): The device's `id` from `listSessions`. **Examples** ```bash nextmail account revoke-session session_4c1b257a ``` Skip the confirmation, for scripts ```bash nextmail account revoke-session session_4c1b257a --yes ``` 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); Ruby [`account.revoke_session`](https://nextmail.sh/docs/ruby/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). ### `nextmail account revoke-sessions` Sign out everywhere ```bash nextmail account revoke-sessions [flags] ``` 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 `connectedApps: 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`. - Needs a sign-in. - Asks you to confirm. **Flags** - `--connected-apps` (default `false`): Also removes every connected app, apart from the one making the call. Left out, apps stay. **Examples** ```bash nextmail account revoke-sessions ``` With optional flags ```bash nextmail account revoke-sessions --connected-apps ``` Skip the confirmation, for scripts ```bash nextmail account revoke-sessions --yes ``` 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); Ruby [`account.revoke_sessions`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-security-events` Read your security log ```bash nextmail account list-security-events [flags] ``` Resolves 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. Add `--all` to walk every page: a table on a terminal, one JSON object per line when piped or with `--ndjson`, and one `{ items, hasMore, nextCursor }` document with `--json`. `--max ` stops after that many items. - Scopes: `account:read`. - Needs a sign-in. **Flags** - `--limit ` (default `25`): Page size, from 1 to 100. The server defaults to 25. - `--cursor `: The `nextCursor` of the previous page. Leave it out for the first page. - `--all`: Fetch every page and stream the items as they arrive. - `--max `: Stop after this many items. Implies `--all`. - `--ndjson`: Print every item as one JSON object per line. Implies `--all` **Examples** ```bash nextmail account list-security-events ``` With optional flags ```bash nextmail account list-security-events --limit 50 ``` Walk every page and stop after 100 items ```bash nextmail account list-security-events --all --max 100 ``` One JSON object per line when piped ```bash nextmail account list-security-events --all > account.ndjson ``` 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); Ruby [`account.list_security_events`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-passkeys` List your passkeys ```bash nextmail account list-passkeys [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account list-passkeys ``` Print the raw JSON ```bash nextmail account list-passkeys --json ``` 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); Ruby [`account.list_passkeys`](https://nextmail.sh/docs/ruby/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). ### `nextmail account rename-passkey` Rename a passkey ```bash nextmail account rename-passkey [flags] ``` Gives a passkey a name the person will recognise, such as the device that holds it. - Scopes: `account:write`. - Needs a sign-in. **Arguments** - `` (required): The passkey's `id` from `listPasskeys`. - `` (required): The new name, 1 to 60 characters. **Examples** ```bash nextmail account rename-passkey passkey_4c1b257a 'Work laptop' ``` Print the raw JSON ```bash nextmail account rename-passkey passkey_4c1b257a 'Work laptop' --json ``` 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); Ruby [`account.rename_passkey`](https://nextmail.sh/docs/ruby/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). ### `nextmail account remove-passkey` Remove a passkey ```bash nextmail account remove-passkey [flags] ``` 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`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): The passkey's `id` from `listPasskeys`. **Examples** ```bash nextmail account remove-passkey passkey_4c1b257a ``` Skip the confirmation, for scripts ```bash nextmail account remove-passkey passkey_4c1b257a --yes ``` 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); Ruby [`account.remove_passkey`](https://nextmail.sh/docs/ruby/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). ### `nextmail account list-invitations` List your invitations ```bash nextmail account list-invitations [flags] ``` Resolves 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`. - Needs a sign-in. **Examples** ```bash nextmail account list-invitations ``` Print the raw JSON ```bash nextmail account list-invitations --json ``` 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); Ruby [`account.list_invitations`](https://nextmail.sh/docs/ruby/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). ### `nextmail account accept-invitation` Accept an invitation ```bash nextmail account accept-invitation [flags] ``` 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`. - Needs a sign-in. **Arguments** - `` (required): An invitation id from `listInvitations`. **Flags** - `--activate`: True to make it the workspace the app opens. Defaults to false. **Examples** The required values only ```bash nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5 ``` With optional flags ```bash nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5 --activate ``` 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); Ruby [`account.accept_invitation`](https://nextmail.sh/docs/ruby/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). ### `nextmail account decline-invitation` Decline an invitation ```bash nextmail account decline-invitation [flags] ``` 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`. - Needs a sign-in. - Asks you to confirm. **Arguments** - `` (required): An invitation id from `listInvitations`. **Examples** ```bash nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5 ``` Skip the confirmation, for scripts ```bash nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5 --yes ``` 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); Ruby [`account.decline_invitation`](https://nextmail.sh/docs/ruby/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).