Aller à la documentation
Python

Journal des versions

Toutes les versions du paquet, de la plus récente à la plus ancienne.

0.0.1

La première version. Elle couvre tout le SDK TypeScript tel qu'il était en 0.0.8, plus les changements prévus après : 430 méthodes dans 41 espaces de noms, chacune sous son nom TypeScript en snake_case. Un contrôle de parité prouve que chacune d'elles envoie exactement la requête qu'envoie son équivalent TypeScript, une fois sans option et une fois avec toutes les options renseignées.

  • OpenEmail et AsyncOpenEmail ont un attribut pour chaque espace de noms, d'emails, threads et templates à provider_imports, dns_connections et account. listAll devient list_all, getActive devient get_active, et tempMail devient temp_mail.
  • Le corps d'une requête est un dictionnaire dont les clés gardent les noms en camelCase de l'API, les options d'un appel sont des arguments nommés en snake_case comme idempotency_key= et limit=, et une réponse revient sous forme de dictionnaire. Chaque corps et chaque résultat a un TypedDict dans openemail.types, nommé comme en TypeScript.
  • AsyncOpenEmail a les mêmes méthodes avec les mêmes arguments, appelées avec await, et fonctionne sur asyncio comme sur trio.
  • Chaque ressource paginée a list pour une page, list_all pour tous les éléments sous forme de liste, et iterate, qui fournit les éléments un par un et ne récupère la page suivante qu'au moment d'y arriver.
  • Un refus de l'API lève OpenEmailApiError, avec status, type, code, param et request_id, ainsi que is_validation, is_not_found, is_rate_limited, is_step_up_required, is_retryable et les autres vérifications. L'absence de toute réponse lève OpenEmailNetworkError, avec is_timeout quand le délai est dépassé.
  • from openemail import openemail est un client prêt à l'emploi, construit à partir d'OPENEMAIL_API_KEY la première fois qu'on l'utilise, et init le configure une fois au démarrage. create_temp_mail et create_async_temp_mail ouvrent des boîtes jetables sans aucun identifiant.
  • access_token= accepte un jeton d'accès OAuth ou une fonction qui en renvoie un, appelée avant chaque requête. verify_webhook_signature vérifie une livraison en temps constant et renvoie l'événement analysé. client.raw.request atteint un endpoint qu'aucune méthode n'enveloppe encore.
  • Les lectures sont réessayées sur 408 et 5xx, et un 429 seulement s'il porte Retry-After. timeout borne toute la tentative, corps de la réponse compris, et un identifiant n'est jamais envoyé en HTTP simple, sauf à un serveur situé sur cette machine.
  • Il nécessite Python 3.10 ou plus récent, et ne dépend que de httpx, anyio et typing-extensions.