Envoyés et programmés
Le courrier qui est parti ou qui attend de partir.
Outils Envoyés et programmés
| Outil | Ce qu'il fait |
|---|---|
| listSentEmails | Le courrier que l'espace de travail a envoyé ou va envoyer, du plus récent au plus ancien, par status, par expéditeur, par diffusion, ou selon une période scheduledFrom et scheduledTo. |
| getSentEmail | Un e-mail envoyé ou programmé : son statut, quand il doit partir ou quand il est parti, ce qui a mal tourné et où il en est pour chaque destinataire. |
| listEmailEvents | Ce qui est arrivé à un e-mail, du plus ancien au plus récent : envoyé, échoué, reprogrammé et, s'il est suivi, chaque ouverture, chaque clic et chaque téléchargement. |
| rescheduleEmail | Déplacer un e-mail qui n'est pas encore parti à un nouveau moment, un instant ISO 8601 ou une durée comme PT2H. |
| updateScheduledEmail | Modifier l'objet, le corps, l'expéditeur ou les destinataires d'un e-mail qui n'est pas encore parti. |
| cancelEmail | Arrêter un e-mail qui n'est pas encore parti. Il ne peut pas être rétabli, seulement envoyé de nouveau. |
Lire demande « Lire les messages envoyés et leur statut de distribution » (emails:read), et déplacer, modifier ou annuler demande « Envoyer des e-mails » (emails:send). Un client limité à certaines adresses n'atteint que le courrier envoyé depuis celles-ci, et une personne dont le rôle n'atteint pas toutes les adresses ne peut déplacer, modifier ou annuler que le courrier qu'elle a envoyé.
Un message traduit au moment où il a été accepté garde sa formulation, et un message chiffré garde sa formulation et ses destinataires : updateScheduledEmail refuse donc de les modifier. Annulez-le plutôt et envoyez-le de nouveau.
Dans le chat de l'application, cancelEmail demande toujours d'abord, et déplacer ou modifier un e-mail demande, sauf si vous l'avez demandé.
Référence
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.
Entrées
statusstring[]- L'un de
"queued""scheduled""sending""sent""partial""cancelled""failed" fromstringscheduledFromstring- Format
date-time scheduledTostring- Format
date-time broadcastIdstringlimitinteger- Au moins 1Au plus 100
cursorstring
Aussi disponible dans
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.
Entrées
idstringObligatoire- Non vide
Aussi disponible dans
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.
Entrées
idstringObligatoire- Non vide
limitinteger- Au moins 1Au plus 100
cursorstring
Aussi disponible dans
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.
Entrées
idstringObligatoire- Non vide
scheduledAtstringObligatoire- Non vide
Aussi disponible dans
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.
Entrées
idstringObligatoire- Non vide
subjectstring- Jusqu'à 998 caractères
htmlstring- Jusqu'à 1000000 caractères
textstring- Jusqu'à 1000000 caractères
fromstringtoobject[]- De 1 à 50 éléments
emailstringObligatoire- Jusqu'à 320 caractèresFormat
email namestring- Jusqu'à 128 caractères
ccobject[]- Jusqu'à 50 éléments
emailstringObligatoire- Jusqu'à 320 caractèresFormat
email namestring- Jusqu'à 128 caractères
bccobject[]- Jusqu'à 50 éléments
emailstringObligatoire- Jusqu'à 320 caractèresFormat
email namestring- Jusqu'à 128 caractères
Aussi disponible dans
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.
Entrées
idstringObligatoire- Non vide