Tu cuenta
Los espacios de trabajo, el correo, la foto, el nombre de usuario, las aplicaciones y las invitaciones de la persona.
Herramientas de tu cuenta
| Herramienta | Qué hace |
|---|---|
| listAccountWorkspaces | Cada espacio de trabajo que tu cuenta puede abrir, propio o al que te uniste, con el que la app abre para ti y aquel sobre el que actúan estas herramientas. |
| switchAppWorkspace | Elige el espacio de trabajo que la app abre para ti. Estas herramientas siguen actuando sobre el espacio de trabajo sobre el que actúan ahora. |
| createWorkspace | Crea un espacio de trabajo tuyo, en el plan Free, que la app abre para ti desde entonces. Una cuenta puede tener un espacio de trabajo Free. |
| deleteWorkspace | Elimina el espacio de trabajo sobre el que actúan estas herramientas, con todo lo que contiene, cuando confirm lo nombra. Solo su propietario puede hacerlo, y nunca con el primer espacio de trabajo que creó una cuenta. En el chat de la app siempre pregunta primero. |
| getNotificationSettings | Qué tipos de correo te envía OpenEmail, y los espacios de trabajo silenciados en tu teléfono. |
| setEmailNotification | Activa o desactiva el correo de activity o product. El correo de account y billing siempre está activado. |
| setWorkspacePushMuted | Silencia o reactiva las notificaciones del teléfono de un espacio de trabajo. |
| setProfilePhoto | Pone tu foto de perfil a partir de una imagen en base64. |
| removeProfilePhoto | Quita tu foto de perfil. En el chat de la app siempre pregunta primero. |
| getUsername | Tu nombre de usuario, si lo elegiste, y la dirección gratuita que te da. |
| checkUsername | Si podrías elegir un nombre de usuario, y por qué no cuando no podrías. |
| chooseUsername | Elige tu nombre de usuario para siempre, porque no cambia una vez elegido. En el chat de la app siempre pregunta primero. |
| listConnectedApps | Las aplicaciones que conectaste, con lo que cada una puede alcanzar y hasta cuándo. |
| revokeConnectedApp | Quita una aplicación conectada, para que tenga que volver a pedir acceso. En el chat de la app siempre pregunta primero. |
| listReceivedInvitations | Las invitaciones a unirte a un espacio de trabajo que te esperan. listInvitations es la de las invitaciones que envió un espacio de trabajo. |
| acceptInvitation | Se une al espacio de trabajo de una invitación y, con activate, lo convierte en el que abre la app. |
| declineInvitation | Rechaza una invitación, para siempre. En el chat de la app siempre pregunta primero. |
Estas herramientas actúan sobre la persona que conectó el cliente, nunca sobre nadie más, y en el chat de la app sobre ti. Leer requiere account:read y cada cambio requiere account:write, que ningún rol limita, así que un cliente que conectó un miembro también llega a la propia cuenta de ese miembro.
Tres cosas se quedan en la app: cambiar a qué puede llegar una aplicación conectada, permitirle hacer cambios sin código de verificación y eliminar la cuenta entera.
Las herramientas de espacios de trabajo nunca mueven las demás herramientas: switchAppWorkspace cambia lo que abre la app, y setActiveConnection sobre qué actúan las herramientas.
Algunas herramientas de este servidor hacen un cambio que la API REST protege con un código de verificación, y piden el mismo código. Hasta que el cliente haya verificado un código en los últimos 60 minutos, o la persona haya elegido Permitir cambios durante 60 minutos para él en Cuenta → Aplicaciones conectadas, esa herramienta responde con un resultado que empieza por Refused (step_up_required): y no cambia nada. emptyAudience nunca pide un código. La página Autenticación de la API enumera cada herramienta que lo pide y muestra cómo pedir un código y verificarlo.
Referencia
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.
Entradas
No recibe entradas.
También disponible en
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.
Entradas
workspaceIdstringObligatorio- De 1 a 128 caracteres
También disponible en
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.
Entradas
namestringObligatorio- De 1 a 64 caracteres
También disponible en
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.
- Pide un código de verificación
DELETE /workspaces/{id}
Entradas
confirmstringObligatorioThe name of the workspace being deleted, typed out.
De 1 a 256 caracteres
También disponible en
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.
Entradas
No recibe entradas.
También disponible en
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
Entradas
categorystringObligatorio- Uno de
"account""billing""activity""product" enabledbooleanObligatorio
También disponible en
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.
Entradas
workspaceIdstringObligatorio- De 1 a 128 caracteres
mutedbooleanObligatorio
También disponible en
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.
Entradas
imagestringObligatorioThe image in base64, or as a data: URL.
De 1 a 7340032 caracterescontentTypestringObligatorioThe type of the image: image/png, image/jpeg, image/webp, image/gif.
De 1 a 100 caracteres
También disponible en
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.
Entradas
No recibe entradas.
También disponible en
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.
Entradas
No recibe entradas.
También disponible en
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.
Entradas
usernamestringObligatorio- De 1 a 60 caracteres
También disponible en
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.
Entradas
usernamestringObligatorio- De 1 a 60 caracteres
También disponible en
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.
Entradas
No recibe entradas.
También disponible en
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.
Entradas
clientIdstringObligatorio- De 1 a 128 caracteres
También disponible en
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.
Entradas
No recibe entradas.
También disponible en
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.
Entradas
invitationIdstringObligatorio- De 1 a 128 caracteres
activateboolean
También disponible en
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.
Entradas
invitationIdstringObligatorio- De 1 a 128 caracteres