Skicat
`drafts->list`, `listAll`, `iterate`, `get`, `create`, `update` dhe `delete`.
Çdo metodë
$page = $client->drafts->list(query: 'invoice', limit: 25);$draft = $client->drafts->get('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8');echo count($page), ' ', $draft['subject'], PHP_EOL; $created = $client->drafts->create([ 'to' => ['[email protected]'], 'cc' => [], 'bcc' => [], 'subject' => 'Your September invoice', 'html' => '<p>Draft body.</p>', 'from' => '[email protected]', 'threadId' => 'CAHk7pQ2x9LmZ4-mail.example.com',]); $updated = $client->drafts->update($created['id'], ['subject' => 'Revised']);$client->drafts->delete($updated['id']);update e ruan id-në e draftit, ndaj vlera me të cilën përgjigjet është gjithmonë ajo që dhatë. Një id e panjohur jep një 404, të hedhur si NotFoundException, dhe jo një draft të ri.
Fushat e një drafti janë çelësat e një array-i të vetëm me emrat e API-së, ndaj thread-i të cilit i përgjigjet një draft është threadId. Një draft kthehet si array me çelësa në camelCase, ndaj $draft['subject'] lexon subjektin. Çdo shkrim përgjigjet vetëm me object dhe id, ndaj lexojeni gjithë draftin me get.
list faqos njësoj si threads->list. pageToken i API-së kthehet si nextCursor dhe hyn si cursor:, ndërsa listAll dhe iterate e ndjekin për ju. iterate kthen një Generator që jep një draft në një kohë. Një faqe mban 25 drafte, veç nëse limit: kërkon deri në 100. query: merr sintaksën e kërkimit të threads->list, dhe kërkimi nuk del kurrë jashtë drafteve. Një rresht është vetëm object dhe id, ndaj thirrni get për marrësit, subjektin dhe trupin.
Lista e drafteve nuk deklaron hasMore, ndaj hasMore është true sa herë që është kthyer një cursor. Serveri ofron një të tillë sa herë që një faqe është e plotë, ndaj një faqe e fundit që rastësisht është e plotë pasohet nga një faqe bosh.
Një draft ruhet si thread me etiketën DRAFT, prandaj $client->threads->list(folder: 'draft') liston të njëjtat drafte. get, update dhe delete i përgjigjen një id-je të zakonshme thread-i me një 404, edhe pse threads->get e hap atë. delete e heq një draft përgjithmonë. Ai nuk shkon te koshi dhe nuk ka kthim pas.
Për të dërguar një draft, jepini id-në e tij emails->send si draftId. Drafti jep përmbajtjen dhe dërgimi jep zarfin. Një draft nuk mund të kombinohet me template ose translate.
$client->emails->send([ 'from' => '[email protected]', 'to' => '[email protected]', 'draftId' => 'draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8',]);Parametrat: drafts->create dhe drafts->update
toarray- Adresat e marrësve si një listë string-esh, jo format array që pranon `emails->send`, sepse ky endpoint e bashkon listën në string-un e ndarë me presje që do driver-i. Një string mund të mbartë një emër shfaqjeje, si te `Ada Lovelace <[email protected]>`, por një emër që përmban presje ndahet në dy marrës të prishur. Ndryshe nga `emails->send`, këtu klienti nuk e mbështjell një string të vetëm në një listë, ndaj jepni `['[email protected]']`. Te krijimi, një listë e lënë jashtë ruhet bosh. Te përditësimi, një fushë e lënë jashtë i lë të paprekur marrësit e ruajtur, sepse handler-i lexon fillimisht draftin dhe pastaj i bashkon.
ccarray- Adresat Cc, në të njëjtën formë si `to`. Bosh te krijimi kur lihen jashtë, dhe të paprekura te përditësimi kur lihen jashtë.
bccarray- Adresat Bcc, në të njëjtën formë si `to`. Bosh te krijimi kur lihen jashtë, dhe të paprekura te përditësimi kur lihen jashtë.
subjectstring- Subjekti i draftit, me më së shumti 998 karaktere, kufiri i rreshtit sipas RFC 5322. Te krijimi, parazgjedhja është një string bosh, dhe një subjekt bosh ruhet si `(no subject)`, ndaj një draft ka gjithmonë subjekt.
htmlstring- Trupi i draftit si markup, me më së shumti 1.000.000 karaktere. Është trupi që fiton. `html` dhe `text` ushqejnë fushën e vetme të mesazhit të driver-it, ndaj dërgimi i të dyjave ruan këtë.
textstring- Një trup me tekst të thjeshtë, me më së shumti 1.000.000 karaktere, i përdorur vetëm kur `html` mungon. Drafti ruan një trup të vetëm dhe jo dy pjesë, ndaj teksti i dhënë këtu kthehet i pakonvertuar te `html` kur lexohet drafti.
fromstring or null- Adresa e dërguesit që ruhet te drafti, me ose pa emër shfaqjeje. Kur lihet jashtë te krijimi, drafti nuk ka dërgues. Te përditësimi bartet nga drafti i ruajtur kur lihet jashtë. Driver-i e rindërton gjithë mesazhin nga ajo që i jepet, ndaj një patch i pjesshëm që do ta hiqte do ta ndryshonte në heshtje dërguesin e zgjedhur. Një string bosh ose null te përditësimi e pastron.
threadIdstring- Lidheni draftin me një thread ekzistues që të ruhet si përgjigje. Si `from`, bartet te përditësimi kur lihet jashtë, sepse rindërtimi i mesazhit pa të do ta shkëpuste përgjigjen nga thread-i i saj. Një string bosh te përditësimi e shkëput. Drafti ruhet prapëseprapë si thread më vete me id-në e vet, ndaj listohet me draftet dhe jo brenda thread-it të cilit i përgjigjet.
Lëreni jashtë një fushë për ta ruajtur. Dhënia e null nuk është e njëjta gjë. Klienti e dërgon, dhe çdo fushë e refuzon me një 422 invalid_parameter, përveç from te përditësimi, ku null e pastron dërguesin. Kalojeni një array me vlera opsionale përmes array_filter($fields, static fn(mixed $value): bool => $value !== null) para se ta jepni. Edhe trupi është i rreptë. Një fushë jashtë këtyre tetë refuzohet në të njëjtën mënyrë, dhe nuk ka fushë për bashkëngjitjet.
Përgjigjja: një draft (drafts->get)
objectstring- Gjithmonë `draft`.
idstring- Id-ja e draftit, `draft-` e ndjekur nga një UUID. Shkrimet përgjigjen vetëm me `object` dhe `id`, jo me gjithë draftin, ndaj lexojeni id-në nga rezultati në vend që të ripërdorni atë që dërguat.
toarray- Adresat e marrësve siç i ruajti drafti, të zhveshura, pa emrin e shfaqjes. Një listë bosh, kurrë null, kur drafti nuk ka asnjë.
ccarray- Adresat Cc siç janë ruajtur. Një listë bosh, kurrë null, kur drafti nuk ka asnjë.
bccarray- Adresat Bcc siç janë ruajtur. Një listë bosh, kurrë null, kur drafti nuk ka asnjë.
subjectstring- Subjekti i ruajtur, kurrë null. Një draft i ruajtur pa subjekt lexohet si `(no subject)`, mbajtësi i vendit që ruan kutia postare, ndaj krahasoni me këtë në vend që të kontrolloni për një string bosh.
htmlstring- Trupi i ruajtur, ose një string bosh kur drafti nuk ka trup. Në dalje nuk ka fushë më vete për tekstin, ndaj një draft i ruajtur vetëm me `text` kthehet këtu.
fromstring or null- Adresa me të cilën u ruajt drafti, e raportuar vetëm sa kohë që hapësira e punës mund të dërgojë ende në emër të saj. Është null për një draft të ruajtur pa dërgues ose nga një adresë që është hequr që atëherë.
threadIdstring or null- Thread-i të cilit i përgjigjet drafti, ose null për një draft që nis një bisedë të re.
attachmentsarray- Çdo element ka vetëm `filename` dhe `contentType`, sepse bashkëngjitjet e drafteve ruhen si emra dhe lloje pa përmbajtje. Një `update` e zbraz këtë listë.