Skicat
`drafts.list`, `list_all`, `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")puts page.items.size, draft[:subject] 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ë ngritur si OpenEmail::NotFoundError, dhe jo një draft të ri.
Fushat e një drafti janë argumente me fjalë kyçe me emrat e API-së, ndaj thread-i të cilit i përgjigjet një draft është threadId:. Mund të jepen edhe si një Hash i vetëm. Një draft kthehet si Hash me çelësa Symbol, 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 next_cursor dhe hyn si cursor:, ndërsa list_all dhe iterate e ndjekin për ju. iterate ia jep çdo draft një blloku, ose kthen një Enumerator kur nuk ka bllok. 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 has_more? ë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<String>- Adresat e marrësve si një Array me String-e, jo format Hash që pranon `emails.send`, sepse ky endpoint e bashkon Array-n në listën 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 gem-i nuk e mbështjell një String të vetëm në një Array, ndaj jepni `["[email protected]"]`. Te krijimi, një Array 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<String>- 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<String>- 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- 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 nil 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 nil nuk është e njëjta gjë. Gem-i e dërgon, dhe çdo fushë e refuzon me një 422 invalid_parameter, përveç from te përditësimi, ku nil e pastron dërguesin. Thirrni compact mbi një Hash me vlera opsionale 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<String>- Adresat e marrësve siç i ruajti drafti, të zhveshura, pa emrin e shfaqjes. Një Array bosh, kurrë nil, kur drafti nuk ka asnjë.
ccArray<String>- Adresat Cc siç janë ruajtur. Një Array bosh, kurrë nil, kur drafti nuk ka asnjë.
bccArray<String>- Adresat Bcc siç janë ruajtur. Një Array bosh, kurrë nil, kur drafti nuk ka asnjë.
subjectString- Subjekti i ruajtur, kurrë nil. 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 nil- 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ë nil për një draft të ruajtur pa dërgues ose nga një adresë që është hequr që atëherë.
threadIdString or nil- Thread-i të cilit i përgjigjet drafti, ose nil për një draft që nis një bisedë të re.
attachmentsArray<Hash>- Ç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ë.