Отправленные и запланированные
Почта, которая ушла или ждёт отправки.
Инструменты отправленных и запланированных
| Инструмент | Что делает |
|---|---|
| listSentEmails | Почта, которую рабочее пространство отправило или отправит, от новых к старым, с отбором по status, отправителю, рассылке или периоду от scheduledFrom до scheduledTo. |
| getSentEmail | Одно отправленное или запланированное письмо: его статус, когда оно должно уйти или когда ушло, что пошло не так и как обстоят дела с каждым получателем. |
| listEmailEvents | Что происходило с одним письмом, от старых событий к новым: отправка, сбой, перенос и, если письмо отслеживается, каждое открытие, клик и скачивание. |
| rescheduleEmail | Перенести письмо, которое ещё не ушло, на новое время: на момент в ISO 8601 или на длительность, например PT2H. |
| updateScheduledEmail | Изменить тему, тело, отправителя или получателей письма, которое ещё не ушло. |
| cancelEmail | Остановить письмо, которое ещё не ушло. Вернуть его нельзя, можно только отправить заново. |
Чтение требует «Read sent messages and their delivery status» (emails:read), а перенос, изменение или отмена требуют «Send email» (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Обязательно- Не пустое