Configuração

Estes casos lançam ValueError, ou TypeError onde a tabela o indica, antes de qualquer pedido ser enviado, em vez de surgirem como uma falha confusa no seu primeiro envio. A mensagem indica o que estava errado e o que passar em vez disso.

Construa o cliente uma vez e partilhe-o. Uma nova instância por pedido deita fora o pool de ligações e a configuração sem qualquer ganho, e nenhum do estado que contém é específico de quem chama.

É seguro partilhar um cliente entre threads. close() ou o fim de um bloco with fecha o pool de ligações que ele abriu, e um http_client que tenha passado continua aberto para ser você a fechá-lo.

No caso que, de outro modo, obrigaria a uma instância por chave, como uma tarefa que envia em nome de vários espaços de trabalho, passe api_key na chamada. Substitui o cabeçalho Authorization para esse pedido e não deixa nada no 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 os métodos fora de temp_mail recebem-na como argumento nomeado, ao lado de timeout. É verificada antes de o pedido ser enviado, pela mesma regra que o construtor usa, pelo que um erro de escrita lança um ValueError que refere api_key= on this call em vez de um 401 sobre uma credencial que depois tem de ir procurar. Uma chamada repetida mantém a chave que lhe foi dada.

timeout é em segundos e substitui o timeout do cliente nessa única chamada, em cada uma das suas tentativas.

client.raw.request envia um pedido com a credencial, o URL base, o timeout e a política de repetições do cliente aplicados, e devolve o JSON analisado. Aceita method, query, body, api_key e timeout. Repete um GET e envia tudo o resto uma única vez, a não ser que passe repeatable=True. idempotent=True acrescenta um Idempotency-Key, o que passar como idempotency_key ou um novo.

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

create_temp_mail() constrói um cliente que não transporta nenhuma chave de API, e create_async_temp_mail() é o seu equivalente assíncrono. Cria caixas de entrada de forma anónima, e cada leitura envia o token da caixa de entrada que create devolveu, ou o mais recente que extend devolveu, seja por chamada como inbox_token ou uma única 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'])

Uma aplicação que alguém ligou por OAuth, como uma ferramenta de linha de comandos ou um agente, tem um token de acesso em vez de uma chave de API. Passe-o como access_token, seja o próprio token, seja uma função que o devolve, que em AsyncOpenEmail pode ser async. A função é chamada uma vez por cada chamada, e as repetições dessa chamada reutilizam o que ela devolveu, por isso renove o token dentro dela quando estiver perto de expirar e o cliente nunca terá de ser reconstruído.

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 uma alteração sensível, como apagar um domínio ou alterar um webhook, a API pede a um token de acesso o código de verificação que a aplicação web pediria à pessoa. A chamada lança um OpenEmailApiError cujo is_step_up_required é True, e nada foi alterado. Peça um código, verifique o que a pessoa lhe der e depois faça a chamada de novo. A uma chave de API nunca é pedido.

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)