Konfiguration

Diese lösen ValueError aus (oder TypeError, wo die Tabelle es angibt), bevor irgendeine Anfrage gesendet wird, statt beim ersten Versand als verwirrender Fehler aufzutauchen. Die Meldung nennt, was falsch war und was stattdessen zu übergeben ist.

Erzeugen Sie den Client einmal und teilen Sie ihn. Eine frische Instanz pro Anfrage wirft den Verbindungspool und die Konfiguration ohne Gegenwert weg, und kein Zustand darauf ist aufruferspezifisch.

Ein Client lässt sich gefahrlos zwischen Threads teilen. close() oder das Ende eines with-Blocks schließt den Verbindungspool, den er geöffnet hat, und ein von Ihnen übergebener http_client bleibt offen, damit Sie ihn selbst schließen.

Für den Fall, der sonst eine Instanz pro Schlüssel erzwingen würde, etwa einen Job, der im Namen mehrerer Workspaces sendet, übergeben Sie api_key beim Aufruf. Er ersetzt den Authorization-Header für diese Anfrage und hinterlässt nichts am Client.

from openemail.types import EmailSend workspace_key = 'oe_live_...' message: EmailSend = {'from': sender, 'to': recipient, 'subject': subject, 'text': text} client.emails.send(message) client.emails.send(message, api_key=workspace_key) client.threads.list(folder='inbox', api_key=workspace_key)client.webhooks.list(api_key=workspace_key)

Jede Methode außerhalb von temp_mail nimmt ihn als Schlüsselwortargument entgegen, neben timeout. Er wird vor dem Senden der Anfrage nach derselben Regel geprüft, die der Konstruktor verwendet, ein Tippfehler löst daher einen ValueError aus, der api_key= on this call nennt, statt eines 401 zu Anmeldedaten, die Sie dann erst suchen müssten. Ein wiederholter Aufruf behält den Schlüssel, den er bekommen hat.

timeout wird in Sekunden angegeben und ersetzt das Timeout des Clients für diesen einen Aufruf, bei jedem seiner Versuche.

client.raw.request sendet eine Anfrage mit den Anmeldedaten, der Basis-URL, dem Timeout und der Retry-Policy des Clients und gibt das geparste JSON zurück. Es nimmt method, query, body, api_key und timeout entgegen. Ein GET wird wiederholt, alles andere einmal gesendet, sofern Sie nicht repeatable=True übergeben. idempotent=True fügt einen Idempotency-Key hinzu, und zwar den, den Sie als idempotency_key übergeben, oder einen frischen.

result = client.raw.request('/something-new', method='POST', body={'name': 'Invoices'})

create_temp_mail() erzeugt einen Client ohne API-Schlüssel, und create_async_temp_mail() ist sein asynchrones Gegenstück. Er legt Postfächer anonym an, und jeder Lesezugriff sendet das Postfach-Token, das create zurückgegeben hat, oder das neuere, das extend zurückgegeben hat, entweder pro Aufruf als inbox_token oder einmalig als create_temp_mail(inbox_token=...).

from openemail import create_temp_mail temp_mail = create_temp_mail() inbox = temp_mail.create()messages = temp_mail.list_messages(inbox['id'], inbox_token=inbox['token']) print(messages['items'], messages['expiresAt'])

Eine App, die jemand über OAuth verbunden hat, etwa ein Kommandozeilenwerkzeug oder ein Agent, hält ein Zugriffstoken statt eines API-Schlüssels. Übergeben Sie es als access_token, entweder das Token selbst oder eine Funktion, die es zurückgibt und auf AsyncOpenEmail auch async sein darf. Die Funktion wird einmal pro Aufruf aufgerufen, und die Wiederholungen dieses Aufrufs verwenden, was sie zurückgab. Erneuern Sie das Token also darin, wenn es bald abläuft, dann muss der Client nie neu gebaut werden.

from openemail import OpenEmail client = OpenEmail(access_token=session.fresh_access_token) me = client.me.get() if me['object'] == 'oauth_token':    print(me['clientId'], me['expiresAt'])

Vor einer heiklen Änderung, etwa dem Löschen einer Domain oder dem Ändern eines Webhooks, verlangt die API von einem Zugriffstoken den Bestätigungscode, den die Web-App von der Person verlangen würde. Der Aufruf löst einen OpenEmailApiError aus, dessen is_step_up_required True ist, und es wurde nichts geändert. Fordern Sie einen Code an, bestätigen Sie den, den die Person Ihnen gibt, und rufen Sie dann erneut auf. Ein API-Schlüssel wird nie gefragt.

from openemail import OpenEmailApiError try:    client.domains.delete(domain_id)except OpenEmailApiError as error:    if not error.is_step_up_required:        raise     challenge = client.security.begin_step_up()     if challenge['method'] == 'email':        prompt = f'Enter the code we emailed to {challenge.get("sentTo")}: '    else:        prompt = 'Enter the code from your authenticator app, or a backup code: '     client.security.verify_step_up({'code': input(prompt)})    client.domains.delete(domain_id)