Zur Dokumentation springen
MCP-Server

Gesendet und geplant

Mail, die hinausgegangen ist oder noch darauf wartet.

Tools für Gesendetes und Geplantes

ToolWas es tut
listSentEmailsMail, die der Workspace gesendet hat oder senden wird, neueste zuerst, nach status, Absender, Broadcast oder einem Zeitfenster aus scheduledFrom und scheduledTo.
getSentEmailEine gesendete oder geplante E-Mail: ihr Status, wann sie fällig ist oder hinausging, was schiefging und wie es bei jedem Empfänger um sie steht.
listEmailEventsWas mit einer E-Mail geschehen ist, älteste zuerst: gesendet, fehlgeschlagen, neu geplant und, wenn sie getrackt wurde, jede Öffnung, jeder Klick und jeder Download.
rescheduleEmailEine E-Mail, die noch nicht hinausgegangen ist, auf eine neue Zeit verschieben, einen ISO-8601-Zeitpunkt oder eine Dauer wie PT2H.
updateScheduledEmailBetreff, Inhalt, Absender oder Empfänger einer E-Mail ändern, die noch nicht hinausgegangen ist.
cancelEmailEine E-Mail stoppen, die noch nicht hinausgegangen ist. Sie lässt sich nicht zurückholen, nur erneut senden.

Lesen erfordert „Gesendete Nachrichten und ihren Zustellstatus lesen“ (emails:read), und Verschieben, Ändern oder Abbrechen erfordert „E-Mails senden“ (emails:send). Ein auf einige Adressen beschränkter Client erreicht nur die Mail, die von diesen gesendet wurde, und jemand, dessen Rolle nicht jede Adresse erreicht, darf nur die Mail verschieben, ändern oder abbrechen, die er selbst gesendet hat.

Eine Nachricht, die beim Annehmen übersetzt wurde, behält ihren Wortlaut, und eine verschlüsselte behält ihren Wortlaut und ihre Empfänger, deshalb lehnt updateScheduledEmail es ab, sie zu ändern. Brechen Sie sie stattdessen ab und senden Sie sie erneut.

Im Chat der App fragt cancelEmail immer zuerst nach, und das Verschieben oder Ändern einer E-Mail fragt nach, sofern Sie es nicht selbst verlangt haben.

Referenz

listSentEmails

Geltungsbereicheemails:readDer Assistent in der App führt es ohne Nachfrage ausToolkitsent

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.

Eingaben

statusstring[]
Einer von"queued""scheduled""sending""sent""partial""cancelled""failed"
fromstring
scheduledFromstring
Formatdate-time
scheduledTostring
Formatdate-time
broadcastIdstring
limitinteger
Mindestens 1Höchstens 100
cursorstring

Auch verfügbar über

API
GET /emails
SDK
emails.list()emails.listAll()emails.iterate()

getSentEmail

Geltungsbereicheemails:readDer Assistent in der App führt es ohne Nachfrage ausToolkitsent

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.

Eingaben

idstringErforderlich
Nicht leer

Auch verfügbar über

API
GET /emails/{id}
SDK
emails.get()

listEmailEvents

Geltungsbereicheemails:readDer Assistent in der App führt es ohne Nachfrage ausToolkitsent

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.

Eingaben

idstringErforderlich
Nicht leer
limitinteger
Mindestens 1Höchstens 100
cursorstring

Auch verfügbar über

API
GET /emails/{id}/events
SDK
emails.listEvents()emails.listAllEvents()emails.iterateEvents()

rescheduleEmail

Geltungsbereicheemails:sendDer Assistent in der App fragt zuerst nach, außer Sie haben darum gebetenToolkitsent

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.

Eingaben

idstringErforderlich
Nicht leer
scheduledAtstringErforderlich
Nicht leer

Auch verfügbar über

API
PATCH /emails/{id}
SDK
emails.reschedule()emails.update()

updateScheduledEmail

Geltungsbereicheemails:sendDer Assistent in der App fragt zuerst nach, außer Sie haben darum gebetenToolkitsent

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.

Eingaben

idstringErforderlich
Nicht leer
subjectstring
Bis zu 998 Zeichen
htmlstring
Bis zu 1000000 Zeichen
textstring
Bis zu 1000000 Zeichen
fromstring
toobject[]
1 bis 50 Einträge
emailstringErforderlich
Bis zu 320 ZeichenFormatemail
namestring
Bis zu 128 Zeichen
ccobject[]
Bis zu 50 Einträge
emailstringErforderlich
Bis zu 320 ZeichenFormatemail
namestring
Bis zu 128 Zeichen
bccobject[]
Bis zu 50 Einträge
emailstringErforderlich
Bis zu 320 ZeichenFormatemail
namestring
Bis zu 128 Zeichen

Auch verfügbar über

API
PATCH /emails/{id}
SDK
emails.reschedule()emails.update()

cancelEmail

Geltungsbereicheemails:sendDer Assistent in der App fragt immer zuerst nachToolkitsent

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.

Eingaben

idstringErforderlich
Nicht leer

Auch verfügbar über

API
POST /emails/{id}/cancel
SDK
emails.cancel()