あなたのアカウント
その人のワークスペース、メール、写真、ユーザー名、アプリ、招待。
あなたのアカウントのツール
| ツール | 機能 |
|---|---|
| listAccountWorkspaces | あなたのアカウントが開けるすべてのワークスペース。所有するものも参加したものも含み、アプリがあなたのために開くものと、これらのツールが操作するものも示す。 |
| switchAppWorkspace | アプリがあなたのために開くワークスペースを選ぶ。これらのツールは、いま操作しているワークスペースを引き続き操作する。 |
| createWorkspace | 自分が所有するワークスペースを Free プランで作成し、以後アプリはそれをあなたのために開く。1 つのアカウントが所有できる Free ワークスペースは 1 つ。 |
| deleteWorkspace | confirm でワークスペース名を指定すると、これらのツールが操作するワークスペースを中身ごと削除する。削除できるのは所有者だけで、アカウントが最初に作ったワークスペースは削除できない。アプリのチャットでは必ず先に確認する。 |
| getNotificationSettings | OpenEmail があなたに送るメールの種類と、スマートフォンでミュートしているワークスペース。 |
| setEmailNotification | activity または product のメールをオンまたはオフにする。account と billing のメールは常にオン。 |
| setWorkspacePushMuted | 1 つのワークスペースのスマートフォン通知をミュートまたはミュート解除する。 |
| setProfilePhoto | base64 の画像からプロフィール写真を設定する。 |
| removeProfilePhoto | プロフィール写真を削除する。アプリのチャットでは必ず先に確認する。 |
| getUsername | あなたのユーザー名、それを自分で選んだかどうか、それで得られる無料アドレス。 |
| checkUsername | ユーザー名を選べるかどうかと、選べない場合はその理由。 |
| chooseUsername | ユーザー名を確定する。一度選ぶと二度と変わらない。アプリのチャットでは必ず先に確認する。 |
| listConnectedApps | 接続したアプリと、それぞれがアクセスできる範囲と期限。 |
| revokeConnectedApp | 接続済みアプリを削除し、もう一度許可を求めさせる。アプリのチャットでは必ず先に確認する。 |
| listReceivedInvitations | あなたを待っているワークスペースへの招待。ワークスペースが送った招待には listInvitations を使う。 |
| acceptInvitation | 招待のワークスペースに参加し、activate を付けるとアプリが開くワークスペースにする。 |
| declineInvitation | 招待を辞退する。取り消しはできない。アプリのチャットでは必ず先に確認する。 |
これらのツールはクライアントを接続した本人に対して動作し、ほかの誰にも動作しない。アプリのチャットではあなたに対して動作する。読み取りには account:read、変更には account:write が必要で、どちらもロールでは制限されないため、メンバーが接続したクライアントはそのメンバー自身のアカウントにもアクセスできる。
3 つの操作はアプリでしかできない: 接続済みアプリがアクセスできる範囲の変更、確認コードなしで変更できるようにすること、アカウント全体の削除。
ワークスペースのツールがほかのツールの対象を動かすことはない。switchAppWorkspace はアプリが開くものを変え、setActiveConnection はツールが操作するものを変える。
このサーバーの一部のツールは、REST API が確認コードで保護している変更を行うため、同じコードを求めます。クライアントが直近 60 分以内にコードを確認しておらず、本人がアカウント → 接続済みアプリでそのクライアントに「60分間、変更を許可」を選んでもいない間、これらのツールは Refused (step_up_required): で始まる結果を返し、何も変更しません。emptyAudience がコードを求めることはありません。コードを求めるツールの一覧と、コードの要求と確認の方法は API の認証ページにあります。
リファレンス
listAccountWorkspaces
Every workspace your OpenEmail account can open, the ones you own and the ones you joined, as the workspace switcher of the app lists them, with the one the app opens for you. It is about your account, not this connection: getConnections lists what these tools can act on, and switchAppWorkspace changes only what the app opens, never what these tools act on.
入力
入力はありません。
ほかの提供先
switchAppWorkspace
Choose which workspace the OpenEmail app opens for you, as the workspace switcher does. Pass a workspace id from listAccountWorkspaces. It changes the app only: these tools keep acting on the workspace they act on now.
入力
workspaceIdstring必須- 1〜128文字
ほかの提供先
createWorkspace
Create a new workspace that you own, on the Free plan, and make it the one the app opens for you, as creating one in the app does. An account can own one Free workspace, so while you own one this is refused until you upgrade it.
入力
namestring必須- 1〜64文字
ほかの提供先
deleteWorkspace
Delete the workspace these tools act on, with its domains, addresses, mail and members, and cancel its plan. It cannot be undone. Only its owner may do it, never through an app limited to some addresses, and your first workspace can never be deleted. confirm has to be the name of the workspace, as listAccountWorkspaces shows it.
- 確認コードが必要
DELETE /workspaces/{id}
入力
confirmstring必須The name of the workspace being deleted, typed out.
1〜256文字
ほかの提供先
getNotificationSettings
Which kinds of email OpenEmail sends you, as Account, Notifications shows them, and the workspaces whose notifications are muted on your phone. Account and billing email are always on.
入力
入力はありません。
ほかの提供先
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
入力
categorystring必須- 次のいずれか
"account""billing""activity""product" enabledboolean必須
ほかの提供先
setWorkspacePushMuted
Mute or unmute the notifications of one workspace on your phone, on every phone you signed in on. Pass a workspace id from listAccountWorkspaces.
入力
workspaceIdstring必須- 1〜128文字
mutedboolean必須
ほかの提供先
setProfilePhoto
Set your profile photo, replacing any there was, as Account, Profile does. Pass the picture in base64 as image, with its type as contentType: image/png, image/jpeg, image/webp, image/gif, up to 5 MB. It is fitted into a 512 pixel square.
入力
imagestring必須The image in base64, or as a data: URL.
1〜7340032文字contentTypestring必須The type of the image: image/png, image/jpeg, image/webp, image/gif.
1〜100文字
ほかの提供先
removeProfilePhoto
Remove your profile photo and delete the stored image, so the app shows your initials again. Removing it when there is none changes nothing.
入力
入力はありません。
ほかの提供先
getUsername
Your OpenEmail username, whether you chose it or it was made for you, and the free address it gives you. A username you chose never changes.
入力
入力はありません。
ほかの提供先
checkUsername
Whether you could choose a username, without choosing it, and why not when you could not. It is lowercased and its spaces become dots before it is checked.
入力
usernamestring必須- 1〜60文字
ほかの提供先
chooseUsername
Choose your username, and with it your free address, for good. Once chosen it never changes, so check it with checkUsername first and make sure it is the one you want.
入力
usernamestring必須- 1〜60文字
ほかの提供先
listConnectedApps
Every app you connected to your account with OAuth, as Account, Connected apps lists them: what each may reach, until when, and its client id, which revokeConnectedApp takes. What an app may reach is changed in the app, never from here.
入力
入力はありません。
ほかの提供先
revokeConnectedApp
Remove an app you connected: every token it holds and the access you gave it are deleted, so its next call is refused and it has to ask again. Pass its client id from listConnectedApps. Removing the app you are talking through disconnects it.
入力
clientIdstring必須- 1〜128文字
ほかの提供先
listReceivedInvitations
The invitations to join a workspace that are waiting for you, oldest first, each with the id acceptInvitation and declineInvitation take. It is not listInvitations, which lists the invitations this workspace sent.
入力
入力はありません。
ほかの提供先
acceptInvitation
Accept an invitation that is waiting for you and join its workspace with the role and the addresses it gives. activate also makes it the workspace the app opens for you. A workspace that asks for two-factor sign-in is refused until you turn it on.
入力
invitationIdstring必須- 1〜128文字
activateboolean
ほかの提供先
declineInvitation
Decline an invitation that is waiting for you. Its link stops working and whoever sent it is told. It cannot be taken back: they would have to invite you again.
入力
invitationIdstring必須- 1〜128文字