Ваш аккаунт
Рабочие пространства, почта, фото, имя пользователя, приложения и приглашения человека.
Инструменты вашего аккаунта
| Инструмент | Что делает |
|---|---|
| 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 символов