送信済みと予約済み
送信済みのメールと、送信を待っているメール。
送信済みと予約済みのツール
| ツール | 機能 |
|---|---|
| listSentEmails | ワークスペースが送信した、または送信するメールを、status、送信者、一斉配信、または scheduledFrom と scheduledTo の期間で絞り込み、新しい順に返す。 |
| getSentEmail | 送信済みまたは予約済みのメール 1 通: ステータス、送信予定の時刻か送信された時刻、何がうまくいかなかったか、受信者ごとの状況。 |
| listEmailEvents | 1 通のメールに起きたことを古い順に返す: 送信、失敗、予約変更、そしてトラッキングされている場合はすべての開封、クリック、ダウンロード。 |
| rescheduleEmail | まだ送信されていないメールを新しい時刻、つまり ISO 8601 の日時か PT2H のような期間に移す。 |
| updateScheduledEmail | まだ送信されていないメールの件名、本文、送信者、受信者を変更する。 |
| cancelEmail | まだ送信されていないメールを止める。元に戻すことはできず、送り直すしかない。 |
読み取りには「送信済みメッセージと配信状況を読み取る」(emails:read)、送信日時の変更、内容の変更、キャンセルには「メールを送信する」(emails:send)が必要である。一部のアドレスに限定されたクライアントが届くのは、それらのアドレスから送信されたメールだけで、ロールがすべてのアドレスに及ばない人は、自分が送信したメールについてしか送信日時の変更、内容の変更、キャンセルができない。
受け付けた時点で翻訳されたメッセージは文面をそのまま保ち、暗号化されたメッセージは文面と受信者をそのまま保つので、updateScheduledEmail はそれらの変更を拒否する。代わりにキャンセルして、もう一度送信すること。
アプリのチャットでは、cancelEmail は必ず先に確認し、メールの送信日時や内容の変更は、依頼された場合を除いて確認する。
リファレンス
listSentEmails
Mail this workspace has sent or will send, newest first: messages sent through the app, the API and automations, with their status. status keeps some statuses: queued and scheduled are still waiting, sending, sent, partial, failed and cancelled are not. scheduledFrom and scheduledTo, ISO 8601 instants, keep the messages scheduled inside that window, which with status scheduled and queued is what is waiting to go out. When more follow, the last line gives a cursor.
入力
statusstring[]- 次のいずれか
"queued""scheduled""sending""sent""partial""cancelled""failed" fromstringscheduledFromstring- 形式
date-time scheduledTostring- 形式
date-time broadcastIdstringlimitinteger- 1以上100以下
cursorstring
ほかの提供先
getSentEmail
One sent or scheduled email by id: its status, when it is due or went out, what went wrong if anything did, and where it stands with each recipient. Take the id from listSentEmails or from what sendEmail returned.
入力
idstring必須- 空でないこと
ほかの提供先
listEmailEvents
What happened to one sent email, oldest first: accepted, queued, scheduled, sent, failed, cancelled, rescheduled and, when it was tracked, every counted open, click and download. When more follow, the last line gives a cursor.
入力
idstring必須- 空でないこと
limitinteger- 1以上100以下
cursorstring
ほかの提供先
rescheduleEmail
Move a scheduled or queued email to a new time. scheduledAt is an ISO 8601 instant or a duration such as PT2H, in the future and at most a year out. getCurrentDate gives the time now.
入力
idstring必須- 空でないこと
scheduledAtstring必須- 空でないこと
ほかの提供先
updateScheduledEmail
Change an email that has not gone yet: its subject, its body as html or text, the address it goes out as, or who it goes to. A recipient list replaces the stored one whole. A field you leave out keeps its value. A message translated when it was accepted keeps its wording, and one that was encrypted keeps its wording and its recipients, so cancel it and send again instead.
入力
idstring必須- 空でないこと
subjectstring- 998文字まで
htmlstring- 1000000文字まで
textstring- 1000000文字まで
fromstringtoobject[]- 1〜50件
emailstring必須- 320文字まで形式
email namestring- 128文字まで
ccobject[]- 50件まで
emailstring必須- 320文字まで形式
email namestring- 128文字まで
bccobject[]- 50件まで
emailstring必須- 320文字まで形式
email namestring- 128文字まで
ほかの提供先
cancelEmail
Stop an email that has not gone yet: a scheduled one, or one still inside its undo window. It cannot be brought back afterwards, only sent again. One that has already gone cannot be cancelled. Cancelling twice is not an error.
入力
idstring必須- 空でないこと