openemail 0.0.1__py3-none-any.whl

openemail/__init__.py

@@ -0,0 +1,262 @@
+from openemail._async.client import AsyncOpenEmail
+from openemail._async.client import create_temp_mail as create_async_temp_mail
+from openemail._core.credentials import is_access_token, is_api_key
+from openemail._core.errors import (
+    OpenEmailApiError,
+    OpenEmailError,
+    OpenEmailNetworkError,
+    WebhookVerificationError,
+)
+from openemail._core.wire import to_base64
+from openemail._default import get_client, init, openemail, reset_client
+from openemail._helpers.languages import is_rtl_language, language_by_code, resolve_language
+from openemail._helpers.messages import is_sealed
+from openemail._helpers.webhooks import verify_webhook_signature
+from openemail._sync.client import OpenEmail, create_temp_mail
+from openemail._version import VERSION
+from openemail.constants import (
+    ADDRESS_FORWARD_CONSENT_STATUSES,
+    ADDRESS_FORWARD_STATUSES,
+    ADDRESS_MEMBER_VIAS,
+    API_SCOPES,
+    APP_HOST_STATUSES,
+    AUDIENCE_MEMBER_STATUSES,
+    BILLING_ALERT_KINDS,
+    BILLING_ALERT_SEVERITIES,
+    BILLING_ALERT_TARGETS,
+    BILLING_INTERVALS,
+    BILLING_INVOICE_SORTS,
+    BILLING_INVOICE_STARTS,
+    BILLING_INVOICE_STATUSES,
+    BILLING_THEMES,
+    BILLING_USAGE_WINDOWS,
+    BIMI_STATUSES,
+    BRAND_FONT_IDS,
+    BRAND_IMAGE_TYPES,
+    BRAND_IMAGE_VARIANTS,
+    BROADCAST_RECIPIENT_FILTERS,
+    BROADCAST_STATUSES,
+    CALENDAR_REMINDER_ACTIONS,
+    CALENDAR_RESPONSES,
+    CALENDAR_TRANSPARENCIES,
+    CALENDAR_VISIBILITIES,
+    CHAT_SORTS,
+    CONNECTED_APP_KINDS,
+    CONNECTED_APP_STATUSES,
+    CONSOLE_PERMISSIONS,
+    CONTACT_BLOCK_LISTS,
+    CONTACT_PHOTO_TYPES,
+    CONTACT_THREAD_SORTS,
+    CREDENTIAL_KINDS,
+    DELIVERABILITY_CHECK_IDS,
+    DELIVERABILITY_CHECK_STATUSES,
+    DELIVERABILITY_GRADES,
+    DNS_CONNECTION_STATUSES,
+    DNS_PROVISION_STATES,
+    DNS_SYNC_OUTCOMES,
+    DNS_SYNC_PURPOSES,
+    DNS_ZONE_RESOLUTION_KINDS,
+    DOMAIN_ADDRESS_DESTINATIONS,
+    DOMAIN_DMARC_POLICIES,
+    DOMAIN_DMARC_STAGES,
+    DOMAIN_LOGO_MARK_KINDS,
+    DOMAIN_LOGO_RECORD_OUTCOMES,
+    DOMAIN_RECORD_STATUSES,
+    EMAIL_NOTIFICATION_CATEGORIES,
+    ERROR_TYPES,
+    EXPORT_PHASES,
+    EXPORT_REFUSALS,
+    EXPORT_STATUSES,
+    FILE_DIRECTIONS,
+    FILE_KINDS,
+    FILE_SORTS,
+    FILE_USAGES,
+    FILE_VISIBILITIES,
+    FORM_ALIGNS,
+    FORM_CONFIRM_SOURCES,
+    FORM_CONTACT_FIELDS,
+    FORM_FIELD_ERRORS,
+    FORM_FIELD_TYPES,
+    FORM_FIELD_WIDTHS,
+    FORM_FONTS,
+    FORM_LAYOUTS,
+    FORM_RADII,
+    FORM_SENDER_ISSUES,
+    FORM_STARTER_SLUGS,
+    FORM_STATUSES,
+    FORM_SUBMISSION_STATUSES,
+    FORM_SUBSCRIBE_OUTCOMES,
+    FORM_SUCCESS_ACTIONS,
+    FORM_WIDTHS,
+    LANGUAGES,
+    LOGIN_BACKGROUND_KINDS,
+    LOGIN_BACKGROUND_PRESETS,
+    LOGIN_LOGOS,
+    MESSAGE_ENCRYPTION_FORMATS,
+    PAGE_LIMITS,
+    PAID_PLAN_IDS,
+    PAY_AS_YOU_GO_LIMITS_CENTS,
+    PEOPLE_SORTS,
+    PLAN_IDS,
+    PROVIDER_IMPORT_DOMAIN_STATES,
+    PROVIDER_IMPORT_RESOURCES,
+    PROVIDER_IMPORT_STATUSES,
+    REWRITE_ACTIONS,
+    REWRITE_TARGETS,
+    RULE_ACTIONS,
+    RULE_FIELDS,
+    RULE_OPERATORS,
+    STEP_UP_ERROR_CODES,
+    STEP_UP_METHODS,
+    SUBSCRIPTION_DESTINATIONS,
+    SUBSCRIPTION_SORTS,
+    SUBSCRIPTION_STATUSES,
+    SUPPRESSION_REASONS,
+    TEMPLATE_IMAGE_TYPES,
+    THREAD_NOTE_COLORS,
+    THREAD_SORTS,
+    THREAD_SUMMARY_STATES,
+    UNSUBSCRIBE_METHODS,
+    USERNAME_STATUSES,
+    WEBHOOK_EVENTS,
+    WEBHOOK_REPLAY_ERROR_CODES,
+    WEBHOOK_SIGNATURE_HEADERS,
+    WORKSPACE_KINDS,
+)
+
+create_client = OpenEmail
+
+__version__ = VERSION
+
+__all__ = [
+    'ADDRESS_FORWARD_CONSENT_STATUSES',
+    'ADDRESS_FORWARD_STATUSES',
+    'ADDRESS_MEMBER_VIAS',
+    'API_SCOPES',
+    'APP_HOST_STATUSES',
+    'AUDIENCE_MEMBER_STATUSES',
+    'BILLING_ALERT_KINDS',
+    'BILLING_ALERT_SEVERITIES',
+    'BILLING_ALERT_TARGETS',
+    'BILLING_INTERVALS',
+    'BILLING_INVOICE_SORTS',
+    'BILLING_INVOICE_STARTS',
+    'BILLING_INVOICE_STATUSES',
+    'BILLING_THEMES',
+    'BILLING_USAGE_WINDOWS',
+    'BIMI_STATUSES',
+    'BRAND_FONT_IDS',
+    'BRAND_IMAGE_TYPES',
+    'BRAND_IMAGE_VARIANTS',
+    'BROADCAST_RECIPIENT_FILTERS',
+    'BROADCAST_STATUSES',
+    'CALENDAR_REMINDER_ACTIONS',
+    'CALENDAR_RESPONSES',
+    'CALENDAR_TRANSPARENCIES',
+    'CALENDAR_VISIBILITIES',
+    'CHAT_SORTS',
+    'CONNECTED_APP_KINDS',
+    'CONNECTED_APP_STATUSES',
+    'CONSOLE_PERMISSIONS',
+    'CONTACT_BLOCK_LISTS',
+    'CONTACT_PHOTO_TYPES',
+    'CONTACT_THREAD_SORTS',
+    'CREDENTIAL_KINDS',
+    'DELIVERABILITY_CHECK_IDS',
+    'DELIVERABILITY_CHECK_STATUSES',
+    'DELIVERABILITY_GRADES',
+    'DNS_CONNECTION_STATUSES',
+    'DNS_PROVISION_STATES',
+    'DNS_SYNC_OUTCOMES',
+    'DNS_SYNC_PURPOSES',
+    'DNS_ZONE_RESOLUTION_KINDS',
+    'DOMAIN_ADDRESS_DESTINATIONS',
+    'DOMAIN_DMARC_POLICIES',
+    'DOMAIN_DMARC_STAGES',
+    'DOMAIN_LOGO_MARK_KINDS',
+    'DOMAIN_LOGO_RECORD_OUTCOMES',
+    'DOMAIN_RECORD_STATUSES',
+    'EMAIL_NOTIFICATION_CATEGORIES',
+    'ERROR_TYPES',
+    'EXPORT_PHASES',
+    'EXPORT_REFUSALS',
+    'EXPORT_STATUSES',
+    'FILE_DIRECTIONS',
+    'FILE_KINDS',
+    'FILE_SORTS',
+    'FILE_USAGES',
+    'FILE_VISIBILITIES',
+    'FORM_ALIGNS',
+    'FORM_CONFIRM_SOURCES',
+    'FORM_CONTACT_FIELDS',
+    'FORM_FIELD_ERRORS',
+    'FORM_FIELD_TYPES',
+    'FORM_FIELD_WIDTHS',
+    'FORM_FONTS',
+    'FORM_LAYOUTS',
+    'FORM_RADII',
+    'FORM_SENDER_ISSUES',
+    'FORM_STARTER_SLUGS',
+    'FORM_STATUSES',
+    'FORM_SUBMISSION_STATUSES',
+    'FORM_SUBSCRIBE_OUTCOMES',
+    'FORM_SUCCESS_ACTIONS',
+    'FORM_WIDTHS',
+    'LANGUAGES',
+    'LOGIN_BACKGROUND_KINDS',
+    'LOGIN_BACKGROUND_PRESETS',
+    'LOGIN_LOGOS',
+    'MESSAGE_ENCRYPTION_FORMATS',
+    'PAGE_LIMITS',
+    'PAID_PLAN_IDS',
+    'PAY_AS_YOU_GO_LIMITS_CENTS',
+    'PEOPLE_SORTS',
+    'PLAN_IDS',
+    'PROVIDER_IMPORT_DOMAIN_STATES',
+    'PROVIDER_IMPORT_RESOURCES',
+    'PROVIDER_IMPORT_STATUSES',
+    'REWRITE_ACTIONS',
+    'REWRITE_TARGETS',
+    'RULE_ACTIONS',
+    'RULE_FIELDS',
+    'RULE_OPERATORS',
+    'STEP_UP_ERROR_CODES',
+    'STEP_UP_METHODS',
+    'SUBSCRIPTION_DESTINATIONS',
+    'SUBSCRIPTION_SORTS',
+    'SUBSCRIPTION_STATUSES',
+    'SUPPRESSION_REASONS',
+    'TEMPLATE_IMAGE_TYPES',
+    'THREAD_NOTE_COLORS',
+    'THREAD_SORTS',
+    'THREAD_SUMMARY_STATES',
+    'UNSUBSCRIBE_METHODS',
+    'USERNAME_STATUSES',
+    'VERSION',
+    'WEBHOOK_EVENTS',
+    'WEBHOOK_REPLAY_ERROR_CODES',
+    'WEBHOOK_SIGNATURE_HEADERS',
+    'WORKSPACE_KINDS',
+    'AsyncOpenEmail',
+    'OpenEmail',
+    'OpenEmailApiError',
+    'OpenEmailError',
+    'OpenEmailNetworkError',
+    'WebhookVerificationError',
+    '__version__',
+    'create_async_temp_mail',
+    'create_client',
+    'create_temp_mail',
+    'get_client',
+    'init',
+    'is_access_token',
+    'is_api_key',
+    'is_rtl_language',
+    'is_sealed',
+    'language_by_code',
+    'openemail',
+    'reset_client',
+    'resolve_language',
+    'to_base64',
+    'verify_webhook_signature',
+]

