SDK
Piszkozatok
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` és `delete`.
Az összes metódus
const page = await openemail.drafts.list({ query: 'invoice', limit: 25 })const draft = await openemail.drafts.get('draft_…') const created = await openemail.drafts.create({ to: ['[email protected]'], cc: [], bcc: [], subject: 'Your September invoice', html: '<p>Draft body.</p>', from: '[email protected]', threadId: 'thread_…',}) const updated = await openemail.drafts.update(created.id!, { subject: 'Revised' })await openemail.drafts.delete(updated.id!)Az update megtartja a piszkozat azonosítóját, így az érték, amellyel válaszol, mindig az, amit átadtál. Az ismeretlen azonosító 404, nem új piszkozat.
A list ugyanúgy lapoz, mint a threads.list: az API pageToken értéke nextCursor néven jön vissza és cursor néven megy be, a listAll és az iterate pedig helyetted követi.
Piszkozat elküldéséhez add át az azonosítóját az emails.send hívásnak. A piszkozat adja a tartalmat, a küldés a borítékot.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Paraméterek: drafts.create és drafts.update (DraftInput)
tostring[]- A címzettek címei sima sztringként, nem azokban a `RecipientInput` formákban, amelyeket az `emails.send` elfogad, mert ez a végpont a tömböt abba a vesszővel elválasztott listába fűzi össze, amelyet a meghajtó vár. Létrehozáskor a kihagyott tömb üresen mentődik; frissítéskor a kihagyott mező érintetlenül hagyja a tárolt címzetteket, mivel a kezelő előbb beolvassa a piszkozatot, és összefésül.
ccstring[]- Másolatot kapó címek, ugyanabban a sima sztringes formában, mint a `to`. Létrehozáskor üres, ha kihagyod, frissítéskor érintetlen, ha kihagyod.
bccstring[]- Titkos másolatot kapó címek, ugyanabban a sima sztringes formában, mint a `to`. Létrehozáskor üres, ha kihagyod, frissítéskor érintetlen, ha kihagyod.
subjectstring- A piszkozat tárgya, legfeljebb 998 karakter, az RFC 5322 sorhossz-korlátja. Létrehozáskor üres sztring az alapértelmezés, így a piszkozatnak mindig van tárgya.
htmlstring- A piszkozat törzse jelölőnyelvként, legfeljebb 1 000 000 karakter. Ez a törzs nyer: a `html` és a `text` a meghajtó egyetlen üzenetmezőjét tölti, tehát ha mindkettőt küldöd, ez tárolódik.
textstring- Egyszerű szöveges törzs, legfeljebb 1 000 000 karakter, amelyet csak akkor használunk, ha nincs `html`. A piszkozat egy törzset tárol, nem kettőt, így az itt megadott szöveg a piszkozat olvasásakor a `html` mezőben jön vissza.
fromstring- A piszkozatra mentendő feladói cím. Frissítéskor, ha kihagyod, a tárolt piszkozatból visszük tovább. A meghajtó a teljes üzenetet abból építi újra, amit kap, így egy olyan részleges módosítás, amely ezt elhagyta, csendben megváltoztatná a választott feladót.
threadIdstring- Csatold a piszkozatot egy meglévő beszélgetéshez, hogy válaszként mentődjön. A `from` mezőhöz hasonlóan frissítéskor ezt is továbbvisszük, ha kihagyod, mert az üzenet enélkül való újraépítése leválasztaná a választ a beszélgetéséről.
Válasz: DraftResource (drafts.get)
object'draft'- Mindig `draft`.
idstring- A piszkozat azonosítója. Az írások teljes piszkozat helyett `SavedDraftResource` értékkel válaszolnak, ezért az azonosítót az eredményből olvasd ki, ne az elküldöttet használd újra.
tostring[]- A címzettek címei úgy, ahogy a piszkozat eltárolta őket. Üres tömb – soha nem null –, ha a piszkozatnak nincs egy sem.
ccstring[]- A másolatot kapó címek tárolt formában. Üres tömb – soha nem null –, ha a piszkozatnak nincs egy sem.
bccstring[]- A titkos másolatot kapó címek tárolt formában. Üres tömb – soha nem null –, ha a piszkozatnak nincs egy sem.
subjectstring- A tárolt tárgy, vagy üres sztring, ha a piszkozatnak nincs. Ez a mező soha nem null, ezért a hosszát ellenőrizd, ne a meglétét.
htmlstring- A tárolt törzs, vagy üres sztring, ha a piszkozatnak nincs. Kifelé nincs külön szövegmező: a csak `text` értékkel mentett piszkozat is itt jön vissza.