Yapılandırma

Bunlar, ilk gönderiminizde kafa karıştırıcı bir hata olarak ortaya çıkmak yerine, herhangi bir istek gönderilmeden önce ValueError ya da tablonun belirttiği yerlerde TypeError fırlatır. Mesaj, neyin yanlış olduğunu ve yerine ne geçirilmesi gerektiğini söyler.

İstemciyi bir kez oluşturup paylaşın. İstek başına yeni bir örnek, bağlantı havuzunu ve yapılandırmayı boşuna çöpe atar ve üzerindeki durumların hiçbiri çağıran başına değildir.

Tek bir istemciyi iş parçacıkları arasında paylaşmak güvenlidir. close() ya da bir with bloğunun sonu, istemcinin açtığı bağlantı havuzunu kapatır; sizin geçirdiğiniz bir http_client ise kapatmanız için açık kalır.

Birkaç çalışma alanı adına gönderim yapan bir iş gibi, aksi hâlde anahtar başına bir örnek gerektirecek durumlarda api_key değerini çağrıda geçirin. O istek için Authorization başlığının yerini alır ve istemcide arkasında hiçbir iz bırakmaz.

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)

temp_mail dışındaki her metot bunu timeout ile birlikte bir anahtar sözcük argümanı olarak alır. İstek gönderilmeden önce, oluşturucunun kullandığı kuralla denetlenir; böylece bir yazım hatası, sonradan aramak zorunda kalacağınız bir kimlik bilgisi hakkında 401 yerine api_key= on this call diyen bir ValueError fırlatır. Yeniden denenen bir çağrı kendisine verilen anahtarı korur.

timeout saniye cinsindendir ve yalnızca o tek çağrı için, her denemesinde, istemcinin zaman aşımının yerini alır.

client.raw.request, istemcinin kimlik bilgisi, temel URL'si, zaman aşımı ve yeniden deneme politikası uygulanmış olarak bir istek gönderir ve ayrıştırılmış JSON'u döndürür. method, query, body, api_key ve timeout alır. Bir GET isteğini yeniden dener, geri kalan her şeyi ise repeatable=True geçirmediğiniz sürece bir kez gönderir. idempotent=True bir Idempotency-Key ekler: idempotency_key olarak geçirdiğiniz anahtarı ya da yeni bir anahtarı.

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

create_temp_mail(), hiç API anahtarı taşımayan bir istemci kurar ve create_async_temp_mail() onun asenkron ikizidir. Gelen kutularını anonim olarak oluşturur ve her okuma, create çağrısının döndürdüğü gelen kutusu token'ını ya da extend çağrısının döndürdüğü daha yeni token'ı gönderir: ya çağrı başına inbox_token olarak ya da bir kez create_temp_mail(inbox_token=...) şeklinde.

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

Bir kişinin OAuth ile bağladığı bir uygulama, örneğin bir komut satırı aracı ya da bir ajan, API anahtarı yerine bir erişim tokenı tutar. Onu access_token olarak geçirin: ya tokenın kendisini ya da onu döndüren bir fonksiyonu; bu fonksiyon AsyncOpenEmail üzerinde async olabilir. Fonksiyon her çağrı için bir kez çağrılır ve o çağrının yeniden denemeleri onun döndürdüğünü kullanır; bu yüzden token süresinin dolmasına yaklaştığında onu fonksiyonun içinde yenileyin, istemcinin hiç yeniden kurulması gerekmez.

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

Bir alan adını silmek ya da bir webhook'u değiştirmek gibi hassas bir değişiklikten önce API, bir erişim tokenından web uygulamasının kişiden isteyeceği doğrulama kodunu ister. Çağrı, is_step_up_required değeri True olan bir OpenEmailApiError fırlatır ve hiçbir şey değişmemiştir. Bir kod isteyin, kişinin size verdiğini doğrulayın, sonra çağrıyı yeniden yapın. Bir API anahtarından asla istenmez.

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)