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
account get-notificationsaccount set-email-notificationaccount set-push-mutedaccount set-photoaccount remove-photoaccount get-usernameaccount check-usernameaccount set-usernameaccount list-connected-appsaccount list-connected-app-requestsaccount revoke-connected-appaccount list-sessionsaccount revoke-sessionaccount revoke-sessionsaccount list-security-eventsaccount list-passkeysaccount rename-passkeyaccount remove-passkeyaccount list-invitationsaccount accept-invitationaccount decline-invitation
nextmail account get-notifications
Read your notification settings
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-notificationsnextmail account get-notifications --jsonAlso available in
nextmail account set-email-notification
Turn a kind of email on or off
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>Requiredaccount,billing,activityorproduct.
Flags
--enabledTrue to receive that email, false to stop it. Required, here or in
--data.--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Examples
nextmail account set-email-notification product --no-enablednextmail account set-email-notification product --data @account.jsonAlso available in
nextmail account set-push-muted
Mute a workspace on your phone
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>RequiredA workspace id from
workspaces.list.
Flags
--mutedTrue to mute it, false to let it notify again. Required, here or in
--data.--data <json|@file|->The whole
bodyas 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 --mutednextmail account set-push-muted 10417196-e324-4283-af98-66ec62167c47 --data @account.jsonAlso available in
nextmail account set-photo
Set your profile photo
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>RequiredThe image: a
Blob,ArrayBufferorUint8Array.
Flags
--content-type <value>image/png,image/jpeg,image/webporimage/gif. Required unlessdatais aBlobwith a type.
Examples
nextmail account set-photo ./photo.jpgnextmail account set-photo ./photo.jpg --content-type image/jpegAlso available in
nextmail account remove-photo
Remove your profile photo
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-photonextmail account remove-photo --yesAlso available in
nextmail account get-username
Read your username
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-usernamenextmail account get-username --jsonAlso available in
nextmail account check-username
Check a username
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>RequiredUp to 60 characters before it is tidied.
Examples
nextmail account check-username ada.lovelacenextmail account check-username ada.lovelace --jsonAlso available in
nextmail account set-username
Choose your username
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>Required3 to 30 lowercase letters, numbers and single dots once it is tidied.
Examples
nextmail account set-username ada.lovelacenextmail account set-username ada.lovelace --yesAlso available in
nextmail account list-connected-apps
List your connected apps
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-appsnextmail account list-connected-apps --jsonAlso available in
nextmail account list-connected-app-requests
Read the request log of a connected app
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>RequiredThe app's
clientId, fromlistConnectedApps.
Flags
--failed-onlyOnly calls answered with a status of 400 or more.
--statuses <n,n>RepeatableOnly calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.--since <when>Only calls at or after this instant. A
Dateis 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 400invalid_parameter.--limit <n>Calls per page, a whole number from 1 to 100. The server defaults to 25.
Default25--cursor <value>The
nextCursorof the previous page, passed back unchanged. Leave it out for the first page.--allFetch every page and stream the items as they arrive.
--max <n>Stop after this many items. Implies
--all.--ndjsonPrint every item as one JSON object per line. Implies
--all
Examples
nextmail account list-connected-app-requests client_4c1b257anextmail account list-connected-app-requests client_4c1b257a --failed-only --limit 50nextmail account list-connected-app-requests client_4c1b257a --all --max 100nextmail account list-connected-app-requests client_4c1b257a --all > account.ndjsonAlso 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
nextmail account revoke-connected-app
Remove a connected app
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>RequiredThe app's
clientIdfromlistConnectedApps.
Examples
nextmail account revoke-connected-app client_4c1b257anextmail account revoke-connected-app client_4c1b257a --yesAlso available in
nextmail account list-sessions
List your signed-in devices
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-sessionsnextmail account list-sessions --jsonAlso available in
nextmail account revoke-session
Sign out one device
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>RequiredThe device's
idfromlistSessions.
Examples
nextmail account revoke-session session_4c1b257anextmail account revoke-session session_4c1b257a --yesAlso available in
nextmail account revoke-sessions
Sign out everywhere
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-appsAlso removes every connected app, apart from the one making the call. Left out, apps stay.
Defaultfalse
Examples
nextmail account revoke-sessionsnextmail account revoke-sessions --connected-appsnextmail account revoke-sessions --yesAlso available in
nextmail account list-security-events
Read your security log
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
nextCursorof the previous page. Leave it out for the first page.--allFetch every page and stream the items as they arrive.
--max <n>Stop after this many items. Implies
--all.--ndjsonPrint every item as one JSON object per line. Implies
--all
Examples
nextmail account list-security-eventsnextmail account list-security-events --limit 50nextmail account list-security-events --all --max 100nextmail account list-security-events --all > account.ndjsonAlso available in
nextmail account list-passkeys
List your passkeys
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-passkeysnextmail account list-passkeys --jsonAlso available in
nextmail account rename-passkey
Rename a passkey
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>RequiredThe passkey's
idfromlistPasskeys.<name>RequiredThe new name, 1 to 60 characters.
Examples
nextmail account rename-passkey passkey_4c1b257a 'Work laptop'nextmail account rename-passkey passkey_4c1b257a 'Work laptop' --jsonAlso available in
nextmail account remove-passkey
Remove a passkey
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>RequiredThe passkey's
idfromlistPasskeys.
Examples
nextmail account remove-passkey passkey_4c1b257anextmail account remove-passkey passkey_4c1b257a --yesAlso available in
nextmail account list-invitations
List your invitations
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-invitationsnextmail account list-invitations --jsonAlso available in
nextmail account accept-invitation
Accept an invitation
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>RequiredAn invitation id from
listInvitations.
Flags
--activateTrue to make it the workspace the app opens. Defaults to false.
Examples
nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5nextmail account accept-invitation winv_6bb640f5b99e47deb758f1f5 --activateAlso available in
nextmail account decline-invitation
Decline an invitation
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>RequiredAn invitation id from
listInvitations.
Examples
nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5nextmail account decline-invitation winv_6bb640f5b99e47deb758f1f5 --yes
Google Workspace