openemail/_async/client.py

@@ -0,0 +1,383 @@
+from __future__ import annotations
+
+from functools import cached_property
+from typing import TYPE_CHECKING
+
+from openemail._async.transport import AsyncTransport
+from openemail._core.credentials import assert_credential, mode_of
+from openemail._core.environment import resolve_base_url, resolve_credentials
+from openemail._core.sentinel import NOT_GIVEN, NotGiven
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+    from types import TracebackType
+
+    import httpx
+    from typing_extensions import Self
+
+    from openemail._async.resources.account import AsyncAccount
+    from openemail._async.resources.addresses import AsyncAddresses
+    from openemail._async.resources.analytics import AsyncAnalytics
+    from openemail._async.resources.app_host import AsyncAppHost
+    from openemail._async.resources.audiences import AsyncAudiences
+    from openemail._async.resources.billing import AsyncBilling
+    from openemail._async.resources.branding import AsyncBranding
+    from openemail._async.resources.broadcasts import AsyncBroadcasts
+    from openemail._async.resources.calendar import AsyncCalendar
+    from openemail._async.resources.chats import AsyncChats
+    from openemail._async.resources.contacts import AsyncContacts
+    from openemail._async.resources.dns_connections import AsyncDnsConnections
+    from openemail._async.resources.domains import AsyncDomains
+    from openemail._async.resources.drafts import AsyncDrafts
+    from openemail._async.resources.emails import AsyncEmails
+    from openemail._async.resources.encryption import AsyncEncryption
+    from openemail._async.resources.exports import AsyncExports
+    from openemail._async.resources.files import AsyncFiles
+    from openemail._async.resources.forms import AsyncForms
+    from openemail._async.resources.imports import AsyncImports
+    from openemail._async.resources.keys import AsyncKeys
+    from openemail._async.resources.labels import AsyncLabels
+    from openemail._async.resources.languages import AsyncLanguages
+    from openemail._async.resources.me import AsyncMe
+    from openemail._async.resources.members import AsyncMembers
+    from openemail._async.resources.provider_imports import AsyncProviderImports
+    from openemail._async.resources.roles import AsyncRoles
+    from openemail._async.resources.rules import AsyncRules
+    from openemail._async.resources.security import AsyncSecurity
+    from openemail._async.resources.senders import AsyncSenders
+    from openemail._async.resources.settings import AsyncSettings
+    from openemail._async.resources.subscriptions import AsyncSubscriptions
+    from openemail._async.resources.support import AsyncSupport
+    from openemail._async.resources.suppressions import AsyncSuppressions
+    from openemail._async.resources.temp_mail import AsyncTempMail
+    from openemail._async.resources.templates import AsyncTemplates
+    from openemail._async.resources.threads import AsyncThreads
+    from openemail._async.resources.tools import AsyncTools
+    from openemail._async.resources.tracking import AsyncTracking
+    from openemail._async.resources.webhooks import AsyncWebhooks
+    from openemail._async.resources.workspaces import AsyncWorkspaces
+    from openemail.types import ApiKeyMode
+    from openemail.types.client import AsyncAccessTokenProvider
+
+
+class AsyncOpenEmail:
+    def __init__(
+        self,
+        api_key: str | NotGiven | None = NOT_GIVEN,
+        *,
+        access_token: str | AsyncAccessTokenProvider | NotGiven | None = NOT_GIVEN,
+        base_url: str | None = None,
+        http_client: httpx.AsyncClient | None = None,
+        max_retries: int | None = None,
+        timeout: float | None = None,
+        user_agent: str | None = None,
+        headers: Mapping[str, str] | None = None,
+        disable_update_notice: bool = False,
+    ) -> None:
+        key, token = resolve_credentials(api_key, access_token)
+
+        assert_credential(key, token, required=True)
+
+        self._transport = AsyncTransport(
+            api_key=key,
+            access_token=token,
+            base_url=resolve_base_url(base_url),
+            http_client=http_client,
+            max_retries=max_retries,
+            timeout=timeout,
+            user_agent=user_agent,
+            headers=headers,
+            disable_update_notice=disable_update_notice,
+        )
+        self.mode: ApiKeyMode = mode_of(key)
+
+    @property
+    def raw(self) -> AsyncTransport:
+        return self._transport
+
+    async def aclose(self) -> None:
+        await self._transport.aclose()
+
+    async def __aenter__(self) -> Self:
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        await self.aclose()
+
+    @cached_property
+    def me(self) -> AsyncMe:
+        from openemail._async.resources.me import AsyncMe
+
+        return AsyncMe(self._transport)
+
+    @cached_property
+    def security(self) -> AsyncSecurity:
+        from openemail._async.resources.security import AsyncSecurity
+
+        return AsyncSecurity(self._transport)
+
+    @cached_property
+    def keys(self) -> AsyncKeys:
+        from openemail._async.resources.keys import AsyncKeys
+
+        return AsyncKeys(self._transport)
+
+    @cached_property
+    def addresses(self) -> AsyncAddresses:
+        from openemail._async.resources.addresses import AsyncAddresses
+
+        return AsyncAddresses(self._transport)
+
+    @cached_property
+    def languages(self) -> AsyncLanguages:
+        from openemail._async.resources.languages import AsyncLanguages
+
+        return AsyncLanguages(self._transport)
+
+    @cached_property
+    def emails(self) -> AsyncEmails:
+        from openemail._async.resources.emails import AsyncEmails
+
+        return AsyncEmails(self._transport)
+
+    @cached_property
+    def templates(self) -> AsyncTemplates:
+        from openemail._async.resources.templates import AsyncTemplates
+
+        return AsyncTemplates(self._transport)
+
+    @cached_property
+    def tracking(self) -> AsyncTracking:
+        from openemail._async.resources.tracking import AsyncTracking
+
+        return AsyncTracking(self._transport)
+
+    @cached_property
+    def threads(self) -> AsyncThreads:
+        from openemail._async.resources.threads import AsyncThreads
+
+        return AsyncThreads(self._transport)
+
+    @cached_property
+    def drafts(self) -> AsyncDrafts:
+        from openemail._async.resources.drafts import AsyncDrafts
+
+        return AsyncDrafts(self._transport)
+
+    @cached_property
+    def labels(self) -> AsyncLabels:
+        from openemail._async.resources.labels import AsyncLabels
+
+        return AsyncLabels(self._transport)
+
+    @cached_property
+    def contacts(self) -> AsyncContacts:
+        from openemail._async.resources.contacts import AsyncContacts
+
+        return AsyncContacts(self._transport)
+
+    @cached_property
+    def audiences(self) -> AsyncAudiences:
+        from openemail._async.resources.audiences import AsyncAudiences
+
+        return AsyncAudiences(self._transport)
+
+    @cached_property
+    def billing(self) -> AsyncBilling:
+        from openemail._async.resources.billing import AsyncBilling
+
+        return AsyncBilling(self._transport)
+
+    @cached_property
+    def forms(self) -> AsyncForms:
+        from openemail._async.resources.forms import AsyncForms
+
+        return AsyncForms(self._transport)
+
+    @cached_property
+    def broadcasts(self) -> AsyncBroadcasts:
+        from openemail._async.resources.broadcasts import AsyncBroadcasts
+
+        return AsyncBroadcasts(self._transport)
+
+    @cached_property
+    def domains(self) -> AsyncDomains:
+        from openemail._async.resources.domains import AsyncDomains
+
+        return AsyncDomains(self._transport)
+
+    @cached_property
+    def app_host(self) -> AsyncAppHost:
+        from openemail._async.resources.app_host import AsyncAppHost
+
+        return AsyncAppHost(self._transport)
+
+    @cached_property
+    def branding(self) -> AsyncBranding:
+        from openemail._async.resources.branding import AsyncBranding
+
+        return AsyncBranding(self._transport)
+
+    @cached_property
+    def rules(self) -> AsyncRules:
+        from openemail._async.resources.rules import AsyncRules
+
+        return AsyncRules(self._transport)
+
+    @cached_property
+    def webhooks(self) -> AsyncWebhooks:
+        from openemail._async.resources.webhooks import AsyncWebhooks
+
+        return AsyncWebhooks(self._transport)
+
+    @cached_property
+    def imports(self) -> AsyncImports:
+        from openemail._async.resources.imports import AsyncImports
+
+        return AsyncImports(self._transport)
+
+    @cached_property
+    def provider_imports(self) -> AsyncProviderImports:
+        from openemail._async.resources.provider_imports import AsyncProviderImports
+
+        return AsyncProviderImports(self._transport)
+
+    @cached_property
+    def calendar(self) -> AsyncCalendar:
+        from openemail._async.resources.calendar import AsyncCalendar
+
+        return AsyncCalendar(self._transport)
+
+    @cached_property
+    def settings(self) -> AsyncSettings:
+        from openemail._async.resources.settings import AsyncSettings
+
+        return AsyncSettings(self._transport)
+
+    @cached_property
+    def roles(self) -> AsyncRoles:
+        from openemail._async.resources.roles import AsyncRoles
+
+        return AsyncRoles(self._transport)
+
+    @cached_property
+    def members(self) -> AsyncMembers:
+        from openemail._async.resources.members import AsyncMembers
+
+        return AsyncMembers(self._transport)
+
+    @cached_property
+    def suppressions(self) -> AsyncSuppressions:
+        from openemail._async.resources.suppressions import AsyncSuppressions
+
+        return AsyncSuppressions(self._transport)
+
+    @cached_property
+    def files(self) -> AsyncFiles:
+        from openemail._async.resources.files import AsyncFiles
+
+        return AsyncFiles(self._transport)
+
+    @cached_property
+    def temp_mail(self) -> AsyncTempMail:
+        from openemail._async.resources.temp_mail import AsyncTempMail
+
+        return AsyncTempMail(self._transport)
+
+    @cached_property
+    def exports(self) -> AsyncExports:
+        from openemail._async.resources.exports import AsyncExports
+
+        return AsyncExports(self._transport)
+
+    @cached_property
+    def chats(self) -> AsyncChats:
+        from openemail._async.resources.chats import AsyncChats
+
+        return AsyncChats(self._transport)
+
+    @cached_property
+    def encryption(self) -> AsyncEncryption:
+        from openemail._async.resources.encryption import AsyncEncryption
+
+        return AsyncEncryption(self._transport)
+
+    @cached_property
+    def support(self) -> AsyncSupport:
+        from openemail._async.resources.support import AsyncSupport
+
+        return AsyncSupport(self._transport)
+
+    @cached_property
+    def tools(self) -> AsyncTools:
+        from openemail._async.resources.tools import AsyncTools
+
+        return AsyncTools(self._transport)
+
+    @cached_property
+    def senders(self) -> AsyncSenders:
+        from openemail._async.resources.senders import AsyncSenders
+
+        return AsyncSenders(self._transport)
+
+    @cached_property
+    def analytics(self) -> AsyncAnalytics:
+        from openemail._async.resources.analytics import AsyncAnalytics
+
+        return AsyncAnalytics(self._transport)
+
+    @cached_property
+    def subscriptions(self) -> AsyncSubscriptions:
+        from openemail._async.resources.subscriptions import AsyncSubscriptions
+
+        return AsyncSubscriptions(self._transport)
+
+    @cached_property
+    def dns_connections(self) -> AsyncDnsConnections:
+        from openemail._async.resources.dns_connections import AsyncDnsConnections
+
+        return AsyncDnsConnections(self._transport)
+
+    @cached_property
+    def workspaces(self) -> AsyncWorkspaces:
+        from openemail._async.resources.workspaces import AsyncWorkspaces
+
+        return AsyncWorkspaces(self._transport)
+
+    @cached_property
+    def account(self) -> AsyncAccount:
+        from openemail._async.resources.account import AsyncAccount
+
+        return AsyncAccount(self._transport)
+
+
+def create_temp_mail(
+    *,
+    inbox_token: str | None = None,
+    base_url: str | None = None,
+    http_client: httpx.AsyncClient | None = None,
+    max_retries: int | None = None,
+    timeout: float | None = None,
+    user_agent: str | None = None,
+    headers: Mapping[str, str] | None = None,
+    disable_update_notice: bool = False,
+) -> AsyncTempMail:
+    from openemail._async.resources.temp_mail import AsyncTempMail
+
+    return AsyncTempMail(
+        AsyncTransport(
+            inbox_token=inbox_token,
+            base_url=resolve_base_url(base_url),
+            http_client=http_client,
+            max_retries=max_retries,
+            timeout=timeout,
+            user_agent=user_agent,
+            headers=headers,
+            disable_update_notice=disable_update_notice,
+        )
+    )