Skip to the documentation
CLI

nextmail account

Every command in this namespace, with its arguments, flags and examples.

Commands

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.

Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags

openemail account get-notifications

Read your notification settings

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account get-notifications
Print the raw JSON
nextmail account get-notifications --json

Also available in

API
GET /account/notifications
TypeScript
nextmail.account.getNotifications()
Python
account.get_notifications()
Ruby
account.get_notifications
PHP
account->getNotifications
Go
Account.GetNotifications
Java
account().getNotifications
C#
Account.GetNotificationsAsync

openemail account set-email-notification

Turn a kind of email on or off

Scopesaccount:writeNeeds a sign-in

Usage

nextmail account set-email-notification <category> --enabled [flags]
nextmail account set-email-notification <category> --data <json|@file|-> [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.

Arguments

<category>Required

account, billing, activity or product.

Flags

--enabled

True to receive that email, false to stop it. Required, here or in --data.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Examples

nextmail account set-email-notification product --no-enabled
Read the whole body from a JSON file
nextmail account set-email-notification product --data @account.json

Also available in

API
PUT /account/notifications/email/{category}
TypeScript
nextmail.account.setEmailNotification()
Python
account.set_email_notification()
Ruby
account.set_email_notification
PHP
account->setEmailNotification
Go
Account.SetEmailNotification
Java
account().setEmailNotification
C#
Account.SetEmailNotificationAsync

openemail account set-push-muted

Mute a workspace on your phone

Scopesaccount:writeNeeds a sign-in

Usage

nextmail account set-push-muted <workspace-id> --muted [flags]
nextmail account set-push-muted <workspace-id> --data <json|@file|-> [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.

Arguments

<workspace-id>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 <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Examples

nextmail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --muted
Read the whole body from a JSON file
nextmail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --data @account.json

Also available in

API
PUT /account/notifications/push/{workspaceId}
TypeScript
nextmail.account.setPushMuted()
Python
account.set_push_muted()
Ruby
account.set_push_muted
PHP
account->setPushMuted
Go
Account.SetPushMuted
Java
account().setPushMuted
C#
Account.SetPushMutedAsync

openemail account set-photo

Set your profile photo

Scopesaccount:writeNeeds a sign-in

Usage

nextmail account set-photo <data> [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.

Arguments

<data>Required

The image: a Blob, ArrayBuffer or Uint8Array.

Flags

--content-type <value>

image/png, image/jpeg, image/webp or image/gif. Required unless data is a Blob with a type.

Examples

The required values only
nextmail account set-photo ./photo.jpg
With optional flags
nextmail account set-photo ./photo.jpg --content-type image/jpeg

Also available in

API
PUT /account/photo
TypeScript
nextmail.account.setPhoto()
Python
account.set_photo()
Ruby
account.set_photo
PHP
account->setPhoto
Go
Account.SetPhoto
Java
account().setPhoto
C#
Account.SetPhotoAsync

openemail account remove-photo

Remove your profile photo

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

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.

Examples

nextmail account remove-photo
Skip the confirmation, for scripts
nextmail account remove-photo --yes

Also available in

API
DELETE /account/photo
TypeScript
nextmail.account.removePhoto()
Python
account.remove_photo()
Ruby
account.remove_photo
PHP
account->removePhoto
Go
Account.RemovePhoto
Java
account().removePhoto
C#
Account.RemovePhotoAsync

openemail account get-username

Read your username

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account get-username
Print the raw JSON
nextmail account get-username --json

Also available in

API
GET /account/username
TypeScript
nextmail.account.getUsername()
Python
account.get_username()
Ruby
account.get_username
PHP
account->getUsername
Go
Account.GetUsername
Java
account().getUsername
C#
Account.GetUsernameAsync

openemail account check-username

Check a username

Scopesaccount:readNeeds a sign-in

Usage

nextmail account check-username <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.

Arguments

<username>Required

Up to 60 characters before it is tidied.

Examples

nextmail account check-username ada.lovelace
Print the raw JSON
nextmail account check-username ada.lovelace --json

Also available in

API
GET /account/username/availability
TypeScript
nextmail.account.checkUsername()
Python
account.check_username()
Ruby
account.check_username
PHP
account->checkUsername
Go
Account.CheckUsername
Java
account().checkUsername
C#
Account.CheckUsernameAsync

openemail account set-username

Choose your username

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

nextmail account set-username <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.

Arguments

<username>Required

3 to 30 lowercase letters, numbers and single dots once it is tidied.

Examples

nextmail account set-username ada.lovelace
Skip the confirmation, for scripts
nextmail account set-username ada.lovelace --yes

Also available in

API
PUT /account/username
TypeScript
nextmail.account.setUsername()
Python
account.set_username()
Ruby
account.set_username
PHP
account->setUsername
Go
Account.SetUsername
Java
account().setUsername
C#
Account.SetUsernameAsync

openemail account list-connected-apps

List your connected apps

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account list-connected-apps
Print the raw JSON
nextmail account list-connected-apps --json

Also available in

API
GET /account/connected-apps
TypeScript
nextmail.account.listConnectedApps()
Python
account.list_connected_apps()
Ruby
account.list_connected_apps
PHP
account->listConnectedApps
Go
Account.ListConnectedApps
Java
account().listConnectedApps
C#
Account.ListConnectedAppsAsync

openemail account list-connected-app-requests

Read the request log of a connected app

Scopesaccount:readNeeds a sign-in

Usage

nextmail account list-connected-app-requests <client-id> [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 <n> stops after that many items.

Arguments

<client-id>Required

The app's clientId, from listConnectedApps.

Flags

--failed-only

Only calls answered with a status of 400 or more.

--statuses <n,n>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 <when>

Only calls at or after this instant. A Date is sent as ISO 8601, and a string must already be one.

--until <when>

Only calls before this instant. It has to be later than since, or the server answers 400 invalid_parameter.

--limit <n>

Calls per page, a whole number from 1 to 100. The server defaults to 25.

Default25
--cursor <value>

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

Stop after this many items. Implies --all.

--ndjson

Print every item as one JSON object per line. Implies --all

Examples

The required values only
nextmail account list-connected-app-requests client_4c1b257a
With optional flags
nextmail account list-connected-app-requests client_4c1b257a --failed-only --limit 50
Walk every page and stop after 100 items
nextmail account list-connected-app-requests client_4c1b257a --all --max 100
One JSON object per line when piped
nextmail account list-connected-app-requests client_4c1b257a --all > account.ndjson

Also available in

API
GET /account/connected-apps/{clientId}/requests
TypeScript
nextmail.account.listConnectedAppRequests()
Python
account.list_connected_app_requests()
Ruby
account.list_connected_app_requests
PHP
account->listConnectedAppRequests
Go
Account.ListConnectedAppRequests
Java
account().listConnectedAppRequests
C#
Account.ListConnectedAppRequestsAsync

openemail account revoke-connected-app

Remove a connected app

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

nextmail account revoke-connected-app <client-id> [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.

Arguments

<client-id>Required

The app's clientId from listConnectedApps.

Examples

nextmail account revoke-connected-app client_4c1b257a
Skip the confirmation, for scripts
nextmail account revoke-connected-app client_4c1b257a --yes

Also available in

API
DELETE /account/connected-apps/{clientId}
TypeScript
nextmail.account.revokeConnectedApp()
Python
account.revoke_connected_app()
Ruby
account.revoke_connected_app
PHP
account->revokeConnectedApp
Go
Account.RevokeConnectedApp
Java
account().revokeConnectedApp
C#
Account.RevokeConnectedAppAsync

openemail account list-sessions

List your signed-in devices

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account list-sessions
Print the raw JSON
nextmail account list-sessions --json

Also available in

API
GET /account/sessions
TypeScript
nextmail.account.listSessions()
Python
account.list_sessions()
Ruby
account.list_sessions
PHP
account->listSessions
Go
Account.ListSessions
Java
account().listSessions
C#
Account.ListSessionsAsync

openemail account revoke-session

Sign out one device

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

nextmail account revoke-session <session-id> [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.

Arguments

<session-id>Required

The device's id from listSessions.

Examples

nextmail account revoke-session session_4c1b257a
Skip the confirmation, for scripts
nextmail account revoke-session session_4c1b257a --yes

Also available in

API
DELETE /account/sessions/{sessionId}
TypeScript
nextmail.account.revokeSession()
Python
account.revoke_session()
Ruby
account.revoke_session
PHP
account->revokeSession
Go
Account.RevokeSession
Java
account().revokeSession
C#
Account.RevokeSessionAsync

openemail account revoke-sessions

Sign out everywhere

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

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.

Flags

--connected-apps

Also removes every connected app, apart from the one making the call. Left out, apps stay.

Defaultfalse

Examples

nextmail account revoke-sessions
With optional flags
nextmail account revoke-sessions --connected-apps
Skip the confirmation, for scripts
nextmail account revoke-sessions --yes

Also available in

API
DELETE /account/sessions
TypeScript
nextmail.account.revokeSessions()
Python
account.revoke_sessions()
Ruby
account.revoke_sessions
PHP
account->revokeSessions
Go
Account.RevokeSessions
Java
account().revokeSessions
C#
Account.RevokeSessionsAsync

openemail account list-security-events

Read your security log

Scopesaccount:readNeeds a sign-in

Usage

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 <n> stops after that many items.

Flags

--limit <n>

Page size, from 1 to 100. The server defaults to 25.

Default25
--cursor <value>

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

Stop after this many items. Implies --all.

--ndjson

Print every item as one JSON object per line. Implies --all

Examples

nextmail account list-security-events
With optional flags
nextmail account list-security-events --limit 50
Walk every page and stop after 100 items
nextmail account list-security-events --all --max 100
One JSON object per line when piped
nextmail account list-security-events --all > account.ndjson

Also available in

API
GET /account/security-events
TypeScript
nextmail.account.listSecurityEvents()
Python
account.list_security_events()
Ruby
account.list_security_events
PHP
account->listSecurityEvents
Go
Account.ListSecurityEvents
Java
account().listSecurityEvents
C#
Account.ListSecurityEventsAsync

openemail account list-passkeys

List your passkeys

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account list-passkeys
Print the raw JSON
nextmail account list-passkeys --json

Also available in

API
GET /account/passkeys
TypeScript
nextmail.account.listPasskeys()
Python
account.list_passkeys()
Ruby
account.list_passkeys
PHP
account->listPasskeys
Go
Account.ListPasskeys
Java
account().listPasskeys
C#
Account.ListPasskeysAsync

openemail account rename-passkey

Rename a passkey

Scopesaccount:writeNeeds a sign-in

Usage

nextmail account rename-passkey <passkey-id> <name> [flags]

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

Arguments

<passkey-id>Required

The passkey's id from listPasskeys.

<name>Required

The new name, 1 to 60 characters.

Examples

nextmail account rename-passkey passkey_4c1b257a 'Work laptop'
Print the raw JSON
nextmail account rename-passkey passkey_4c1b257a 'Work laptop' --json

Also available in

API
PATCH /account/passkeys/{passkeyId}
TypeScript
nextmail.account.renamePasskey()
Python
account.rename_passkey()
Ruby
account.rename_passkey
PHP
account->renamePasskey
Go
Account.RenamePasskey
Java
account().renamePasskey
C#
Account.RenamePasskeyAsync

openemail account remove-passkey

Remove a passkey

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

nextmail account remove-passkey <passkey-id> [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.

Arguments

<passkey-id>Required

The passkey's id from listPasskeys.

Examples

nextmail account remove-passkey passkey_4c1b257a
Skip the confirmation, for scripts
nextmail account remove-passkey passkey_4c1b257a --yes

Also available in

API
DELETE /account/passkeys/{passkeyId}
TypeScript
nextmail.account.removePasskey()
Python
account.remove_passkey()
Ruby
account.remove_passkey
PHP
account->removePasskey
Go
Account.RemovePasskey
Java
account().removePasskey
C#
Account.RemovePasskeyAsync

openemail account list-invitations

List your invitations

Scopesaccount:readNeeds a sign-in

Usage

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.

Examples

nextmail account list-invitations
Print the raw JSON
nextmail account list-invitations --json

Also available in

API
GET /account/invitations
TypeScript
nextmail.account.listInvitations()
Python
account.list_invitations()
Ruby
account.list_invitations
PHP
account->listInvitations
Go
Account.ListInvitations
Java
account().listInvitations
C#
Account.ListInvitationsAsync

openemail account accept-invitation

Accept an invitation

Scopesaccount:writeNeeds a sign-in

Usage

nextmail account accept-invitation <invitation-id> [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.

Arguments

<invitation-id>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
nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5
With optional flags
nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5 --activate

Also available in

API
POST /account/invitations/{invitationId}/accept
TypeScript
nextmail.account.acceptInvitation()
Python
account.accept_invitation()
Ruby
account.accept_invitation
PHP
account->acceptInvitation
Go
Account.AcceptInvitation
Java
account().acceptInvitation
C#
Account.AcceptInvitationAsync

openemail account decline-invitation

Decline an invitation

Scopesaccount:writeNeeds a sign-in
Asks you to confirm

Usage

nextmail account decline-invitation <invitation-id> [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.

Arguments

<invitation-id>Required

An invitation id from listInvitations.

Examples

nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5
Skip the confirmation, for scripts
nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5 --yes

Also available in

API
POST /account/invitations/{invitationId}/decline
TypeScript
nextmail.account.declineInvitation()
Python
account.decline_invitation()
Ruby
account.decline_invitation
PHP
account->declineInvitation
Go
Account.DeclineInvitation
Java
account().declineInvitation
C#
Account.DeclineInvitationAsync