Konfigurimi

Këto ngrenë ValueError (ose TypeError, aty ku e thotë tabela) para se të dërgohet ndonjë kërkesë, në vend që të shfaqen si një dështim ngatërrues te dërgimi juaj i parë. Mesazhi thotë çfarë ishte gabim dhe çfarë të jepni në vend të saj.

Ndërtojeni klientin një herë dhe përdorni të njëjtin kudo. Një instancë e re për çdo kërkesë hedh poshtë pool-in e lidhjeve dhe konfigurimin pa asnjë përfitim, dhe asnjë pjesë e gjendjes mbi të nuk është e veçantë për thirrësin.

Një klient mund të ndahet pa rrezik mes thread-eve. close() ose fundi i një blloku with mbyll pool-in e lidhjeve që hapi ai, ndërsa një http_client që keni dhënë ju mbetet i hapur që ta mbyllni vetë.

Për rastin që përndryshe do të detyronte një instancë për çdo çelës, si një punë që dërgon në emër të disa hapësirave pune, jepni api_key te vetë thirrja. Ai zëvendëson header-in Authorization për atë kërkesë dhe nuk lë asgjë pas te klienti.

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)

Çdo metodë jashtë temp_mail e merr si argument me fjalë kyçe, pranë timeout. Kontrollohet para se të dërgohet kërkesa, me të njëjtin rregull që përdor konstruktori, ndaj një gabim shtypi ngre një ValueError që përmend api_key= on this call në vend të një 401 për një kredencial që pastaj duhet të shkoni ta gjeni. Një thirrje e riprovuar e mban çelësin që iu dha.

timeout jepet në sekonda dhe zëvendëson timeout-in e klientit për atë thirrje të vetme, në secilën nga përpjekjet e saj.

client.raw.request dërgon një kërkesë me kredencialin, URL-në bazë, timeout-in dhe politikën e riprovimeve të klientit të zbatuara, dhe kthen JSON-in e analizuar. Merr method, query, body, api_key dhe timeout. Riprovon një GET dhe çdo gjë tjetër e dërgon një herë, përveç nëse jepni repeatable=True. idempotent=True shton një Idempotency-Key, atë që jepni si idempotency_key ose një të ri.

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

create_temp_mail() ndërton një klient që nuk mban asnjë çelës API, dhe create_async_temp_mail() është binjaku i tij asinkron. Ai krijon kuti në mënyrë anonime, dhe çdo lexim dërgon token-in e kutisë që ktheu create, ose atë më të ri që ktheu extend, qoftë për çdo thirrje si inbox_token, qoftë një herë si 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'])

Një aplikacion që dikush e lidhi përmes OAuth, si një mjet i rreshtit të komandave ose një agjent, mban një token qasjeje në vend të një çelësi API. Jepeni si access_token, qoftë vetë tokenin, qoftë një funksion që e kthen atë, i cili te AsyncOpenEmail mund të jetë async. Funksioni thirret një herë për çdo thirrje, dhe riprovimet e asaj thirrjeje ripërdorin atë që ktheu, ndaj rinovojeni tokenin brenda tij kur i afrohet skadimit dhe klienti nuk ka nevojë të rindërtohet kurrë.

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

Para një ndryshimi të ndjeshëm, si fshirja e një domeni ose ndryshimi i një webhook-u, API-ja i kërkon një tokeni qasjeje kodin e verifikimit që aplikacioni web do t'ia kërkonte personit. Thirrja ngre një OpenEmailApiError me is_step_up_required të barabartë me True, dhe asgjë nuk u ndryshua. Kërkoni një kod, verifikoni atë që ju jep personi, pastaj bëjeni thirrjen sërish. Një çelësi API nuk i kërkohet kurrë.

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)