Enviados e agendados
Correio que saiu ou que está à espera de sair.
Ferramentas de enviados e agendados
| Ferramenta | O que faz |
|---|---|
| listSentEmails | O correio que o espaço de trabalho enviou ou vai enviar, do mais recente para o mais antigo, por status, remetente, difusão, ou uma janela entre scheduledFrom e scheduledTo. |
| getSentEmail | Um email enviado ou agendado: o seu estado, quando está previsto sair ou quando saiu, o que correu mal e em que ponto está com cada destinatário. |
| listEmailEvents | O que aconteceu a um email, do mais antigo para o mais recente: enviado, falhado, reagendado e, quando é rastreado, cada abertura, clique e transferência. |
| rescheduleEmail | Mover um email que ainda não saiu para uma nova hora, um instante ISO 8601 ou uma duração como PT2H. |
| updateScheduledEmail | Alterar o assunto, o corpo, o remetente ou os destinatários de um email que ainda não saiu. |
| cancelEmail | Parar um email que ainda não saiu. Não pode ser recuperado, só enviado de novo. |
Ler exige «Read sent messages and their delivery status» (emails:read), e mover, alterar ou cancelar exige «Send email» (emails:send). Um cliente limitado a alguns endereços só alcança o correio enviado a partir deles, e alguém cuja função não alcança todos os endereços só pode mover, alterar ou cancelar o correio que enviou.
Uma mensagem traduzida quando foi aceite mantém o seu texto, e uma que foi cifrada mantém o texto e os destinatários, por isso updateScheduledEmail recusa-se a alterá-los. Em vez disso, cancele-a e envie-a de novo.
No chat da aplicação, cancelEmail pergunta sempre primeiro, e mover ou alterar um email pergunta, a menos que o tenha pedido.
Referência
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[]- Um de
"queued""scheduled""sending""sent""partial""cancelled""failed" fromstringscheduledFromstring- Formato
date-time scheduledTostring- Formato
date-time broadcastIdstringlimitinteger- Pelo menos 1No máximo 100
cursorstring
Também disponível em
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
idstringObrigatório- Não vazio
Também disponível em
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
idstringObrigatório- Não vazio
limitinteger- Pelo menos 1No máximo 100
cursorstring
Também disponível em
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
idstringObrigatório- Não vazio
scheduledAtstringObrigatório- Não vazio
Também disponível em
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
idstringObrigatório- Não vazio
subjectstring- Até 998 caracteres
htmlstring- Até 1000000 caracteres
textstring- Até 1000000 caracteres
fromstringtoobject[]- De 1 a 50 itens
emailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
ccobject[]- Até 50 itens
emailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
bccobject[]- Até 50 itens
emailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
Também disponível em
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
idstringObrigatório- Não vazio