Python
همهٔ متدها
همهٔ 430 تا، هر کدام در یک سطر، کنار نقطهٔ پایانی‌ای که فرا می‌خواند.
همهٔ متدها
برای هر عملیات مستندشده یک متد، با نام‌های TypeScript به شکل snake_case، و بررسی همخوانی پکیج آن را اثبات می‌کند. این بررسی سند OpenAPI را می‌خواند، هر متد را در برابر یک transport ضبط‌کننده صدا می‌زند، و هر جا عملیاتی متد نداشته باشد یا متدی چیزی جز دقیقاً همان درخواستی که همتای TypeScript آن می‌فرستد بفرستد، شکست می‌خورد.
هر نمونه از کلاینت آماده، from openemail import openemail، استفاده می‌کند که نخستین بار که به آن دست زده شود OPENEMAIL_API_KEY را می‌خواند. AsyncOpenEmail همهٔ متدهای اینجا را با همان آرگومان‌ها دارد: فراخوانی را با await انجام دهید، و iterate را با async for بپیمایید.
list_all و iterate همان اندپوینتی را صفحه‌به‌صفحه می‌پیمایند که list کنارشان می‌پیماید، و همین‌طور جفت‌های دیگری که به نام فهرستی که می‌پیمایند نام‌گذاری شده‌اند، مانند list_all_runs و iterate_runs روی rules. پس یک درخواست می‌تواند در بیش از یک سطر ظاهر شود.
سطرهای temp_mail جایی که هر سطر دیگر یک اسکوپ را نام می‌برد، «توکن صندوق ورودی» می‌گویند. صندوق‌های یک‌بارمصرف تنها منبعی روی این API هستند که با چیزی جز کلید احراز هویت می‌شود: توکن oe_inbox_ را که create برگردانده در هر فراخوانی به‌صورت inbox_token= بدهید.
| فراخوانی | اندپوینت | اسکوپ |
|---|---|---|
| me.get() | GET /keys/self | بدون محدوده دسترسی |
| me.ping() | GET /ping | بدون محدوده دسترسی |
| me.rotate() | POST /keys/self/rotate | keys:write |
| security.step_up_status() | GET /security/step-up | بدون محدوده دسترسی |
| security.begin_step_up() | POST /security/step-up | بدون محدوده دسترسی |
| security.verify_step_up() | POST /security/step-up/verify | بدون محدوده دسترسی |
| keys.list() | GET /keys | keys:read |
| keys.list_all() | GET /keys | keys:read |
| keys.iterate() | GET /keys | keys:read |
| keys.get() | GET /keys/{id} | keys:read |
| keys.create() | POST /keys | keys:manage |
| keys.update() | PATCH /keys/{id} | keys:manage |
| keys.delete() | DELETE /keys/{id} | keys:manage |
| keys.rotate() | POST /keys/{id}/rotate | keys:manage |
| keys.revoke() | POST /keys/{id}/revoke | keys:manage |
| keys.list_requests() | GET /keys/{id}/requests | keys:read |
| keys.list_all_requests() | GET /keys/{id}/requests | keys:read |
| keys.iterate_requests() | GET /keys/{id}/requests | keys:read |
| keys.list_activity() | GET /keys/{id}/activity | keys:read |
| keys.list_all_activity() | GET /keys/{id}/activity | keys:read |
| keys.iterate_activity() | GET /keys/{id}/activity | keys:read |
| keys.list_workspace_requests() | GET /keys/requests | keys:read |
| keys.list_all_workspace_requests() | GET /keys/requests | keys:read |
| keys.iterate_workspace_requests() | GET /keys/requests | keys:read |
| keys.list_workspace_activity() | GET /keys/activity | keys:read |
| keys.list_all_workspace_activity() | GET /keys/activity | keys:read |
| keys.iterate_workspace_activity() | GET /keys/activity | keys:read |
| keys.stats() | GET /keys/stats | keys:read + emails:read |
| addresses.list() | GET /addresses | emails:send |
| addresses.list_all() | GET /addresses | emails:send |
| addresses.iterate() | GET /addresses | emails:send |
| languages.list() | GET /languages | بدون محدوده دسترسی |
| emails.send() | POST /emails | emails:send |
| emails.send_batch() | POST /emails/batch | emails:send |
| emails.translate() | POST /emails/translate | emails:send |
| emails.check() | POST /emails/check | emails:send |
| emails.list() | GET /emails | emails:read |
| emails.list_all() | GET /emails | emails:read |
| emails.iterate() | GET /emails | emails:read |
| emails.get() | GET /emails/{id} | emails:read |
| emails.list_events() | GET /emails/{id}/events | emails:read |
| emails.list_all_events() | GET /emails/{id}/events | emails:read |
| emails.iterate_events() | GET /emails/{id}/events | emails:read |
| emails.get_tracking() | GET /emails/{id}/tracking | emails:read |
| emails.cancel() | POST /emails/{id}/cancel | emails:send |
| emails.reschedule() | PATCH /emails/{id} | emails:send |
| emails.update() | PATCH /emails/{id} | emails:send |
| emails.compose() | POST /emails/compose | emails:send |
| emails.rewrite() | POST /emails/rewrite | emails:send |
| emails.suggest_subject() | POST /emails/subject | emails:send |
| templates.list() | GET /templates | templates:read |
| templates.list_all() | GET /templates | templates:read |
| templates.iterate() | GET /templates | templates:read |
| templates.get() | GET /templates/{id} | templates:read |
| templates.create() | POST /templates | templates:write |
| templates.update() | PATCH /templates/{id} | templates:write |
| templates.duplicate() | POST /templates/{id}/duplicate | templates:write |
| templates.replace_content() | POST /templates/{id}/content | templates:write |
| templates.delete() | DELETE /templates/{id} | templates:write |
| templates.list_versions() | GET /templates/{id}/versions | templates:read |
| templates.list_all_versions() | GET /templates/{id}/versions | templates:read |
| templates.iterate_versions() | GET /templates/{id}/versions | templates:read |
| templates.get_version() | GET /templates/{id}/versions/{version} | templates:read |
| templates.publish() | POST /templates/{id}/versions | templates:write |
| templates.restore_version() | POST /templates/{id}/versions/{version}/restore | templates:write |
| templates.delete_version() | DELETE /templates/{id}/versions/{version} | templates:write |
| templates.list_starters() | GET /templates/starters | templates:read |
| templates.get_starter() | GET /templates/starters/{slug} | templates:read |
| templates.list_fonts() | GET /templates/fonts | templates:read |
| templates.render() | POST /templates/render | templates:read |
| templates.preview() | POST /templates/{id}/preview | templates:read |
| templates.get_analytics() | GET /templates/{id}/analytics | templates:read |
| templates.list_sends() | GET /templates/{id}/sends | templates:read |
| templates.send() | POST /templates/{id}/send | templates:write + emails:send |
| templates.list_images() | GET /templates/images | templates:read |
| templates.list_all_images() | GET /templates/images | templates:read |
| templates.iterate_images() | GET /templates/images | templates:read |
| templates.upload_image() | POST /templates/images | templates:write |
| templates.design() | POST /templates/design | templates:write |
| templates.redesign() | POST /templates/{id}/redesign | templates:write |
| tracking.list() | GET /tracking | emails:read |
| tracking.list_all() | GET /tracking | emails:read |
| tracking.iterate() | GET /tracking | emails:read |
| tracking.get_stats() | GET /tracking/stats | emails:read |
| tracking.get() | GET /tracking/{id} | emails:read |
| tracking.list_opens() | GET /tracking/{id}/opens | emails:read |
| tracking.list_all_opens() | GET /tracking/{id}/opens | emails:read |
| tracking.iterate_opens() | GET /tracking/{id}/opens | emails:read |
| tracking.list_clicks() | GET /tracking/{id}/clicks | emails:read |
| tracking.list_all_clicks() | GET /tracking/{id}/clicks | emails:read |
| tracking.iterate_clicks() | GET /tracking/{id}/clicks | emails:read |
| threads.list() | GET /threads | threads:read |
| threads.list_all() | GET /threads | threads:read |
| threads.iterate() | GET /threads | threads:read |
| threads.get() | GET /threads/{id} | threads:read |
| threads.update() | PATCH /threads/{id} | threads:write |
| threads.trash() | POST /threads/{id}/trash | threads:write |
| threads.snooze() | POST /threads/{id}/snooze | threads:write |
| threads.unsnooze() | POST /threads/{id}/unsnooze | threads:write |
| threads.list_attachments() | GET /threads/{id}/messages/{messageId}/attachments | threads:read |
| threads.list_notes() | GET /threads/{id}/notes | threads:read |
| threads.create_note() | POST /threads/{id}/notes | threads:write |
| threads.update_note() | PATCH /threads/{id}/notes/{noteId} | threads:write |
| threads.delete_note() | DELETE /threads/{id}/notes/{noteId} | threads:write |
| threads.reorder_notes() | POST /threads/{id}/notes/reorder | threads:write |
| threads.counts() | GET /threads/counts | threads:read |
| threads.summary() | GET /threads/{id}/summary | threads:read |
| threads.restore() | POST /threads/{id}/restore | threads:write |
| threads.delete() | DELETE /threads/{id} | threads:write |
| threads.unsubscribe() | POST /threads/{id}/unsubscribe | threads:write |
| threads.get_event() | GET /threads/{id}/event | calendar:read |
| drafts.list() | GET /drafts | drafts:read |
| drafts.list_all() | GET /drafts | drafts:read |
| drafts.iterate() | GET /drafts | drafts:read |
| drafts.get() | GET /drafts/{id} | drafts:read |
| drafts.create() | POST /drafts | drafts:write |
| drafts.update() | PATCH /drafts/{id} | drafts:write |
| drafts.delete() | DELETE /drafts/{id} | drafts:write |
| labels.list() | GET /labels | labels:read |
| labels.list_all() | GET /labels | labels:read |
| labels.iterate() | GET /labels | labels:read |
| labels.list_colors() | GET /labels/colors | labels:read |
| labels.get() | GET /labels/{id} | labels:read |
| labels.create() | POST /labels | labels:write |
| labels.update() | PATCH /labels/{id} | labels:write |
| labels.delete() | DELETE /labels/{id} | labels:write |
| contacts.list() | GET /contacts | contacts:read |
| contacts.list_all() | GET /contacts | contacts:read |
| contacts.iterate() | GET /contacts | contacts:read |
| contacts.get() | GET /contacts/{email} | contacts:read |
| contacts.create() | POST /contacts | contacts:write |
| contacts.update() | PATCH /contacts/{email} | contacts:write |
| contacts.delete() | DELETE /contacts/{email} | contacts:write |
| contacts.set_audiences() | PUT /contacts/{email}/audiences | audiences:write |
| contacts.list_people() | GET /contacts/people | contacts:read |
| contacts.list_all_people() | GET /contacts/people | contacts:read |
| contacts.iterate_people() | GET /contacts/people | contacts:read |
| contacts.save() | PUT /contacts/{email} | contacts:write |
| contacts.delete_many() | POST /contacts/batch-delete | contacts:write |
| contacts.set_photo() | PUT /contacts/{email}/photo | contacts:write |
| contacts.remove_photo() | DELETE /contacts/{email}/photo | contacts:write |
| contacts.block() | POST /contacts/{email}/block | settings:write |
| contacts.unblock() | DELETE /contacts/{email}/block | settings:write |
| contacts.list_threads() | GET /contacts/{email}/threads | threads:read |
| contacts.list_all_threads() | GET /contacts/{email}/threads | threads:read |
| contacts.iterate_threads() | GET /contacts/{email}/threads | threads:read |
| contacts.activity() | GET /contacts/{email}/activity | threads:read |
| audiences.list() | GET /audiences | audiences:read |
| audiences.list_all() | GET /audiences | audiences:read |
| audiences.iterate() | GET /audiences | audiences:read |
| audiences.growth() | GET /audiences/growth | audiences:read |
| audiences.get() | GET /audiences/{id} | audiences:read |
| audiences.create() | POST /audiences | audiences:write |
| audiences.update() | PATCH /audiences/{id} | audiences:write |
| audiences.delete() | DELETE /audiences/{id} | audiences:write |
| audiences.empty() | POST /audiences/{id}/empty | audiences:write |
| audiences.list_contacts() | GET /audiences/{id}/contacts | audiences:read |
| audiences.list_all_contacts() | GET /audiences/{id}/contacts | audiences:read |
| audiences.iterate_contacts() | GET /audiences/{id}/contacts | audiences:read |
| audiences.add_contact() | POST /audiences/{id}/contacts | audiences:write |
| audiences.remove_contact() | DELETE /audiences/{id}/contacts/{email} | audiences:write |
| audiences.add_contacts() | POST /audiences/{id}/contacts/batch | audiences:write |
| audiences.remove_contacts() | POST /audiences/{id}/contacts/batch-remove | audiences:write |
| audiences.import_contacts() | POST /audiences/{id}/import | audiences:write + contacts:write |
| forms.list() | GET /forms | forms:read |
| forms.list_all() | GET /forms | forms:read |
| forms.iterate() | GET /forms | forms:read |
| forms.create() | POST /forms | forms:write |
| forms.design() | POST /forms/design | forms:write |
| forms.redesign() | POST /forms/{id}/redesign | forms:write |
| forms.list_starters() | GET /forms/starters | forms:read |
| forms.get_starter() | GET /forms/starters/{slug} | forms:read |
| forms.get() | GET /forms/{id} | forms:read |
| forms.update() | PATCH /forms/{id} | forms:write |
| forms.delete() | DELETE /forms/{id} | forms:write |
| forms.publish() | POST /forms/{id}/publish | forms:write |
| forms.pause() | POST /forms/{id}/pause | forms:write |
| forms.resume() | POST /forms/{id}/resume | forms:write |
| forms.duplicate() | POST /forms/{id}/duplicate | forms:write |
| forms.analytics() | GET /forms/{id}/analytics | forms:read |
| forms.list_submissions() | GET /forms/{id}/submissions | forms:read |
| forms.list_all_submissions() | GET /forms/{id}/submissions | forms:read |
| forms.iterate_submissions() | GET /forms/{id}/submissions | forms:read |
| forms.get_submission() | GET /forms/{id}/submissions/{submissionId} | forms:read |
| forms.delete_submission() | DELETE /forms/{id}/submissions/{submissionId} | forms:write |
| forms.delete_submissions() | POST /forms/{id}/submissions/batch-remove | forms:write |
| forms.approve_submission() | POST /forms/{id}/submissions/{submissionId}/approve | forms:write + contacts:write |
| forms.resend_confirmation() | POST /forms/{id}/submissions/{submissionId}/resend | forms:write + emails:send |
| forms.subscribe() | POST /subscribe/{formId} | بدون اعتبارنامه |
| broadcasts.preview() | POST /broadcasts/preview | audiences:read |
| broadcasts.send() | POST /broadcasts | emails:send + audiences:read |
| broadcasts.list() | GET /broadcasts | emails:read |
| broadcasts.list_all() | GET /broadcasts | emails:read |
| broadcasts.iterate() | GET /broadcasts | emails:read |
| broadcasts.get() | GET /broadcasts/{id} | emails:read |
| broadcasts.stats() | GET /broadcasts/{id}/stats | emails:read |
| broadcasts.analytics() | GET /broadcasts/analytics | emails:read |
| broadcasts.list_recipients() | GET /broadcasts/{id}/recipients | emails:read |
| broadcasts.list_all_recipients() | GET /broadcasts/{id}/recipients | emails:read |
| broadcasts.iterate_recipients() | GET /broadcasts/{id}/recipients | emails:read |
| broadcasts.get_recipient() | GET /broadcasts/{id}/recipients/{emailId} | emails:read |
| broadcasts.cancel() | POST /broadcasts/{id}/cancel | emails:send |
| domains.list() | GET /domains | domains:read |
| domains.list_all() | GET /domains | domains:read |
| domains.iterate() | GET /domains | domains:read |
| domains.get() | GET /domains/{id} | domains:read |
| domains.create() | POST /domains | domains:write |
| domains.verify() | POST /domains/{id}/verify | domains:write |
| domains.update() | PATCH /domains/{id} | domains:write |
| domains.delete() | DELETE /domains/{id} | domains:write |
| domains.get_logo() | GET /domains/{id}/logo | domains:read |
| domains.set_logo() | PUT /domains/{id}/logo | domains:write |
| domains.remove_logo() | DELETE /domains/{id}/logo | domains:write |
| domains.set_logo_certificate() | PUT /domains/{id}/logo/certificate | domains:write |
| domains.remove_logo_certificate() | DELETE /domains/{id}/logo/certificate | domains:write |
| domains.list_addresses() | GET /domains/{id}/addresses | domains:read |
| domains.list_all_addresses() | GET /domains/{id}/addresses | domains:read |
| domains.iterate_addresses() | GET /domains/{id}/addresses | domains:read |
| domains.create_address() | POST /domains/{id}/addresses | domains:write |
| domains.get_address() | GET /domains/{id}/addresses/{addressId} | domains:read |
| domains.update_address() | PATCH /domains/{id}/addresses/{addressId} | domains:write |
| domains.set_address_photo() | PUT /domains/{id}/addresses/{addressId}/photo | domains:write |
| domains.remove_address_photo() | DELETE /domains/{id}/addresses/{addressId}/photo | domains:write |
| domains.delete_address() | DELETE /domains/{id}/addresses/{addressId} | domains:write |
| domains.list_address_forwards() | GET /domains/{id}/addresses/{addressId}/forwards | domains:read |
| domains.add_address_forwards() | POST /domains/{id}/addresses/{addressId}/forwards | domains:write |
| domains.update_address_forward() | PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} | domains:write |
| domains.delete_address_forward() | DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId} | domains:write |
| domains.resend_address_forward_consent() | POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend | domains:write |
| domains.list_address_members() | GET /domains/{id}/addresses/{addressId}/members | members:read |
| domains.get_address_login() | GET /domains/{id}/addresses/{addressId}/login | members:write |
| domains.set_address_login() | PUT /domains/{id}/addresses/{addressId}/login | members:write |
| domains.delete_address_login() | DELETE /domains/{id}/addresses/{addressId}/login | members:write |
| domains.get_dns() | GET /domains/{id}/dns | domains:read |
| domains.set_dns_zone() | PUT /domains/{id}/dns | domains:write |
| domains.sync_dns() | POST /domains/{id}/dns/sync | domains:write |
| app_host.get() | GET /app-host | domains:read |
| app_host.set() | PUT /app-host | domains:write |
| app_host.verify() | POST /app-host/verify | domains:write |
| app_host.delete() | DELETE /app-host | domains:write |
| branding.get() | GET /branding | settings:read |
| branding.update() | PATCH /branding | settings:write |
| branding.upload_image() | PUT /branding/images/{variant} | settings:write |
| branding.remove_image() | DELETE /branding/images/{variant} | settings:write |
| rules.list() | GET /rules | rules:read |
| rules.list_all() | GET /rules | rules:read |
| rules.iterate() | GET /rules | rules:read |
| rules.get() | GET /rules/{id} | rules:read |
| rules.create() | POST /rules | rules:write |
| rules.update() | PATCH /rules/{id} | rules:write |
| rules.delete() | DELETE /rules/{id} | rules:write |
| rules.reorder() | POST /rules/reorder | rules:write |
| rules.test() | POST /rules/{id}/test | rules:read |
| rules.list_runs() | GET /rules/runs | rules:read |
| rules.list_all_runs() | GET /rules/runs | rules:read |
| rules.iterate_runs() | GET /rules/runs | rules:read |
| webhooks.list() | GET /webhooks | webhooks:read |
| webhooks.list_all() | GET /webhooks | webhooks:read |
| webhooks.iterate() | GET /webhooks | webhooks:read |
| webhooks.get() | GET /webhooks/{id} | webhooks:read |
| webhooks.create() | POST /webhooks | webhooks:write |
| webhooks.update() | PATCH /webhooks/{id} | webhooks:write |
| webhooks.delete() | DELETE /webhooks/{id} | webhooks:write |
| webhooks.rotate_secret() | POST /webhooks/{id}/rotate-secret | webhooks:write |
| webhooks.test() | POST /webhooks/{id}/test | webhooks:write |
| webhooks.list_deliveries() | GET /webhooks/{id}/deliveries | webhooks:read |
| webhooks.list_all_deliveries() | GET /webhooks/{id}/deliveries | webhooks:read |
| webhooks.iterate_deliveries() | GET /webhooks/{id}/deliveries | webhooks:read |
| webhooks.get_delivery() | GET /webhooks/{id}/deliveries/{deliveryId} | webhooks:read |
| webhooks.replay_delivery() | POST /webhooks/{id}/deliveries/{deliveryId}/replay | webhooks:write |
| webhooks.list_workspace_deliveries() | GET /webhooks/deliveries | webhooks:read |
| webhooks.list_all_workspace_deliveries() | GET /webhooks/deliveries | webhooks:read |
| webhooks.iterate_workspace_deliveries() | GET /webhooks/deliveries | webhooks:read |
| webhooks.list_activity() | GET /webhooks/{id}/activity | webhooks:read |
| webhooks.list_all_activity() | GET /webhooks/{id}/activity | webhooks:read |
| webhooks.iterate_activity() | GET /webhooks/{id}/activity | webhooks:read |
| webhooks.list_workspace_activity() | GET /webhooks/activity | webhooks:read |
| webhooks.list_all_workspace_activity() | GET /webhooks/activity | webhooks:read |
| webhooks.iterate_workspace_activity() | GET /webhooks/activity | webhooks:read |
| webhooks.list_events() | GET /webhooks/events | webhooks:read |
| webhooks.stats() | GET /webhooks/stats | webhooks:read |
| imports.list() | GET /imports | threads:read |
| imports.list_all() | GET /imports | threads:read |
| imports.iterate() | GET /imports | threads:read |
| imports.get() | GET /imports/{id} | threads:read |
| imports.create() | POST /imports | threads:write |
| imports.upload_state() | GET /imports/{id}/upload | threads:write |
| imports.upload_chunk() | PUT /imports/{id}/files/{file}/chunks/{chunk} | threads:write |
| imports.start() | POST /imports/{id}/start | threads:write |
| imports.cancel() | POST /imports/{id}/cancel | threads:write |
| imports.list_failures() | GET /imports/{id}/failures | threads:read |
| imports.delete_upload() | DELETE /imports/{id}/upload | threads:write |
| imports.import_files() | POST /imports | threads:write |
| provider_imports.inspect() | POST /provider-imports/inspect | settings:write |
| provider_imports.create() | POST /provider-imports | settings:write |
| provider_imports.list() | GET /provider-imports | settings:read |
| provider_imports.list_all() | GET /provider-imports | settings:read |
| provider_imports.iterate() | GET /provider-imports | settings:read |
| provider_imports.get() | GET /provider-imports/{id} | settings:read |
| provider_imports.cancel() | POST /provider-imports/{id}/cancel | settings:write |
| calendar.list_events() | GET /calendar/events | calendar:read |
| calendar.list_all_events() | GET /calendar/events | calendar:read |
| calendar.iterate_events() | GET /calendar/events | calendar:read |
| calendar.get_event() | GET /calendar/events/{id} | calendar:read |
| calendar.get_event_ics() | GET /calendar/events/{id}/ics | calendar:read |
| calendar.create_event() | POST /calendar/events | calendar:write |
| calendar.update_event() | PATCH /calendar/events/{id} | calendar:write |
| calendar.delete_event() | DELETE /calendar/events/{id} | calendar:write |
| calendar.cancel_event() | POST /calendar/events/{id}/cancel | calendar:write |
| calendar.respond_to_event() | POST /calendar/events/{id}/respond | calendar:write + emails:send |
| settings.get() | GET /settings | settings:read |
| settings.update() | PATCH /settings | settings:write |
| roles.list() | GET /roles | roles:read |
| roles.list_all() | GET /roles | roles:read |
| roles.iterate() | GET /roles | roles:read |
| roles.get() | GET /roles/{id} | roles:read |
| roles.create() | POST /roles | roles:write |
| roles.update() | PATCH /roles/{id} | roles:write |
| roles.delete() | DELETE /roles/{id} | roles:write |
| roles.list_permissions() | GET /roles/permissions | roles:read |
| members.list() | GET /members | members:read |
| members.list_all() | GET /members | members:read |
| members.iterate() | GET /members | members:read |
| members.get() | GET /members/{userId} | members:read |
| members.add() | POST /members | members:write |
| members.update() | PATCH /members/{userId} | members:write |
| members.remove() | DELETE /members/{userId} | members:write |
| members.grant_address() | POST /members/{userId}/addresses | members:write |
| members.revoke_address() | DELETE /members/{userId}/addresses/{addressId} | members:write |
| members.grant_domain() | POST /members/{userId}/domains | members:write |
| members.revoke_domain() | DELETE /members/{userId}/domains/{domainId} | members:write |
| members.list_invitations() | GET /members/invitations | members:read |
| members.list_all_invitations() | GET /members/invitations | members:read |
| members.iterate_invitations() | GET /members/invitations | members:read |
| members.revoke_invitation() | DELETE /members/invitations/{invitationId} | members:write |
| members.resend_invitation() | POST /members/invitations/{invitationId}/resend | members:write |
| suppressions.list() | GET /suppressions | settings:read |
| suppressions.list_all() | GET /suppressions | settings:read |
| suppressions.iterate() | GET /suppressions | settings:read |
| suppressions.get() | GET /suppressions/{id} | settings:read |
| suppressions.add() | POST /suppressions | settings:write |
| suppressions.remove() | DELETE /suppressions/{id} | settings:write |
| files.list() | GET /files | files:read |
| files.list_all() | GET /files | files:read |
| files.iterate() | GET /files | files:read |
| files.get() | GET /files/{id} | files:read |
| files.stats() | GET /files/stats | files:read |
| files.download() | GET /files/{id}/content | files:read |
| files.list_links() | GET /files/{id}/links | files:read |
| files.list_all_links() | GET /files/{id}/links | files:read |
| files.iterate_links() | GET /files/{id}/links | files:read |
| files.create_link() | POST /files/{id}/links | files:write |
| files.revoke_link() | DELETE /files/{id}/links/{linkId} | files:write |
| files.revoke_all_links() | DELETE /files/{id}/links | files:write |
| files.upload() | POST /files | files:write |
| files.delete() | DELETE /files/{id} | files:write |
| files.delete_many() | POST /files/batch-delete | files:write |
| temp_mail.list_domains() | GET /temp-mail/domains | بدون اعتبارنامه |
| temp_mail.create() | POST /temp-mail/inboxes | بدون اعتبارنامه |
| temp_mail.get() | GET /temp-mail/inboxes/{id} | توکن صندوق ورودی |
| temp_mail.extend() | POST /temp-mail/inboxes/{id}/extend | توکن صندوق ورودی |
| temp_mail.delete() | DELETE /temp-mail/inboxes/{id} | توکن صندوق ورودی |
| temp_mail.list_messages() | GET /temp-mail/inboxes/{id}/messages | توکن صندوق ورودی |
| temp_mail.list_all_messages() | GET /temp-mail/inboxes/{id}/messages | توکن صندوق ورودی |
| temp_mail.iterate_messages() | GET /temp-mail/inboxes/{id}/messages | توکن صندوق ورودی |
| temp_mail.get_message() | GET /temp-mail/inboxes/{id}/messages/{messageId} | توکن صندوق ورودی |
| temp_mail.delete_message() | DELETE /temp-mail/inboxes/{id}/messages/{messageId} | توکن صندوق ورودی |
| temp_mail.list_attachments() | GET /temp-mail/inboxes/{id}/messages/{messageId}/attachments | توکن صندوق ورودی |
| tools.check_dmarc() | GET /tools/dmarc | بدون محدوده دسترسی |
| tools.check_bimi() | GET /tools/bimi | بدون محدوده دسترسی |
| tools.check_deliverability() | GET /tools/deliverability | بدون محدوده دسترسی |
| support.send() | POST /support | بدون محدوده دسترسی |
| encryption.list_keys() | GET /encryption/keys | emails:read |
| encryption.publish_key() | POST /encryption/keys | emails:read |
| encryption.lookup_keys() | GET /encryption/keys/lookup | emails:send |
| senders.get() | GET /senders/{email} | threads:read |
| senders.research() | POST /senders/{email}/research | threads:read |
| chats.list() | GET /chats | threads:read |
| chats.list_all() | GET /chats | threads:read |
| chats.iterate() | GET /chats | threads:read |
| chats.get() | GET /chats/{id} | threads:read |
| chats.rename() | PATCH /chats/{id} | threads:write |
| chats.delete() | DELETE /chats/{id} | threads:write |
| analytics.mailbox() | GET /analytics/mailbox | threads:read |
| analytics.sending() | GET /analytics/sending | emails:read |
| subscriptions.list() | GET /subscriptions | threads:read |
| subscriptions.list_domains() | GET /subscriptions/domains | threads:read |
| subscriptions.unsubscribe() | POST /subscriptions/{id}/unsubscribe | threads:write |
| subscriptions.unsubscribe_domain() | POST /subscriptions/domains/{domain}/unsubscribe | threads:write |
| subscriptions.move() | POST /subscriptions/{id}/move | threads:write |
| exports.preview() | GET /exports/preview | threads:read |
| exports.list() | GET /exports | threads:read |
| exports.get() | GET /exports/{id} | threads:read |
| exports.start() | POST /exports | threads:read |
| exports.download() | GET /exports/{id}/content | threads:read |
| dns_connections.list() | GET /dns-connections | domains:read |
| dns_connections.get() | GET /dns-connections/{id} | domains:read |
| dns_connections.delete() | DELETE /dns-connections/{id} | domains:write |
| billing.get() | GET /billing | billing:read |
| billing.list_plans() | GET /billing/plans | billing:read |
| billing.get_usage() | GET /billing/usage | billing:read |
| billing.list_alerts() | GET /billing/alerts | billing:read |
| billing.list_countries() | GET /billing/countries | billing:read |
| billing.get_pay_as_you_go() | GET /billing/pay-as-you-go | billing:read |
| billing.set_pay_as_you_go() | PATCH /billing/pay-as-you-go | billing:write |
| billing.set_pay_as_you_go_limit() | PUT /billing/pay-as-you-go/limit | billing:write |
| billing.confirm_pay_as_you_go() | POST /billing/pay-as-you-go/confirm | billing:write |
| billing.start_checkout() | POST /billing/checkout | billing:write |
| billing.open_portal() | POST /billing/portal | billing:write |
| billing.list_invoices() | GET /billing/invoices | billing:read |
| billing.get_invoice() | GET /billing/invoices/{orderId} | billing:read |
| billing.save_invoice_details() | PUT /billing/invoices/{orderId}/details | billing:write |
| workspaces.list() | GET /workspaces | account:read |
| workspaces.create() | POST /workspaces | account:write |
| workspaces.get_active() | GET /workspaces/active | account:read |
| workspaces.set_active() | PUT /workspaces/active | account:write |
| workspaces.delete() | DELETE /workspaces/{id} | account:write |
| account.get_notifications() | GET /account/notifications | account:read |
| account.set_email_notification() | PUT /account/notifications/email/{category} | account:write |
| account.set_push_muted() | PUT /account/notifications/push/{workspaceId} | account:write |
| account.set_photo() | PUT /account/photo | account:write |
| account.remove_photo() | DELETE /account/photo | account:write |
| account.get_username() | GET /account/username | account:read |
| account.check_username() | GET /account/username/availability | account:read |
| account.set_username() | PUT /account/username | account:write |
| account.list_connected_apps() | GET /account/connected-apps | account:read |
| account.revoke_connected_app() | DELETE /account/connected-apps/{clientId} | account:write |
| account.list_invitations() | GET /account/invitations | account:read |
| account.accept_invitation() | POST /account/invitations/{invitationId}/accept | account:write |
| account.decline_invitation() | POST /account/invitations/{invitationId}/decline | account:write |