SDK
Taslaklar
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` ve `delete`.
Tüm metotlar
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 taslağın id'sini korur; dolayısıyla döndürdüğü değer her zaman geçirdiğiniz id'dir. Bilinmeyen bir id yeni bir taslak değil, 404 verir.
list, threads.list ile aynı şekilde sayfalar: API'nin pageToken değeri nextCursor olarak döner ve cursor olarak girer; listAll ve iterate bunu sizin için izler.
Bir taslağı göndermek için id'sini emails.send çağrısına geçirin. İçeriği taslak, zarfı ise gönderim sağlar.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Parametreler: drafts.create ve drafts.update (DraftInput)
tostring[]- Alıcı adresleri düz dizgeler olarak verilir, `emails.send` çağrısının kabul ettiği `RecipientInput` biçimleri olarak değil; çünkü bu uç nokta diziyi sürücünün istediği virgülle ayrılmış listeye birleştirir. Oluştururken belirtilmeyen bir dizi boş olarak kaydedilir; güncellerken belirtilmeyen bir alan saklanan alıcılara dokunmaz, çünkü işleyici önce taslağı okuyup birleştirir.
ccstring[]- Cc adresleri, `to` ile aynı düz dizge biçiminde. Oluştururken belirtilmezse boş, güncellerken belirtilmezse dokunulmadan kalır.
bccstring[]- Bcc adresleri, `to` ile aynı düz dizge biçiminde. Oluştururken belirtilmezse boş, güncellerken belirtilmezse dokunulmadan kalır.
subjectstring- Taslağın konusu, en fazla 998 karakter; bu RFC 5322 satır sınırıdır. Oluştururken varsayılanı boş dizgedir, dolayısıyla bir taslağın her zaman bir konusu olur.
htmlstring- Taslağın işaretleme biçimindeki gövdesi, en fazla 1.000.000 karakter. Kazanan gövde budur: `html` ve `text`, sürücünün tek mesaj alanını besler; dolayısıyla ikisini birden göndermek bunu saklar.
textstring- Düz metin gövde, en fazla 1.000.000 karakter; yalnızca `html` yokken kullanılır. Taslak iki parça değil tek bir gövde sakladığı için burada verilen metin, taslak okunduğunda `html` alanında geri gelir.
fromstring- Taslağa kaydedilecek gönderen adresi. Güncellerken belirtilmezse saklanan taslaktan aktarılır. Sürücü mesajın tamamını kendisine verilenden yeniden kurar; dolayısıyla bu alanı düşüren kısmi bir yama, seçilen göndereni sessizce değiştirirdi.
threadIdstring- Taslağı var olan bir konuşma dizisine bağlayarak yanıt olarak kaydedin. `from` gibi, güncellerken belirtilmezse aktarılır; çünkü mesajı bu olmadan yeniden kurmak yanıtı dizisinden koparırdı.
Yanıt: DraftResource (drafts.get)
object'draft'- Her zaman `draft`.
idstring- Taslağın id'si. Yazma işlemleri taslağın tamamı yerine bir `SavedDraftResource` döndürür; bu yüzden gönderdiğiniz id'yi yeniden kullanmak yerine id'yi sonuçtan okuyun.
tostring[]- Taslağın sakladığı hâliyle alıcı adresleri. Taslağın hiç alıcısı yoksa null değil, boş dizi.
ccstring[]- Saklanan hâliyle Cc adresleri. Taslakta hiç yoksa null değil, boş dizi.
bccstring[]- Saklanan hâliyle Bcc adresleri. Taslakta hiç yoksa null değil, boş dizi.
subjectstring- Saklanan konu ya da taslakta konu yoksa boş dizge. Bu alan asla null olmaz; bu yüzden varlığını değil uzunluğunu denetleyin.
htmlstring- Saklanan gövde ya da taslakta gövde yoksa boş dizge. Çıkışta ayrı bir metin alanı yoktur: yalnızca `text` ile kaydedilmiş bir taslak burada döndürülür.