Configuration

Ces cas lèvent ValueError, ou TypeError là où le tableau l'indique, avant l'envoi de toute requête, au lieu de ressortir en échec déroutant à votre premier envoi. Le message dit ce qui n'allait pas et quoi passer à la place.

Construisez le client une fois et partagez-le. Une nouvelle instance par requête jette pour rien le pool de connexions et la configuration, et aucun état qu'il porte n'est propre à un appelant.

Un même client peut être partagé sans risque entre threads. close() ou la fin d'un bloc with ferme le pool de connexions qu'il a ouvert, et un http_client que vous avez passé reste ouvert : c'est à vous de le fermer.

Pour le cas qui imposerait sinon une instance par clé, comme un job qui envoie pour le compte de plusieurs espaces de travail, passez api_key sur l'appel. Il remplace l'en-tête Authorization pour cette requête et ne laisse rien derrière lui sur le 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)

Toutes les méthodes hors temp_mail l'acceptent comme argument nommé, à côté de timeout. Elle est vérifiée avant l'envoi de la requête, par la règle qu'utilise le constructeur : une faute de frappe lève donc une ValueError qui nomme api_key= on this call plutôt qu'un 401 portant sur un identifiant qu'il faut ensuite aller chercher. Un appel réessayé conserve la clé qu'on lui a donnée.

timeout est en secondes et remplace le timeout du client pour ce seul appel, sur chacune de ses tentatives.

client.raw.request envoie une requête en appliquant l'identifiant, l'URL de base, le timeout et la politique de réessai du client, et renvoie le JSON analysé. Cette méthode accepte method, query, body, api_key et timeout. Elle réessaie un GET et envoie tout le reste une seule fois, sauf si vous passez repeatable=True. idempotent=True ajoute un Idempotency-Key, celui que vous passez comme idempotency_key ou un nouveau.

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

create_temp_mail() construit un client qui ne porte aucune clé API, et create_async_temp_mail() est son équivalent asynchrone. Il crée des boîtes anonymement, et chaque lecture envoie le jeton de boîte renvoyé par create, ou le plus récent renvoyé par extend, soit à chaque appel via inbox_token, soit une fois pour toutes via 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'])

Une application qu'une personne a connectée en OAuth, comme un outil en ligne de commande ou un agent, détient un jeton d'accès plutôt qu'une clé API. Passez-le comme access_token, soit le jeton lui-même, soit une fonction qui le renvoie et qui, sur AsyncOpenEmail, peut être async. La fonction est appelée une fois par appel, et les nouvelles tentatives de cet appel réutilisent ce qu'elle a renvoyé : renouvelez donc le jeton à l'intérieur quand il approche de son expiration, et le client n'a jamais à être reconstruit.

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'])

Avant un changement sensible, comme supprimer un domaine ou modifier un webhook, l'API demande à un jeton d'accès le code de vérification que l'application web demanderait à la personne. L'appel lève une OpenEmailApiError dont is_step_up_required vaut True, et rien n'a été modifié. Demandez un code, vérifiez celui que la personne vous donne, puis refaites l'appel. On ne le demande jamais à une clé API.

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)