내 계정
그 사람의 워크스페이스, 이메일, 사진, 사용자 이름, 앱, 초대.
내 계정 도구
| 도구 | 하는 일 |
|---|---|
| listAccountWorkspaces | 계정으로 열 수 있는 모든 워크스페이스(소유한 것과 참여한 것 모두)와 함께, 앱이 열어 주는 워크스페이스와 이 도구들이 작업하는 워크스페이스를 보여 줍니다. |
| switchAppWorkspace | 앱이 열어 주는 워크스페이스를 고릅니다. 이 도구들은 지금 작업하는 워크스페이스에서 계속 작업합니다. |
| createWorkspace | Free 플랜으로 내가 소유하는 워크스페이스를 만들고, 이후 앱은 이 워크스페이스를 열어 줍니다. 계정 하나는 Free 워크스페이스를 하나만 소유할 수 있습니다. |
| deleteWorkspace | confirm에 이름을 적으면 이 도구들이 작업하는 워크스페이스를 그 안의 모든 것과 함께 삭제합니다. 소유자만 할 수 있으며, 계정이 처음 만든 워크스페이스는 삭제할 수 없습니다. 앱의 채팅에서는 항상 먼저 묻습니다. |
| getNotificationSettings | OpenEmail이 보내는 이메일의 종류와, 휴대폰에서 알림을 끈 워크스페이스. |
| setEmailNotification | activity 또는 product 이메일을 켜거나 끕니다. account와 billing 이메일은 항상 켜져 있습니다. |
| setWorkspacePushMuted | 워크스페이스 하나의 휴대폰 알림을 끄거나 다시 켭니다. |
| setProfilePhoto | base64 이미지로 프로필 사진을 설정합니다. |
| removeProfilePhoto | 프로필 사진을 삭제합니다. 앱의 채팅에서는 항상 먼저 묻습니다. |
| getUsername | 사용자 이름, 직접 고른 것인지 여부, 그리고 그 이름으로 받는 무료 주소. |
| checkUsername | 사용자 이름을 고를 수 있는지, 고를 수 없다면 그 이유. |
| chooseUsername | 사용자 이름을 영구히 고릅니다. 한 번 고르면 절대 바뀌지 않습니다. 앱의 채팅에서는 항상 먼저 묻습니다. |
| listConnectedApps | 연결한 앱과 각 앱이 접근할 수 있는 범위와 기한. |
| revokeConnectedApp | 연결된 앱을 삭제해 다시 허락을 구하게 합니다. 앱의 채팅에서는 항상 먼저 묻습니다. |
| listReceivedInvitations | 나를 기다리는 워크스페이스 초대. 워크스페이스가 보낸 초대는 listInvitations로 봅니다. |
| acceptInvitation | 초대받은 워크스페이스에 참여하고, activate를 주면 앱이 여는 워크스페이스로 만듭니다. |
| declineInvitation | 초대를 영구히 거절합니다. 앱의 채팅에서는 항상 먼저 묻습니다. |
이 도구들은 클라이언트를 연결한 사람에게만 작동하고 다른 누구에게도 작동하지 않으며, 앱의 채팅에서는 나에게 작동합니다. 읽기에는 account:read, 모든 변경에는 account:write가 필요하고 어떤 역할도 이를 제한하지 않으므로, 멤버가 연결한 클라이언트는 그 멤버 자신의 계정에도 접근합니다.
세 가지는 앱에서만 할 수 있습니다. 연결된 앱이 접근할 수 있는 범위를 바꾸는 일, 앱이 인증 코드 없이 변경하도록 허용하는 일, 계정 전체를 삭제하는 일입니다.
워크스페이스 도구는 다른 도구의 대상을 옮기지 않습니다. 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자