A sua conta
Os espaços de trabalho, o email, a fotografia, o nome de utilizador, as aplicações e os convites da pessoa.
Ferramentas da sua conta
| Ferramenta | O que faz |
|---|---|
| listAccountWorkspaces | Todos os espaços de trabalho que a sua conta pode abrir, próprios ou a que aderiu, com o que a aplicação abre para si e aquele sobre o qual estas ferramentas atuam. |
| switchAppWorkspace | Escolhe o espaço de trabalho que a aplicação abre para si. Estas ferramentas continuam a atuar sobre o espaço de trabalho sobre o qual atuam agora. |
| createWorkspace | Cria um espaço de trabalho seu, no plano Free, que a aplicação passa a abrir para si. Uma conta pode ter um espaço de trabalho Free. |
| deleteWorkspace | Elimina o espaço de trabalho sobre o qual estas ferramentas atuam, com tudo o que contém, assim que confirm o indicar. Só o proprietário o pode fazer, e nunca com o primeiro espaço de trabalho que uma conta criou. No chat da app pergunta sempre primeiro. |
| getNotificationSettings | Os tipos de email que o OpenEmail lhe envia, e os espaços de trabalho silenciados no seu telemóvel. |
| setEmailNotification | Ativa ou desativa o email de activity ou product. O email de account e billing está sempre ativado. |
| setWorkspacePushMuted | Silencia ou volta a ativar as notificações do telemóvel de um espaço de trabalho. |
| setProfilePhoto | Define a sua fotografia de perfil a partir de uma imagem em base64. |
| removeProfilePhoto | Remove a sua fotografia de perfil. No chat da app pergunta sempre primeiro. |
| getUsername | O seu nome de utilizador, se o escolheu, e o endereço gratuito que lhe dá. |
| checkUsername | Se poderia escolher um nome de utilizador, e porque não, quando não poderia. |
| chooseUsername | Escolhe o seu nome de utilizador de vez, pois nunca muda depois de escolhido. No chat da app pergunta sempre primeiro. |
| listConnectedApps | As aplicações que ligou, com o que cada uma pode alcançar e até quando. |
| revokeConnectedApp | Remove uma aplicação ligada, que terá de voltar a pedir acesso. No chat da app pergunta sempre primeiro. |
| listReceivedInvitations | Os convites para aderir a um espaço de trabalho que estão à sua espera. listInvitations é a ferramenta dos convites que um espaço de trabalho enviou. |
| acceptInvitation | Adere ao espaço de trabalho de um convite e, com activate, torna-o aquele que a aplicação abre. |
| declineInvitation | Recusa um convite, de vez. No chat da app pergunta sempre primeiro. |
Estas ferramentas atuam sobre a pessoa que ligou o cliente, nunca sobre outra, e no chat da app sobre si. Ler requer account:read e cada alteração requer account:write, que nenhuma função limita, por isso um cliente que um membro ligou alcança também a conta desse membro.
Três coisas ficam na aplicação: alterar o que uma aplicação ligada pode alcançar, permitir-lhe fazer alterações sem código de verificação e eliminar a conta inteira.
As ferramentas de espaços de trabalho nunca mudam as outras ferramentas: switchAppWorkspace muda o que a aplicação abre, e setActiveConnection aquilo sobre que as ferramentas atuam.
Algumas ferramentas deste servidor fazem uma alteração que a API REST protege com um código de verificação, e pedem o mesmo código. Enquanto o cliente não tiver verificado um código nos últimos 60 minutos, e a pessoa não tiver escolhido Permitir alterações durante 60 minutos para ele em Conta → Aplicações ligadas, essa ferramenta responde com um resultado que começa por Refused (step_up_required): e não altera nada. emptyAudience nunca pede um código. A página Autenticação da API lista cada ferramenta que o pede e mostra como pedir um código e verificá-lo.
Referência
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
Não recebe entradas.
Também disponível em
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
workspaceIdstringObrigatório- De 1 a 128 caracteres
Também disponível em
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
namestringObrigatório- De 1 a 64 caracteres
Também disponível em
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.
- Pede um código de verificação
DELETE /workspaces/{id}
Entradas
confirmstringObrigatórioThe name of the workspace being deleted, typed out.
De 1 a 256 caracteres
Também disponível em
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
Não recebe entradas.
Também disponível em
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
categorystringObrigatório- Um de
"account""billing""activity""product" enabledbooleanObrigatório
Também disponível em
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
workspaceIdstringObrigatório- De 1 a 128 caracteres
mutedbooleanObrigatório
Também disponível em
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
imagestringObrigatórioThe image in base64, or as a data: URL.
De 1 a 7340032 caracterescontentTypestringObrigatórioThe type of the image: image/png, image/jpeg, image/webp, image/gif.
De 1 a 100 caracteres
Também disponível em
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
Não recebe entradas.
Também disponível em
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
Não recebe entradas.
Também disponível em
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
usernamestringObrigatório- De 1 a 60 caracteres
Também disponível em
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
usernamestringObrigatório- De 1 a 60 caracteres
Também disponível em
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
Não recebe entradas.
Também disponível em
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
clientIdstringObrigatório- De 1 a 128 caracteres
Também disponível em
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
Não recebe entradas.
Também disponível em
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
invitationIdstringObrigatório- De 1 a 128 caracteres
activateboolean
Também disponível em
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
invitationIdstringObrigatório- De 1 a 128 caracteres