आपका अकाउंट
व्यक्ति के वर्कस्पेस, ईमेल, फ़ोटो, यूज़रनेम, ऐप्स और आमंत्रण।
आपके अकाउंट के टूल
| टूल | यह क्या करता है |
|---|---|
| listAccountWorkspaces | हर वर्कस्पेस जिसे आपका अकाउंट खोल सकता है, अपना हो या जॉइन किया हुआ, साथ में वह जिसे ऐप आपके लिए खोलता है और वह जिस पर ये टूल काम करते हैं। |
| switchAppWorkspace | वह वर्कस्पेस चुनें जिसे ऐप आपके लिए खोलता है। ये टूल उसी वर्कस्पेस पर काम करते रहते हैं जिस पर वे अभी काम कर रहे हैं। |
| createWorkspace | Free प्लान पर अपना एक वर्कस्पेस बनाएँ, जिसे ऐप उसके बाद से आपके लिए खोलता है। एक अकाउंट एक Free वर्कस्पेस का मालिक हो सकता है। |
| deleteWorkspace | जिस वर्कस्पेस पर ये टूल काम करते हैं, उसे उसमें मौजूद हर चीज़ के साथ हटाएँ, जब confirm उसका नाम बताए। केवल उसका मालिक ऐसा कर सकता है, और किसी अकाउंट का बनाया पहला वर्कस्पेस कभी नहीं। ऐप की चैट में यह हमेशा पहले पूछता है। |
| getNotificationSettings | OpenEmail आपको किस तरह के ईमेल भेजता है, और आपके फ़ोन पर म्यूट किए गए वर्कस्पेस। |
| setEmailNotification | activity या product ईमेल चालू या बंद करें। account और billing ईमेल हमेशा चालू रहते हैं। |
| setWorkspacePushMuted | किसी एक वर्कस्पेस की फ़ोन सूचनाएँ म्यूट या अनम्यूट करें। |
| setProfilePhoto | base64 में दी गई इमेज से अपनी प्रोफ़ाइल फ़ोटो सेट करें। |
| removeProfilePhoto | अपनी प्रोफ़ाइल फ़ोटो हटाएँ। ऐप की चैट में यह हमेशा पहले पूछता है। |
| getUsername | आपका यूज़रनेम, क्या आपने उसे चुना था, और उससे मिलने वाला मुफ़्त पता। |
| checkUsername | क्या आप कोई यूज़रनेम चुन सकते हैं, और अगर नहीं, तो क्यों नहीं। |
| chooseUsername | अपना यूज़रनेम हमेशा के लिए चुनें, क्योंकि एक बार चुनने के बाद यह कभी नहीं बदलता। ऐप की चैट में यह हमेशा पहले पूछता है। |
| listConnectedApps | आपके कनेक्ट किए ऐप्स, साथ में यह कि हर एक किस तक पहुँच सकता है और कब तक। |
| revokeConnectedApp | किसी कनेक्टेड ऐप को हटाएँ, ताकि उसे फिर से पूछना पड़े। ऐप की चैट में यह हमेशा पहले पूछता है। |
| listReceivedInvitations | किसी वर्कस्पेस में शामिल होने के आमंत्रण जो आपका इंतज़ार कर रहे हैं। किसी वर्कस्पेस के भेजे आमंत्रणों के लिए listInvitations है। |
| acceptInvitation | किसी आमंत्रण के वर्कस्पेस में शामिल हों, और activate से उसे वह वर्कस्पेस बनाएँ जिसे ऐप खोलता है। |
| declineInvitation | किसी आमंत्रण को हमेशा के लिए अस्वीकार करें। ऐप की चैट में यह हमेशा पहले पूछता है। |
ये टूल उस व्यक्ति पर काम करते हैं जिसने क्लाइंट को कनेक्ट किया, किसी और पर कभी नहीं, और ऐप की चैट में आप पर। पढ़ने के लिए account:read और हर बदलाव के लिए account:write चाहिए, जिन्हें कोई भूमिका सीमित नहीं करती, इसलिए किसी सदस्य का कनेक्ट किया क्लाइंट उस सदस्य के अपने अकाउंट तक भी पहुँचता है।
तीन चीज़ें ऐप में ही रहती हैं: कोई कनेक्टेड ऐप किस तक पहुँच सकता है उसे बदलना, उसे सत्यापन कोड के बिना बदलाव करने देना, और पूरा अकाउंट हटाना।
वर्कस्पेस टूल बाकी टूल को कभी नहीं हिलाते: switchAppWorkspace बदलता है कि ऐप क्या खोलता है, और setActiveConnection यह कि टूल किस पर काम करते हैं।
इस सर्वर के कुछ टूल ऐसा बदलाव करते हैं जिसे REST API सत्यापन कोड से सुरक्षित रखता है, और वही कोड माँगते हैं। जब तक क्लाइंट ने पिछले 60 मिनट में कोई कोड सत्यापित न किया हो, और व्यक्ति ने अकाउंट → कनेक्टेड ऐप्स में उसके लिए "60 मिनट के लिए बदलावों की अनुमति दें" न चुना हो, ऐसा टूल एक ऐसे नतीजे से जवाब देता है जो Refused (step_up_required): से शुरू होता है, और कुछ नहीं बदलता। emptyAudience कभी कोड नहीं माँगता। API का प्रमाणीकरण पेज कोड माँगने वाले हर टूल की सूची देता है, और बताता है कि कोड कैसे माँगें और सत्यापित करें।
संदर्भ
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
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.
इनपुट
workspaceIdstringआवश्यक- 1 से 128 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
namestringआवश्यक- 1 से 64 वर्ण
इनमें भी उपलब्ध
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.
- सत्यापन कोड माँगता है
DELETE /workspaces/{id}
इनपुट
confirmstringआवश्यकThe name of the workspace being deleted, typed out.
1 से 256 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
setEmailNotification
Turn one kind of email from OpenEmail on or off for you. activity and product can be turned off; account and billing cannot.
इनपुट
categorystringआवश्यक- इनमें से एक
"account""billing""activity""product" enabledbooleanआवश्यक
इनमें भी उपलब्ध
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.
इनपुट
workspaceIdstringआवश्यक- 1 से 128 वर्ण
mutedbooleanआवश्यक
इनमें भी उपलब्ध
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.
इनपुट
imagestringआवश्यकThe image in base64, or as a data: URL.
1 से 7340032 वर्णcontentTypestringआवश्यकThe type of the image: image/png, image/jpeg, image/webp, image/gif.
1 से 100 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
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.
इनपुट
usernamestringआवश्यक- 1 से 60 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
usernamestringआवश्यक- 1 से 60 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
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.
इनपुट
clientIdstringआवश्यक- 1 से 128 वर्ण
इनमें भी उपलब्ध
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.
इनपुट
कोई इनपुट नहीं लेता।
इनमें भी उपलब्ध
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.
इनपुट
invitationIdstringआवश्यक- 1 से 128 वर्ण
activateboolean
इनमें भी उपलब्ध
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.
इनपुट
invitationIdstringआवश्यक- 1 से 128 वर्ण