Zur Dokumentation springen
Python

Changelog

Jedes Release des Pakets, neueste zuerst.

0.0.1

Die erste Veröffentlichung. Diese Version deckt das gesamte TypeScript-SDK in seinem Stand von 0.0.8 ab, dazu die danach eingereihten Änderungen: 430 Methoden in 41 Namespaces, jede unter ihrem TypeScript-Namen in snake_case. Eine Paritätsprüfung belegt, dass jede von ihnen genau die Anfrage sendet, die ihr TypeScript-Gegenstück sendet, einmal ohne Optionen und einmal mit allen gesetzten Optionen.

  • OpenEmail und AsyncOpenEmail haben ein Attribut für jeden Namespace, von emails, threads und templates bis zu provider_imports, dns_connections und account. Aus listAll wird list_all, aus getActive wird get_active und aus tempMail wird temp_mail.
  • Ein Request-Body ist ein dict, dessen Schlüssel die camelCase-Namen der API behalten, die Optionen eines Aufrufs sind Schlüsselwortargumente in snake_case wie idempotency_key= und limit=, und eine Antwort kommt als dict zurück. Zu jedem Body und jedem Ergebnis gibt es ein TypedDict in openemail.types, benannt wie in TypeScript.
  • AsyncOpenEmail hat dieselben Methoden mit denselben Argumenten, mit await aufgerufen, und läuft auf asyncio und auf trio.
  • Jede paginierte Ressource hat list für eine Seite, list_all für alle Einträge als Liste und iterate, das Einträge liefert und die nächste Seite erst holt, wenn es dort ankommt.
  • Eine Ablehnung durch die API löst OpenEmailApiError aus, mit status, type, code, param und request_id sowie is_validation, is_not_found, is_rate_limited, is_step_up_required, is_retryable und den anderen Prüfungen. Bleibt jede Antwort aus, wird OpenEmailNetworkError ausgelöst, mit is_timeout, wenn die Frist verstrichen ist.
  • from openemail import openemail ist ein fertiger Client, der beim ersten Zugriff aus OPENEMAIL_API_KEY erzeugt wird, und init konfiguriert ihn einmalig beim Start. create_temp_mail und create_async_temp_mail öffnen Wegwerf-Postfächer ohne Anmeldedaten.
  • access_token= nimmt ein OAuth-Zugriffstoken oder eine Funktion entgegen, die eines zurückgibt und vor jeder Anfrage aufgerufen wird. verify_webhook_signature prüft eine Zustellung in konstanter Zeit und gibt das geparste Event zurück. client.raw.request erreicht einen Endpunkt, den noch keine Methode kapselt.
  • Lesevorgänge werden bei 408 und 5xx wiederholt, ein 429 nur, wenn er Retry-After mitführt. timeout begrenzt den gesamten Versuch, einschließlich des Antwort-Bodys, und Anmeldedaten werden nie über einfaches HTTP gesendet, außer an einen Server auf diesem Rechner.
  • Es braucht Python 3.10 oder neuer und hängt nur von httpx, anyio und typing-extensions ab.