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

`Workspaces.ListAsync`

List your workspaces

account:read

シグネチャ

Task<JsonObject> ListAsync(string? apiKey = null, CancellationToken cancellationToken = default)

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

パラメーター

apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

戻り値

A JsonObject with data, a list of objects, one per workspace, and activeWorkspaceId, primaryWorkspaceId and personalWorkspaceId.

例

var workspaces = await client.Workspaces.ListAsync(); Console.WriteLine(workspaces.ToJsonString());

注意事項

The key or the app still acts for its own workspace in every other call.

ほかの提供先

API: GET /workspaces
TypeScript: workspaces.list()
Python: workspaces.list()
Ruby: workspaces.list
PHP: workspaces->list
Go: Workspaces.List
Java: workspaces().list
CLI: openemail workspaces list

`Workspaces.CreateAsync`

Create a workspace

account:write

シグネチャ

Task<JsonObject> CreateAsync(    IReadOnlyDictionary<string, object?> body,    string? apiKey = null,    CancellationToken cancellationToken = default)

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.

パラメーター

namestring必須: Up to 64 characters. Leading and trailing spaces are trimmed.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

戻り値

A JsonObject with id, name, slug and active set to true.

例

try{    var workspace = await client.Workspaces.CreateAsync(new Body { ["name"] = "Acme Support" });     Console.WriteLine($"{workspace["id"]} {workspace["slug"]}");}catch (OpenEmailApiException error){    if (error.Code != "workspace_allowance_reached")    {        throw;    }     Console.WriteLine(error.Message);}

注意事項

Not retried automatically. The same name sent twice within ten seconds returns the workspace the first call made, so a retry right after a lost response is safe.

ほかの提供先

API: POST /workspaces
TypeScript: workspaces.create()
Python: workspaces.create()
Ruby: workspaces.create
PHP: workspaces->create
Go: Workspaces.Create
Java: workspaces().create
CLI: openemail workspaces create

`Workspaces.GetActiveAsync`

Read the workspace the app opens

account:read

シグネチャ

Task<JsonObject> GetActiveAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

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

パラメーター

apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

戻り値

A JsonObject with id, name, slug, email, kind, isOwner and createdAt.

例

var opened = await client.Workspaces.GetActiveAsync(); Console.WriteLine($"{opened["name"]} ({opened["kind"]})");

注意事項

kind is personal when the app opens the personal space.

ほかの提供先

API: GET /workspaces/active
TypeScript: workspaces.getActive()
Python: workspaces.get_active()
Ruby: workspaces.get_active
PHP: workspaces->getActive
Go: Workspaces.GetActive
Java: workspaces().getActive
CLI: openemail workspaces get-active

`Workspaces.SetActiveAsync`

Choose the workspace the app opens

account:write

シグネチャ

Task<JsonObject> SetActiveAsync(    string workspaceId,    string? apiKey = null,    CancellationToken cancellationToken = default)

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.

パラメーター

workspaceIdstring必須: A workspace id from ListAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

戻り値

The same object as Workspaces.GetActiveAsync, for the workspace the app opens now.

例

var workspaces = await client.Workspaces.ListAsync(); var opened = await client.Workspaces.SetActiveAsync(workspaces["primaryWorkspaceId"]!.GetValue<string>()); Console.WriteLine($"The app now opens {opened["name"]}");

注意事項

A workspace the person cannot open is a 404 resource_not_found.
Retried automatically on network failure, since choosing the same workspace twice changes nothing.

ほかの提供先

API: PUT /workspaces/active
TypeScript: workspaces.setActive()
Python: workspaces.set_active()
Ruby: workspaces.set_active
PHP: workspaces->setActive
Go: Workspaces.SetActive
Java: workspaces().setActive
CLI: openemail workspaces set-active

`Workspaces.DeleteAsync`

Delete the workspace

account:write

シグネチャ

Task<JsonObject> DeleteAsync(    string id,    string confirm,    string? apiKey = null,    CancellationToken cancellationToken = default)

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

パラメーター

idstring必須: The id of the workspace the key or the app belongs to, which Me.GetAsync reports as workspaceId.
confirmstring必須: The name of the workspace. Letter case and the spaces around it do not matter. Sent as a query parameter.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

戻り値

A JsonObject with id, deleted set to true and activeWorkspaceId, the workspace the app opens from now on.

例

var key = await client.Me.GetAsync(); var deleted = await client.Workspaces.DeleteAsync(key["workspaceId"]!.GetValue<string>(), "Acme Support"); Console.WriteLine($"Deleted. The app now opens {deleted["activeWorkspaceId"]}");

注意事項

An OAuth access token needs a verification code for this call, and is refused with 403 step_up_required until the app has verified one in the last 60 minutes. IsStepUpRequired on the error says so. An API key is never asked for a code.
The key or the app loses its workspace with it, so every later call with it is refused.
Not retried automatically. A retry after a lost response is a 404, since the workspace is already gone.

ほかの提供先

API: DELETE /workspaces/{id}
TypeScript: workspaces.delete()
Python: workspaces.delete()
Ruby: workspaces.delete
PHP: workspaces->delete
Go: Workspaces.Delete
Java: workspaces().delete
CLI: openemail workspaces delete

client.Workspaces

メソッド

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

受信トレイを、あなたの思いどおりに。

受信トレイを、
あなたの思いどおりに。