CLI

nextmail workspaces

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

Commands

The workspaces the person behind the key or the app can open: list them, create one, choose the one the app opens, and delete the workspace the key or the app belongs to. 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 workspaces list`

List your workspaces

account:readNeeds a sign-inAliasesls

Usage

nextmail workspaces list [flags]

Resolves every workspace the person behind the client can open, the ones they own first, as the workspace switcher of the app lists them. It is about the person, not the workspace the key belongs to. An API key answers for the workspace owner, and an app for the person who connected it.

activeWorkspaceId is the workspace the app opens for them, primaryWorkspaceId the first one they made, which can never be deleted, and personalWorkspaceId their personal space, which holds their free address and is not in data.

Examples

nextmail workspaces list

Print the raw JSON

nextmail workspaces list --json

Also available in

API: GET /workspaces
TypeScript: nextmail.workspaces.list()
Python: workspaces.list()
Ruby: workspaces.list
PHP: workspaces->list
Go: Workspaces.List
Java: workspaces().list
C#: Workspaces.ListAsync

`openemail workspaces create`

Create a workspace

account:writeNeeds a sign-inAliasesnewadd

Usage

nextmail workspaces create --name <value> [flags]
nextmail workspaces create --data <json|@file|-> [flags]

Makes a new workspace owned by the person, on the Free plan, and makes it the workspace the app opens for them, as creating one in the app does. The key or the app making the call keeps acting for its own workspace.

An account can own one workspace on the Free plan. While it owns one, the call is refused with 403 workspace_allowance_reached and the message names that workspace: upgrade it first.

Flags

--name <value>: Up to 64 characters. Leading and trailing spaces are trimmed. 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 workspaces create --name 'Acme Support'

Read the whole body from a JSON file

nextmail workspaces create --data @workspace.json

Also available in

API: POST /workspaces
TypeScript: nextmail.workspaces.create()
Python: workspaces.create()
Ruby: workspaces.create
PHP: workspaces->create
Go: Workspaces.Create
Java: workspaces().create
C#: Workspaces.CreateAsync

`openemail workspaces get-active`

Read the workspace the app opens

account:readNeeds a sign-in

Usage

nextmail workspaces get-active [flags]

Resolves the workspace the app opens for the person when they sign in, or the one it falls back to when they never chose one. It is not the workspace the key or the app acts on, which never changes.

Examples

nextmail workspaces get-active

Print the raw JSON

nextmail workspaces get-active --json

Also available in

API: GET /workspaces/active
TypeScript: nextmail.workspaces.getActive()
Python: workspaces.get_active()
Ruby: workspaces.get_active
PHP: workspaces->getActive
Go: Workspaces.GetActive
Java: workspaces().getActive
C#: Workspaces.GetActiveAsync

`openemail workspaces set-active`

Choose the workspace the app opens

account:writeNeeds a sign-in

Usage

nextmail workspaces set-active <workspace-id> [flags]

Switches the workspace the app opens for the person, as the workspace switcher does, to any workspace they can open. It changes nothing for the key or the app making the call, which keeps acting for its own workspace.

Arguments

<workspace-id>Required: A workspace id from list.

Examples

nextmail workspaces set-active 10417196-e324-4283-af98-66ec62167c47

Print the raw JSON

nextmail workspaces set-active 10417196-e324-4283-af98-66ec62167c47 --json

Also available in

API: PUT /workspaces/active
TypeScript: nextmail.workspaces.setActive()
Python: workspaces.set_active()
Ruby: workspaces.set_active
PHP: workspaces->setActive
Go: Workspaces.SetActive
Java: workspaces().setActive
C#: Workspaces.SetActiveAsync

`openemail workspaces delete`

Delete the workspace

account:writeNeeds a sign-in

Asks you to confirm

Aliasesrmdelremove

Usage

nextmail workspaces delete <id> --confirm <value> [flags]

Deletes the workspace the key or the app belongs to, with its domains, addresses, mail and members, and cancels its plan. It cannot be undone. --confirm has to be the name of the workspace, as list shows it, the same way the app asks the person to type it.

Only the owner may do it. An access token acting for a member is refused with 403 owner_only, and a key or an app limited to particular addresses or domains with 422 capability_unsupported. Any other workspace id is a 404, the first workspace an account made is refused with 409 first_workspace, and one with a domain being moved in or out with 409 domain_moving.

Arguments

<id>Required: The id of the workspace the key or the app belongs to, which me.get reports as workspaceId.

Flags

--confirm <value>: The name of the workspace. Letter case and the spaces around it do not matter. Sent as a query parameter. Required.

Examples

nextmail workspaces delete workspace_4c1b257a --confirm 'Acme Support'

Skip the confirmation, for scripts

nextmail workspaces delete workspace_4c1b257a --confirm 'Acme Support' --yes

Also available in

API: DELETE /workspaces/{id}
TypeScript: nextmail.workspaces.delete()
Python: workspaces.delete()
Ruby: workspaces.delete
PHP: workspaces->delete
Go: Workspaces.Delete
Java: workspaces().delete
C#: Workspaces.DeleteAsync

nextmail workspaces

Commands

Usage

Examples

Also available in

Usage

Flags

Examples

Also available in

Usage

Examples

Also available in

Usage

Arguments

Examples

Also available in

Usage

Arguments

Flags

Examples

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.