Votre compte
Les espaces de travail, les e-mails, la photo, le nom d'utilisateur, les applications et les invitations de la personne.
Outils de votre compte
| Outil | Ce qu'il fait |
|---|---|
| listAccountWorkspaces | Chaque espace de travail que votre compte peut ouvrir, dont vous êtes propriétaire ou que vous avez rejoint, avec celui que l'application ouvre pour vous et celui sur lequel ces outils agissent. |
| switchAppWorkspace | Choisit l'espace de travail que l'application ouvre pour vous. Ces outils continuent d'agir sur l'espace de travail sur lequel ils agissent maintenant. |
| createWorkspace | Crée un espace de travail qui vous appartient, avec la formule Free, que l'application ouvre ensuite pour vous. Un compte peut posséder un espace de travail Free. |
| deleteWorkspace | Supprime l'espace de travail sur lequel ces outils agissent, avec tout ce qu'il contient, une fois que confirm le nomme. Seul son propriétaire le peut, et jamais pour le premier espace de travail créé par un compte. Dans le chat de l’application, il demande toujours d’abord. |
| getNotificationSettings | Les types d'e-mails qu'OpenEmail vous envoie, et les espaces de travail mis en sourdine sur votre téléphone. |
| setEmailNotification | Active ou désactive les e-mails activity ou product. Les e-mails account et billing restent toujours activés. |
| setWorkspacePushMuted | Met en sourdine ou réactive les notifications téléphone d'un espace de travail. |
| setProfilePhoto | Définit votre photo de profil à partir d'une image en base64. |
| removeProfilePhoto | Retire votre photo de profil. Dans le chat de l’application, il demande toujours d’abord. |
| getUsername | Votre nom d'utilisateur, si vous l'avez choisi, et l'adresse gratuite qu'il vous donne. |
| checkUsername | Si vous pourriez choisir un nom d'utilisateur, et pourquoi pas dans le cas contraire. |
| chooseUsername | Choisit votre nom d'utilisateur pour de bon, car il ne change plus une fois choisi. Dans le chat de l’application, il demande toujours d’abord. |
| listConnectedApps | Les applications que vous avez connectées, avec ce que chacune peut atteindre et jusqu'à quand. |
| revokeConnectedApp | Retire une application connectée, qui doit alors redemander l'accès. Dans le chat de l’application, il demande toujours d’abord. |
| listReceivedInvitations | Les invitations à rejoindre un espace de travail qui vous attendent. listInvitations sert aux invitations qu'un espace de travail a envoyées. |
| acceptInvitation | Rejoint l'espace de travail d'une invitation et, avec activate, en fait celui que l'application ouvre. |
| declineInvitation | Refuse une invitation, pour de bon. Dans le chat de l’application, il demande toujours d’abord. |
Ces outils agissent sur la personne qui a connecté le client, jamais sur quelqu'un d'autre, et dans le chat de l’application sur vous. La lecture nécessite account:read et chaque modification account:write, qu'aucun rôle ne limite, donc un client connecté par un membre atteint aussi le propre compte de ce membre.
Trois choses restent dans l'application : modifier ce qu'une application connectée peut atteindre, lui permettre des modifications sans code de vérification, et supprimer le compte entier.
Les outils d'espace de travail ne déplacent jamais les autres outils : switchAppWorkspace change ce que l'application ouvre, et setActiveConnection ce sur quoi les outils agissent.
Certains outils de ce serveur font un changement que l'API REST protège par un code de vérification, et demandent le même code. Tant que le client n'a pas vérifié de code dans les 60 dernières minutes, et que la personne n'a pas choisi Autoriser les modifications pendant 60 minutes pour lui dans Compte → Applications connectées, un tel outil répond par un résultat qui commence par Refused (step_up_required): et ne change rien. emptyAudience ne demande jamais de code. La page Authentification de l'API liste chaque outil qui en demande un, et montre comment demander un code et le vérifier.
Référence
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
workspaceIdstringObligatoire- De 1 à 128 caractères
Aussi disponible dans
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.
Entrées
namestringObligatoire- De 1 à 64 caractères
Aussi disponible dans
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.
- Demande un code de vérification
DELETE /workspaces/{id}
Entrées
confirmstringObligatoireThe name of the workspace being deleted, typed out.
De 1 à 256 caractères
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
Entrées
categorystringObligatoire- L'un de
"account""billing""activity""product" enabledbooleanObligatoire
Aussi disponible dans
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.
Entrées
workspaceIdstringObligatoire- De 1 à 128 caractères
mutedbooleanObligatoire
Aussi disponible dans
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.
Entrées
imagestringObligatoireThe image in base64, or as a data: URL.
De 1 à 7340032 caractèrescontentTypestringObligatoireThe type of the image: image/png, image/jpeg, image/webp, image/gif.
De 1 à 100 caractères
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
usernamestringObligatoire- De 1 à 60 caractères
Aussi disponible dans
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.
Entrées
usernamestringObligatoire- De 1 à 60 caractères
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
clientIdstringObligatoire- De 1 à 128 caractères
Aussi disponible dans
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.
Entrées
Ne prend aucune entrée.
Aussi disponible dans
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.
Entrées
invitationIdstringObligatoire- De 1 à 128 caractères
activateboolean
Aussi disponible dans
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.
Entrées
invitationIdstringObligatoire- De 1 à 128 caractères