Enviados y programados
Correo que ya salió o que espera para salir.
Herramientas de enviados y programados
| Herramienta | Qué hace |
|---|---|
| listSentEmails | El correo que el espacio de trabajo envió o enviará, del más reciente al más antiguo, por status, remitente, envío masivo o un intervalo de scheduledFrom y scheduledTo. |
| getSentEmail | Un correo enviado o programado: su estado, cuándo está previsto o cuándo salió, qué falló y en qué punto está con cada destinatario. |
| listEmailEvents | Lo que le pasó a un correo, del más antiguo al más reciente: enviado, fallido, reprogramado y, cuando tiene seguimiento, cada apertura, clic y descarga. |
| rescheduleEmail | Mueve un correo que todavía no ha salido a una hora nueva, un instante ISO 8601 o una duración como PT2H. |
| updateScheduledEmail | Cambia el asunto, el cuerpo, el remitente o los destinatarios de un correo que todavía no ha salido. |
| cancelEmail | Detiene un correo que todavía no ha salido. No se puede recuperar, solo volver a enviar. |
Leer requiere «Leer los mensajes enviados y su estado de entrega» (emails:read), y mover, cambiar o cancelar requiere «Enviar correo» (emails:send). Un cliente limitado a algunas direcciones solo alcanza el correo enviado desde ellas, y alguien cuyo rol no alcanza todas las direcciones solo puede mover, cambiar o cancelar el correo que envió.
Un mensaje que se tradujo al aceptarse conserva su redacción, y uno que se cifró conserva su redacción y sus destinatarios, así que updateScheduledEmail se niega a cambiarlos. En su lugar, cancélalo y vuelve a enviarlo.
En el chat de la app, cancelEmail siempre pregunta antes, y mover o cambiar un correo pregunta salvo que lo hayas pedido tú.
Referencia
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.
Entradas
statusstring[]- Uno de
"queued""scheduled""sending""sent""partial""cancelled""failed" fromstringscheduledFromstring- Formato
date-time scheduledTostring- Formato
date-time broadcastIdstringlimitinteger- Al menos 1Como máximo 100
cursorstring
También disponible en
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.
Entradas
idstringObligatorio- No vacío
También disponible en
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.
Entradas
idstringObligatorio- No vacío
limitinteger- Al menos 1Como máximo 100
cursorstring
También disponible en
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.
Entradas
idstringObligatorio- No vacío
scheduledAtstringObligatorio- No vacío
También disponible en
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.
Entradas
idstringObligatorio- No vacío
subjectstring- Hasta 998 caracteres
htmlstring- Hasta 1000000 caracteres
textstring- Hasta 1000000 caracteres
fromstringtoobject[]- De 1 a 50 elementos
emailstringObligatorio- Hasta 320 caracteresFormato
email namestring- Hasta 128 caracteres
ccobject[]- Hasta 50 elementos
emailstringObligatorio- Hasta 320 caracteresFormato
email namestring- Hasta 128 caracteres
bccobject[]- Hasta 50 elementos
emailstringObligatorio- Hasta 320 caracteresFormato
email namestring- Hasta 128 caracteres
También disponible en
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.
Entradas
idstringObligatorio- No vacío