SDK
下書き
`drafts.list`、`listAll`、`iterate`、`get`、`create`、`update`、`delete`。
すべてのメソッド
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 は下書きの id を保持するので、返ってくる値は常に渡したものと同じです。未知の id は新しい下書きではなく 404 になります。
list は threads.list と同じようにページングします。API の pageToken が nextCursor として返り、cursor として渡され、listAll と iterate が代わりにたどります。
下書きを送るには、その id を emails.send に渡します。下書きが内容を供給し、送信がエンベロープを供給します。
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})パラメーター: drafts.create と drafts.update（DraftInput）
tostring[]- 受信者アドレスをプレーンな文字列として指定します。`emails.send` が受け取る `RecipientInput` の形式ではありません。このエンドポイントは配列を、ドライバーが求めるカンマ区切りのリストに連結するからです。作成時に配列を省略すると空として保存されます。更新時に省略すると、ハンドラーが先に下書きを読んでマージするため、保存済みの受信者はそのまま残ります。
ccstring[]- Cc のアドレス。`to` と同じプレーンな文字列形式です。作成時に省略すると空、更新時に省略すると変更されません。
bccstring[]- Bcc のアドレス。`to` と同じプレーンな文字列形式です。作成時に省略すると空、更新時に省略すると変更されません。
subjectstring- 下書きの件名。RFC 5322 の行長制限である最大 998 文字です。作成時は既定で空文字列になるので、下書きには常に件名があります。
htmlstring- マークアップとしての下書き本文、最大 1,000,000 文字。勝つのはこちらの本文です。`html` と `text` はドライバーの単一メッセージフィールドに流れ込むので、両方を送るとこちらが保存されます。
textstring- プレーンテキストの本文、最大 1,000,000 文字。`html` がないときだけ使われます。下書きは 2 つのパートではなく 1 つの本文を保存するので、ここに渡したテキストは、下書きを読むときに `html` として返ります。
fromstring- 下書きに保存する送信者アドレス。更新時に省略すると、保存済みの下書きから引き継がれます。ドライバーは渡されたものからメッセージ全体を組み直すので、これを落とした部分更新は、選ばれた送信者を黙って変えてしまいます。
threadIdstring- 既存のスレッドに下書きを結び付け、返信として保存します。`from` と同様、更新時に省略すると引き継がれます。これなしでメッセージを組み直すと、返信がスレッドから切り離されてしまうからです。
レスポンス: DraftResource（drafts.get）
object'draft'- 常に `draft` です。
idstring- 下書きの id。書き込み系は下書き全体ではなく `SavedDraftResource` を返すので、送った id を使い回すのではなく結果から id を読んでください。
tostring[]- 下書きが保存したままの受信者アドレス。受信者がいない場合は null ではなく空配列です。
ccstring[]- 保存されたままの Cc アドレス。ない場合は null ではなく空配列です。
bccstring[]- 保存されたままの Bcc アドレス。ない場合は null ではなく空配列です。
subjectstring- 保存された件名。下書きに件名がなければ空文字列です。このフィールドが null になることはないので、存在ではなく長さを確認してください。
htmlstring- 保存された本文。下書きに本文がなければ空文字列です。返り側に別個のテキストフィールドはありません。`text` だけで保存された下書きはここに返ります。