پرش به مستندات
CLI

openemail workspaces

هر فرمان در این فضای نام، با آرگومان‌ها، پرچم‌ها و نمونه‌هایش.

فرمان‌ها

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.

هر فرمان در اینجا پرچم‌های سراسری مانند --json، --profile و --dry-run را هم می‌پذیرد. پرچم‌های سراسری را ببینید

openemail workspaces list

List your workspaces

محدوده‌های دسترسیaccount:readبه ورود نیاز داردنام‌های مستعارls

نحوه استفاده

openemail 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.

نمونه‌ها

openemail workspaces list
Print the raw JSON
openemail workspaces list --json

همچنین در دسترس در

API
GET /workspaces
SDK
workspaces.list()

openemail workspaces create

Create a workspace

محدوده‌های دسترسیaccount:writeبه ورود نیاز داردنام‌های مستعارnewadd

نحوه استفاده

openemail workspaces create --name <value> [flags]
openemail 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.

پرچم‌ها

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

نمونه‌ها

openemail workspaces create --name 'Acme Support'
Read the whole body from a JSON file
openemail workspaces create --data @workspace.json

همچنین در دسترس در

API
POST /workspaces
SDK
workspaces.create()

openemail workspaces get-active

Read the workspace the app opens

محدوده‌های دسترسیaccount:readبه ورود نیاز دارد

نحوه استفاده

openemail 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.

نمونه‌ها

openemail workspaces get-active
Print the raw JSON
openemail workspaces get-active --json

همچنین در دسترس در

API
GET /workspaces/active
SDK
workspaces.getActive()

openemail workspaces set-active

Choose the workspace the app opens

محدوده‌های دسترسیaccount:writeبه ورود نیاز دارد

نحوه استفاده

openemail 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.

آرگومان‌ها

<workspace-id>الزامی

A workspace id from list.

نمونه‌ها

openemail workspaces set-active 10417196-e324-4283-af98-66ec62167c47
Print the raw JSON
openemail workspaces set-active 10417196-e324-4283-af98-66ec62167c47 --json

همچنین در دسترس در

API
PUT /workspaces/active
SDK
workspaces.setActive()

openemail workspaces delete

Delete the workspace

محدوده‌های دسترسیaccount:writeبه ورود نیاز دارد
از شما تأیید می‌خواهد
نام‌های مستعارrmdelremove

نحوه استفاده

openemail 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.

آرگومان‌ها

<id>الزامی

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

پرچم‌ها

--confirm <value>

The name of the workspace. Letter case and the spaces around it do not matter. Sent as a query parameter. Required.

نمونه‌ها

openemail workspaces delete workspace_4c1b257a --confirm 'Acme Support'
Skip the confirmation, for scripts
openemail workspaces delete workspace_4c1b257a --confirm 'Acme Support' --yes

همچنین در دسترس در

API
DELETE /workspaces/{id}
SDK
workspaces.delete()