Ihr Konto
Die Workspaces, E-Mails, das Foto, der Benutzername, die Apps und die Einladungen der Person.
Tools für Ihr Konto
| Tool | Was es tut |
|---|---|
| listAccountWorkspaces | Jeder Workspace, den Ihr Konto öffnen kann, eigene und beigetretene, mit dem, den die App für Sie öffnet, und dem, auf den diese Tools wirken. |
| switchAppWorkspace | Wählt den Workspace, den die App für Sie öffnet. Diese Tools wirken weiter auf den Workspace, auf den sie jetzt wirken. |
| createWorkspace | Erstellt einen Workspace, der Ihnen gehört, im Tarif Free, den die App von da an für Sie öffnet. Ein Konto kann einen Free-Workspace besitzen. |
| deleteWorkspace | Löscht den Workspace, auf den diese Tools wirken, mit allem darin, sobald confirm ihn nennt. Nur sein Inhaber darf das, und nie beim ersten Workspace, den ein Konto angelegt hat. Im Chat der App fragt es immer zuerst. |
| getNotificationSettings | Welche Arten von E-Mails OpenEmail Ihnen schickt, und die Workspaces, die auf Ihrem Telefon stummgeschaltet sind. |
| setEmailNotification | Schaltet E-Mails zu activity oder product ein oder aus. E-Mails zu account und billing sind immer eingeschaltet. |
| setWorkspacePushMuted | Schaltet die Telefonbenachrichtigungen eines Workspace stumm oder wieder ein. |
| setProfilePhoto | Setzt Ihr Profilfoto aus einem Bild in Base64. |
| removeProfilePhoto | Entfernt Ihr Profilfoto. Im Chat der App fragt es immer zuerst. |
| getUsername | Ihr Benutzername, ob Sie ihn gewählt haben, und die kostenlose Adresse, die er Ihnen gibt. |
| checkUsername | Ob Sie einen Benutzernamen wählen könnten, und warum nicht, wenn nicht. |
| chooseUsername | Wählt Ihren Benutzernamen endgültig, denn einmal gewählt ändert er sich nie. Im Chat der App fragt es immer zuerst. |
| listConnectedApps | Die Apps, die Sie verbunden haben, mit dem, was jede erreichen darf, und bis wann. |
| revokeConnectedApp | Entfernt eine verbundene App, sodass sie erneut fragen muss. Im Chat der App fragt es immer zuerst. |
| listReceivedInvitations | Die Einladungen in einen Workspace, die auf Sie warten. listInvitations ist das Tool für die Einladungen, die ein Workspace verschickt hat. |
| acceptInvitation | Tritt dem Workspace einer Einladung bei und macht ihn mit activate zu dem, den die App öffnet. |
| declineInvitation | Lehnt eine Einladung endgültig ab. Im Chat der App fragt es immer zuerst. |
Diese Tools wirken auf die Person, die den Client verbunden hat, nie auf jemand anderen, und im Chat der App auf Sie. Lesen erfordert account:read und jede Änderung account:write, die keine Rolle einschränkt, sodass ein Client, den ein Mitglied verbunden hat, auch das eigene Konto dieses Mitglieds erreicht.
Drei Dinge bleiben in der App: ändern, was eine verbundene App erreichen darf, einer App Änderungen ohne Bestätigungscode erlauben und das ganze Konto löschen.
Die Workspace-Tools verschieben die anderen Tools nie: switchAppWorkspace ändert, was die App öffnet, und setActiveConnection, worauf die Tools wirken.
Einige Tools auf diesem Server nehmen eine Änderung vor, die die REST API mit einem Bestätigungscode schützt, und fragen nach demselben Code. Solange der Client in den letzten 60 Minuten keinen Code bestätigt hat und die Person für ihn unter Konto → Verbundene Apps nicht Änderungen für 60 Minuten erlauben gewählt hat, antwortet ein solches Tool mit einem Ergebnis, das mit Refused (step_up_required): beginnt, und ändert nichts. emptyAudience fragt nie nach einem Code. Die Seite Authentifizierung der API nennt jedes Tool, das fragt, und zeigt, wie man einen Code anfordert und bestätigt.
Referenz
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
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.
Eingaben
workspaceIdstringErforderlich- 1 bis 128 Zeichen
Auch verfügbar über
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.
Eingaben
namestringErforderlich- 1 bis 64 Zeichen
Auch verfügbar über
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.
- Fragt nach einem Bestätigungscode
DELETE /workspaces/{id}
Eingaben
confirmstringErforderlichThe name of the workspace being deleted, typed out.
1 bis 256 Zeichen
Auch verfügbar über
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
Eingaben
categorystringErforderlich- Einer von
"account""billing""activity""product" enabledbooleanErforderlich
Auch verfügbar über
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.
Eingaben
workspaceIdstringErforderlich- 1 bis 128 Zeichen
mutedbooleanErforderlich
Auch verfügbar über
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.
Eingaben
imagestringErforderlichThe image in base64, or as a data: URL.
1 bis 7340032 ZeichencontentTypestringErforderlichThe type of the image: image/png, image/jpeg, image/webp, image/gif.
1 bis 100 Zeichen
Auch verfügbar über
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
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.
Eingaben
usernamestringErforderlich- 1 bis 60 Zeichen
Auch verfügbar über
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.
Eingaben
usernamestringErforderlich- 1 bis 60 Zeichen
Auch verfügbar über
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
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.
Eingaben
clientIdstringErforderlich- 1 bis 128 Zeichen
Auch verfügbar über
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.
Eingaben
Nimmt keine Eingaben an.
Auch verfügbar über
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.
Eingaben
invitationIdstringErforderlich- 1 bis 128 Zeichen
activateboolean
Auch verfügbar über
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.
Eingaben
invitationIdstringErforderlich- 1 bis 128 Zeichen