پرش به مستندات
سرور MCP

حساب شما

فضاهای کاری، ایمیل، عکس، نام کاربری، برنامه‌ها و دعوت‌نامه‌های شخص.

ابزارهای حساب شما

ابزارچه می‌کند
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

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
GET /workspacesGET /workspaces/active
SDK
workspaces.list()workspaces.getActive()

switchAppWorkspace

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
PUT /workspaces/active
SDK
workspaces.setActive()

createWorkspace

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
POST /workspaces
SDK
workspaces.create()

deleteWorkspace

محدوده‌های دسترسیaccount:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارaccount

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.

ورودی‌ها

confirmstringالزامی

The name of the workspace being deleted, typed out.

1 تا 256 نویسه

همچنین در دسترس در

API
DELETE /workspaces/{id}
SDK
workspaces.delete()

getNotificationSettings

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
GET /account/notifications
SDK
account.getNotifications()

setEmailNotification

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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الزامی

همچنین در دسترس در

API
PUT /account/notifications/email/{category}
SDK
account.setEmailNotification()

setWorkspacePushMuted

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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الزامی

همچنین در دسترس در

API
PUT /account/notifications/push/{workspaceId}
SDK
account.setPushMuted()

setProfilePhoto

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
PUT /account/photo
SDK
account.setPhoto()

removeProfilePhoto

محدوده‌های دسترسیaccount:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارaccount

Remove your profile photo and delete the stored image, so the app shows your initials again. Removing it when there is none changes nothing.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
DELETE /account/photo
SDK
account.removePhoto()

getUsername

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
GET /account/username
SDK
account.getUsername()

checkUsername

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
GET /account/username/availability
SDK
account.checkUsername()

chooseUsername

محدوده‌های دسترسیaccount:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
PUT /account/username
SDK
account.setUsername()

listConnectedApps

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
GET /account/connected-apps
SDK
account.listConnectedApps()

revokeConnectedApp

محدوده‌های دسترسیaccount:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
DELETE /account/connected-apps/{clientId}
SDK
account.revokeConnectedApp()

listReceivedInvitations

محدوده‌های دسترسیaccount:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارaccount

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.

ورودی‌ها

هیچ ورودی‌ای نمی‌گیرد.

همچنین در دسترس در

API
GET /account/invitations
SDK
account.listInvitations()

acceptInvitation

محدوده‌های دسترسیaccount:writeدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارaccount

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

همچنین در دسترس در

API
POST /account/invitations/{invitationId}/accept
SDK
account.acceptInvitation()

declineInvitation

محدوده‌های دسترسیaccount:writeدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارaccount

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 نویسه

همچنین در دسترس در

API
POST /account/invitations/{invitationId}/decline
SDK
account.declineInvitation()