Configuración

Estos casos lanzan ValueError, o TypeError donde lo indica la tabla, antes de enviar ninguna solicitud, en lugar de aparecer como un fallo confuso en tu primer envío. El mensaje indica qué estaba mal y qué pasar en su lugar.

Construye el cliente una vez y compártelo. Una instancia nueva por solicitud desecha el pool de conexiones y la configuración sin ganar nada, y ninguno de sus estados es propio de cada llamante.

Un mismo cliente se puede compartir entre hilos sin riesgo. close() o el final de un bloque with cierra el pool de conexiones que abrió, y un http_client que hayas pasado sigue abierto para que lo cierres tú.

Para el caso que de otro modo obligaría a una instancia por clave, como un trabajo que envía en nombre de varios espacios de trabajo, pasa api_key en la llamada. Sustituye la cabecera Authorization de esa solicitud y no deja nada en el cliente.

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)

Todos los métodos fuera de temp_mail la aceptan como argumento nombrado, junto a timeout. Se comprueba antes de enviar la solicitud, con la misma regla que usa el constructor, así que una errata lanza un ValueError que menciona api_key= on this call en lugar de un 401 sobre una credencial que luego tienes que ir a buscar. Una llamada reintentada conserva la clave que se le dio.

timeout va en segundos y sustituye el tiempo de espera del cliente en esa única llamada, en cada uno de sus intentos.

client.raw.request envía una solicitud aplicando la credencial, la URL base, el tiempo de espera y la política de reintentos del cliente, y devuelve el JSON analizado. Acepta method, query, body, api_key y timeout. Reintenta un GET y envía cualquier otra cosa una sola vez, salvo que pases repeatable=True. idempotent=True añade un Idempotency-Key, el que pases como idempotency_key o uno nuevo.

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

create_temp_mail() construye un cliente que no lleva ninguna clave de API, y create_async_temp_mail() es su equivalente asíncrono. Crea buzones de forma anónima, y cada lectura envía el token de buzón que devolvió create, o el más reciente que devolvió extend, bien por llamada como inbox_token, bien una sola vez como 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'])

Una app que una persona conectó por OAuth, como una herramienta de línea de comandos o un agente, tiene un token de acceso en lugar de una clave de API. Pásalo como access_token, ya sea el propio token o una función que lo devuelva, que en AsyncOpenEmail puede ser async. La función se llama una vez por cada llamada, y los reintentos de esa llamada reutilizan lo que devolvió, así que renueva el token dentro de ella cuando esté a punto de caducar y nunca tendrás que reconstruir el cliente.

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

Antes de un cambio delicado, como eliminar un dominio o cambiar un webhook, la API pide a un token de acceso el código de verificación que la app web le pediría a la persona. La llamada lanza un OpenEmailApiError cuyo is_step_up_required es True, y no se cambió nada. Pide un código, verifica el que te dé la persona y vuelve a hacer la llamada. A una clave de API nunca se le pide.

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)