Hesabınız
Kişinin çalışma alanları, e-postaları, fotoğrafı, kullanıcı adı, uygulamaları ve davetleri.
Hesabınızın araçları
| Araç | Ne yapar |
|---|---|
| listAccountWorkspaces | Hesabınızın açabildiği her çalışma alanı, sahip olduklarınız ve katıldıklarınız, uygulamanın sizin için açtığı ve bu araçların üzerinde çalıştığı alanla birlikte. |
| switchAppWorkspace | Uygulamanın sizin için açtığı çalışma alanını seçer. Bu araçlar şu an üzerinde çalıştıkları çalışma alanında çalışmaya devam eder. |
| createWorkspace | Size ait, Free planında bir çalışma alanı oluşturur ve uygulama bundan sonra onu sizin için açar. Bir hesap bir Free çalışma alanına sahip olabilir. |
| deleteWorkspace | Bu araçların üzerinde çalıştığı çalışma alanını, içindeki her şeyle birlikte, confirm onun adını verdiğinde siler. Bunu yalnızca sahibi yapabilir, bir hesabın oluşturduğu ilk çalışma alanı ise asla silinmez. Uygulamanın sohbetinde her zaman önce sorar. |
| getNotificationSettings | OpenEmail'in size gönderdiği e-posta türleri ve telefonunuzda sessize alınan çalışma alanları. |
| setEmailNotification | activity veya product e-postalarını açar ya da kapatır. account ve billing e-postaları her zaman açıktır. |
| setWorkspacePushMuted | Bir çalışma alanının telefon bildirimlerini sessize alır ya da yeniden açar. |
| setProfilePhoto | Profil fotoğrafınızı base64 biçimindeki bir görselden ayarlar. |
| removeProfilePhoto | Profil fotoğrafınızı kaldırır. Uygulamanın sohbetinde her zaman önce sorar. |
| getUsername | Kullanıcı adınız, onu sizin seçip seçmediğiniz ve size verdiği ücretsiz adres. |
| checkUsername | Bir kullanıcı adını seçip seçemeyeceğiniz ve seçemiyorsanız nedeni. |
| chooseUsername | Kullanıcı adınızı kalıcı olarak seçer, çünkü seçildikten sonra asla değişmez. Uygulamanın sohbetinde her zaman önce sorar. |
| listConnectedApps | Bağladığınız uygulamalar, her birinin neye erişebildiği ve ne zamana kadar. |
| revokeConnectedApp | Bağlı bir uygulamayı kaldırır, böylece yeniden izin istemesi gerekir. Uygulamanın sohbetinde her zaman önce sorar. |
| listReceivedInvitations | Sizi bekleyen, bir çalışma alanına katılma davetleri. Bir çalışma alanının gönderdiği davetler için listInvitations kullanılır. |
| acceptInvitation | Bir davetin çalışma alanına katılır ve activate ile onu uygulamanın açtığı alan yapar. |
| declineInvitation | Bir daveti kalıcı olarak reddeder. Uygulamanın sohbetinde her zaman önce sorar. |
Bu araçlar istemciyi bağlayan kişi üzerinde çalışır, asla başka biri üzerinde değil, uygulamanın sohbetinde ise sizin üzerinizde. Okuma account:read, her değişiklik account:write gerektirir ve bunları hiçbir rol sınırlamaz, bu yüzden bir üyenin bağladığı istemci o üyenin kendi hesabına da erişir.
Üç şey uygulamada kalır: bağlı bir uygulamanın neye erişebileceğini değiştirmek, ona doğrulama kodu olmadan değişiklik yapma izni vermek ve hesabın tamamını silmek.
Çalışma alanı araçları diğer araçları asla taşımaz: switchAppWorkspace uygulamanın açtığını, setActiveConnection ise araçların üzerinde çalıştığını değiştirir.
Bu sunucudaki bazı araçlar, REST API'nin bir doğrulama koduyla koruduğu bir değişiklik yapar ve aynı kodu ister. İstemci son 60 dakikada bir kod doğrulamadıkça ya da kişi Hesap → Bağlı uygulamalar'da onun için 60 dakika boyunca değişikliklere izin ver'i seçmedikçe böyle bir araç Refused (step_up_required): ile başlayan bir sonuçla yanıt verir ve hiçbir şeyi değiştirmez. emptyAudience hiçbir zaman kod istemez. API'nin Kimlik doğrulama sayfası kod isteyen her aracı listeler ve bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.
Referans
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.
Girdiler
Girdi almaz.
Şurada da var
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.
Girdiler
workspaceIdstringZorunlu- 1 ile 128 karakter arası
Şurada da var
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.
Girdiler
namestringZorunlu- 1 ile 64 karakter arası
Şurada da var
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.
- Doğrulama kodu ister
DELETE /workspaces/{id}
Girdiler
confirmstringZorunluThe name of the workspace being deleted, typed out.
1 ile 256 karakter arası
Şurada da var
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.
Girdiler
Girdi almaz.
Şurada da var
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
Girdiler
categorystringZorunlu- Şunlardan biri
"account""billing""activity""product" enabledbooleanZorunlu
Şurada da var
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.
Girdiler
workspaceIdstringZorunlu- 1 ile 128 karakter arası
mutedbooleanZorunlu
Şurada da var
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.
Girdiler
imagestringZorunluThe image in base64, or as a data: URL.
1 ile 7340032 karakter arasıcontentTypestringZorunluThe type of the image: image/png, image/jpeg, image/webp, image/gif.
1 ile 100 karakter arası
Şurada da var
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.
Girdiler
Girdi almaz.
Şurada da var
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.
Girdiler
Girdi almaz.
Şurada da var
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.
Girdiler
usernamestringZorunlu- 1 ile 60 karakter arası
Şurada da var
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.
Girdiler
usernamestringZorunlu- 1 ile 60 karakter arası
Şurada da var
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.
Girdiler
Girdi almaz.
Şurada da var
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.
Girdiler
clientIdstringZorunlu- 1 ile 128 karakter arası
Şurada da var
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.
Girdiler
Girdi almaz.
Şurada da var
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.
Girdiler
invitationIdstringZorunlu- 1 ile 128 karakter arası
activateboolean
Şurada da var
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.
Girdiler
invitationIdstringZorunlu- 1 ile 128 karakter arası