SDK
Esborranys
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` i `delete`.
Tots els mètodes
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!)update conserva l'id de l'esborrany, de manera que el valor amb què respon sempre és el que has passat. Un id desconegut és un 404 i no pas un esborrany nou.
list pagina igual que threads.list: el pageToken de l'API torna com a nextCursor i entra com a cursor, i listAll i iterate el segueixen per tu.
Per enviar un esborrany, passa el seu id a emails.send. L'esborrany aporta el contingut i l'enviament aporta el sobre.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Paràmetres: drafts.create i drafts.update (DraftInput)
tostring[]- Les adreces dels destinataris com a cadenes simples, no pas les formes `RecipientInput` que accepta `emails.send`, perquè aquest endpoint uneix l'array en la llista separada per comes que vol el driver. En crear, un array omès es desa com a buit; en actualitzar, un camp omès deixa intactes els destinataris desats, perquè el gestor llegeix primer l'esborrany i fusiona.
ccstring[]- Adreces en Cc, en la mateixa forma de cadena simple que `to`. Buit en crear si s'omet, i intacte en actualitzar si s'omet.
bccstring[]- Adreces en Bcc, en la mateixa forma de cadena simple que `to`. Buit en crear si s'omet, i intacte en actualitzar si s'omet.
subjectstring- L'assumpte de l'esborrany, de com a màxim 998 caràcters, el límit de línia de l'RFC 5322. En crear, per defecte és una cadena buida, de manera que un esborrany en té sempre.
htmlstring- El cos de l'esborrany com a marcatge, de com a màxim 1.000.000 de caràcters. És el cos que guanya: `html` i `text` alimenten l'únic camp de missatge del driver, de manera que enviar-los tots dos desa aquest.
textstring- Un cos de text pla, de com a màxim 1.000.000 de caràcters, que només es fa servir quan no hi ha `html`. L'esborrany desa un sol cos i no pas dues parts, de manera que el text que hi posis torna a `html` quan es llegeix l'esborrany.
fromstring- L'adreça del remitent que s'ha de desar a l'esborrany. En actualitzar, si s'omet es manté la de l'esborrany desat. El driver reconstrueix tot el missatge a partir del que se li dona, de manera que un patch parcial que l'ometés canviaria el remitent triat sense dir res.
threadIdstring- Adjunta l'esborrany a una conversa existent perquè es desi com a resposta. Igual que `from`, en actualitzar es manté si s'omet, perquè reconstruir el missatge sense aquest camp desvincularia la resposta de la seva conversa.
Resposta: DraftResource (drafts.get)
object'draft'- Sempre `draft`.
idstring- L'id de l'esborrany. Les escriptures responen amb un `SavedDraftResource` i no pas amb un esborrany sencer, així que llegeix l'id del resultat en comptes de reutilitzar el que has enviat.
tostring[]- Les adreces dels destinataris tal com les va desar l'esborrany. Un array buit, mai null, quan l'esborrany no en té cap.
ccstring[]- Les adreces en Cc tal com estan desades. Un array buit, mai null, quan l'esborrany no en té cap.
bccstring[]- Les adreces en Bcc tal com estan desades. Un array buit, mai null, quan l'esborrany no en té cap.
subjectstring- L'assumpte desat, o una cadena buida quan l'esborrany no en té. Aquest camp no és mai null, així que comprova'n la longitud i no la presència.
htmlstring- El cos desat, o una cadena buida quan l'esborrany no en té. A la sortida no hi ha cap camp de text separat: un esborrany desat només amb `text` es retorna aquí.