Konfigurimi

use OpenEmail\OpenEmail; $client = new OpenEmail(); OpenEmail::init(timeout: 10);OpenEmail::getClient()->me->ping(); $billing = new OpenEmail(apiKey: (string) getenv('OPENEMAIL_BILLING_API_KEY')); echo $client->mode, ' ', $billing->mode, PHP_EOL;

Shndërrimi i getenv() në string është i qëllimshëm. Një variabël që nuk është vendosur bëhet çelës bosh, të cilin klienti e refuzon me një mesazh që emërton variablin që i duhet, ndërsa null do të kalonte në heshtje te OPENEMAIL_API_KEY.

use OpenEmail\Http\CurlHttpClient;use OpenEmail\OpenEmail; $client = new OpenEmail(    apiKey: (string) getenv('OPENEMAIL_API_KEY'),    baseUrl: 'https://api.openemail.uk',    httpClient: new CurlHttpClient(),    maxRetries: 2,    timeout: 30,    userAgent: 'billing-service/1.4',    headers: ['X-Team' => 'billing'],    disableUpdateNotice: true,);

Këto hedhin OpenEmail\Exception\InvalidArgumentException nga rreshti që përmbante vlerën e gabuar, në vend që të shfaqen si një dështim i paqartë në dërgimin tuaj të parë. Mesazhi thotë çfarë ishte gabim dhe çfarë të jepni në vend të saj, dhe nuk e përsërit kurrë një kredencial.

Klasa zgjeron vetë InvalidArgumentException të PHP-së, ndaj kodi që e kap tashmë atë vazhdon të funksionojë, dhe implementon OpenEmail\Exception\OpenEmailException si çdo përjashtim tjetër që hedh paketa. Një vlerë e tipit të gabuar, si një numër aty ku shkon një id string, është një TypeError nga vetë PHP-ja, sepse çdo metodë i deklaron tipet e saj.

Ndërtojeni klientin një herë dhe ndajeni. Një klient i ri për çdo kërkesë e hedh poshtë lidhjen e hapur pa asnjë përfitim, dhe asnjë pjesë e gjendjes mbi të nuk është e veçantë për thirrësin.

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

$message = [    'from' => '[email protected]',    'to' => '[email protected]',    'subject' => 'Your invoice',    'text' => 'Attached.',];$workspaceKey = (string) getenv('OPENEMAIL_API_KEY'); $client->emails->send($message); $client->emails->send($message, apiKey: $workspaceKey); $client->threads->list(folder: 'inbox', apiKey: $workspaceKey);$client->webhooks->list(apiKey: $workspaceKey);

Çdo metodë jashtë tempMail e merr si argumentin e saj të fundit me emër, pas filtrave të një liste, ndërsa metodat e tempMail marrin në vend të tij inboxToken:. Kontrollohet para se të dërgohet kërkesa, me të njëjtin rregull që përdor klienti, ndaj një gabim shtypi hedh një InvalidArgumentException për apiKey-n e dhënë në këtë thirrje, në vend të një 401 për një kredencial që pastaj duhet ta kërkoni. Një thirrje e riprovuar e ruan çelësin që iu dha.

$client->raw është transporti përmes të cilit kalon çdo metodë. $client->raw->request() thërret një shteg që ende nuk e mbështjell asnjë metodë, duke zbatuar kredencialin, URL-në bazë, afatin e skadimit dhe politikën e riprovimit të klientit, dhe kthen trupin e dekoduar ashtu si një metodë.

$ping = $client->raw->request('/ping'); $label = $client->raw->request('/labels', method: 'POST', body: ['name' => 'Invoices']); var_dump($ping, $label);

OpenEmail::createTempMail() ndërton një klient për kutitë e përkohshme që nuk mban çelës API dhe nuk lexon asnjë nga mjedisi. Krijon kuti në mënyrë anonime, dhe çdo lexim dërgon tokenin e kutisë që ktheu create, ose atë më të riun që ktheu extend, qoftë në çdo thirrje si inboxToken:, qoftë një herë si OpenEmail::createTempMail(inboxToken: ...).

use OpenEmail\OpenEmail; $tempMail = OpenEmail::createTempMail(); $inbox = $tempMail->create();$page = $tempMail->listMessages($inbox['id'], inboxToken: $inbox['token']); echo count($page->items), ' ', $page->expiresAt, PHP_EOL;

Një aplikacion që një person 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 accessToken:, qoftë vetë tokenin, qoftë një objekt të thirrshëm që e kthen atë, si një closure ose një first-class callable. Objekti i thirrshëm ekzekutohet një herë për çdo thirrje, dhe riprovat e asaj thirrjeje ripërdorin atë që ktheu, ndaj rinovojeni tokenin brenda tij kur i afrohet skadimi, dhe klienti nuk ka nevojë të rindërtohet kurrë.

use OpenEmail\OpenEmail; $tokens = ['current' => 'token-from-your-oauth-flow']; $oauthClient = new OpenEmail(accessToken: fn(): string => $tokens['current']); $me = $oauthClient->me->get(); if ($me['object'] === 'oauth_token') {    echo $me['clientId'], ' ', $me['expiresAt'], PHP_EOL;}

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 hedh një PermissionException, një 403 me isStepUpRequired() true, dhe asgjë nuk ndryshoi. 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ë.

use OpenEmail\Exception\ApiException; $domainId = 'b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f'; try {    $client->domains->delete($domainId);} catch (ApiException $error) {    if (!$error->isStepUpRequired()) {        throw $error;    }     $challenge = $client->security->beginStepUp();     if ($challenge['method'] === 'email') {        echo 'Enter the code we emailed to ', $challenge['sentTo'], PHP_EOL;    } else {        echo 'Enter the code from your authenticator app, or a backup code', PHP_EOL;    }     $client->security->verifyStepUp(['code' => trim((string) fgets(STDIN))]);    $client->domains->delete($domainId);}

Kur në Packagist ka një version më të ri të paketës, klienti e thotë këtë një herë për proces, në daljen standarde të gabimeve, me një rresht si ℹ openemail/sdk 0.0.2 is available, you are on 0.0.1. të ndjekur nga faqja e paketës. Kontrolli ekzekutohet vetëm në rreshtin e komandave, kur dalja standarde është një terminal, dhe kurrë nën një server web. Nis kur ndërtohet klienti i parë dhe ecën krahas kërkesave tuaja, dhe në fund të skriptit pret sa ka mbetur nga një buxhet prej dy sekondash. Një dështim për të arritur Packagist shpërfillet.

CurlHttpClient i parazgjedhur ia lë proxy-t cURL-it, i cili lexon https_proxy ose HTTPS_PROXY për proxy-n dhe no_proxy ose NO_PROXY për hostet që lidhen drejtpërdrejt. Jepni proxy: për ta emërtuar një në kod. Emri i përdoruesit dhe fjalëkalimi në URL-në e proxy-t i dërgohen proxy-t.

use OpenEmail\Http\CurlHttpClient;use OpenEmail\OpenEmail; $client = new OpenEmail(httpClient: new CurlHttpClient(    caBundle: '/etc/ssl/certs/corporate-ca.pem',    proxy: 'http://proxy.internal:3128',    curlOptions: [CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4],));