SDK
Koncepty
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` a `delete`.
Všechny metody
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 zachovává id konceptu, takže hodnota, kterou vrátí, je vždy ta, kterou jste předali. Neznámé id je 404, ne nový koncept.
list stránkuje stejně jako threads.list: pageToken z API se vrací jako nextCursor a posílá se zpět jako cursor; listAll a iterate jej sledují za vás.
Chcete-li koncept odeslat, předejte jeho id do emails.send. Koncept dodá obsah a odeslání dodá obálku.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Parametry: drafts.create a drafts.update (DraftInput)
tostring[]- Adresy příjemců jako prosté řetězce, ne ve tvarech `RecipientInput`, které přijímá `emails.send`, protože tento endpoint pole spojí do čárkami odděleného seznamu, jaký ovladač očekává. Při create se vynechané pole uloží jako prázdné; při update vynechané pole uložené příjemce nechá být, protože handler koncept nejprve načte a sloučí.
ccstring[]- Adresy Cc, ve stejném tvaru prostých řetězců jako `to`. Při create prázdné, když je vynecháte, a při update nedotčené, když je vynecháte.
bccstring[]- Adresy Bcc, ve stejném tvaru prostých řetězců jako `to`. Při create prázdné, když je vynecháte, a při update nedotčené, když je vynecháte.
subjectstring- Předmět konceptu, nejvýše 998 znaků, což je limit řádku podle RFC 5322. Při create je výchozí prázdný řetězec, takže koncept má předmět vždy.
htmlstring- Tělo konceptu jako značkovaný text, nejvýše 1 000 000 znaků. Je to tělo, které vyhrává: `html` i `text` plní jediné pole zprávy v ovladači, takže při zadání obou se uloží tohle.
textstring- Tělo v prostém textu, nejvýše 1 000 000 znaků, použité jen tehdy, když `html` chybí. Koncept ukládá jedno tělo, ne dvě části, takže text zadaný sem se při čtení konceptu vrátí v `html`.
fromstring- Adresa odesílatele, která se má ke konceptu uložit. Při update se při vynechání převezme z uloženého konceptu. Ovladač sestavuje celou zprávu znovu z toho, co dostane, takže částečný patch, který by ji zahodil, by tiše změnil zvoleného odesílatele.
threadIdstring- Připojí koncept k existujícímu vláknu, aby se uložil jako odpověď. Stejně jako `from` se při update při vynechání převezme, protože sestavit zprávu znovu bez něj by odpověď od jejího vlákna odpojilo.
Odpověď: DraftResource (drafts.get)
object'draft'- Vždy `draft`.
idstring- Id konceptu. Zápisy odpovídají objektem `SavedDraftResource`, ne celým konceptem, takže id čtěte z výsledku místo toho, abyste znovu použili to odeslané.
tostring[]- Adresy příjemců tak, jak je koncept uložil. Když žádné nemá, je to prázdné pole, nikdy null.
ccstring[]- Adresy Cc tak, jak byly uloženy. Když žádné nemá, je to prázdné pole, nikdy null.
bccstring[]- Adresy Bcc tak, jak byly uloženy. Když žádné nemá, je to prázdné pole, nikdy null.
subjectstring- Uložený předmět, nebo prázdný řetězec, pokud koncept žádný nemá. Toto pole není nikdy null, takže kontrolujte jeho délku, ne jeho přítomnost.
htmlstring- Uložené tělo, nebo prázdný řetězec, pokud koncept žádné nemá. Na výstupu není samostatné textové pole: koncept uložený pouze s `text` se vrací tady.