پرش به مستندات
سرور MCP

ارسال‌شده و زمان‌بندی‌شده

ایمیلی که رفته یا منتظر رفتن است.

ابزارهای ارسال‌شده و زمان‌بندی‌شده

ابزارچه می‌کند
listSentEmailsایمیلی که فضای کاری فرستاده یا خواهد فرستاد، تازه‌ترین در ابتدا، بر پایهٔ status، فرستنده، ارسال گروهی، یا بازه‌ای از scheduledFrom و scheduledTo.
getSentEmailیک ایمیل فرستاده‌شده یا زمان‌بندی‌شده: وضعیتش، موعدش یا زمانی که رفت، چه مشکلی پیش آمد و وضعش نزد هر گیرنده.
listEmailEventsآنچه بر سر یک ایمیل آمد، قدیمی‌ترین در ابتدا: فرستاده شد، ناموفق شد، زمان‌بندی‌اش تغییر کرد و، اگر ردیابی شده باشد، هر بازشدن، کلیک و دانلود.
rescheduleEmailایمیلی را که هنوز نرفته به زمانی تازه جابه‌جا کنید، یک لحظهٔ ISO 8601 یا مدتی مانند PT2H.
updateScheduledEmailموضوع، متن، فرستنده یا گیرندگان ایمیلی را که هنوز نرفته تغییر دهید.
cancelEmailایمیلی را که هنوز نرفته متوقف کنید. نمی‌توان آن را برگرداند، فقط می‌شود دوباره فرستادش.

خواندن به «خواندن پیام‌های فرستاده‌شده و وضعیت تحویلشان» (emails:read) نیاز دارد، و جابه‌جا کردن، تغییر یا لغو به «فرستادن ایمیل» (emails:send). کلاینتی که به برخی نشانی‌ها محدود است فقط به ایمیل‌هایی می‌رسد که از همان نشانی‌ها فرستاده شده‌اند، و کسی که نقشش به همهٔ نشانی‌ها نمی‌رسد فقط ایمیل‌هایی را که خودش فرستاده می‌تواند جابه‌جا، تغییر یا لغو کند.

پیامی که هنگام پذیرفته شدن ترجمه شده متنش را نگه می‌دارد، و پیامی که رمزگذاری شده متن و گیرندگانش را نگه می‌دارد، پس updateScheduledEmail تغییر آن‌ها را نمی‌پذیرد. به‌جای آن، لغوش کنید و دوباره بفرستید.

در گفت‌وگوی برنامه، cancelEmail همیشه اول می‌پرسد، و جابه‌جا کردن یا تغییر دادن یک ایمیل می‌پرسد مگر آنکه خودتان خواسته باشید.

مرجع

listSentEmails

محدوده‌های دسترسیemails:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارsent

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"
fromstring
scheduledFromstring
قالبdate-time
scheduledTostring
قالبdate-time
broadcastIdstring
limitinteger
دست‌کم 1حداکثر 100
cursorstring

همچنین در دسترس در

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

getSentEmail

محدوده‌های دسترسیemails:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارsent

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الزامی
خالی نباشد

همچنین در دسترس در

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

listEmailEvents

محدوده‌های دسترسیemails:readدستیار برنامه آن را بدون پرسیدن اجرا می‌کندجعبه‌ابزارsent

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

همچنین در دسترس در

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

rescheduleEmail

محدوده‌های دسترسیemails:sendدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارsent

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الزامی
خالی نباشد

همچنین در دسترس در

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

updateScheduledEmail

محدوده‌های دسترسیemails:sendدستیار برنامه اول می‌پرسد، مگر آنکه خودتان آن را خواسته باشیدجعبه‌ابزارsent

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 نویسه
fromstring
toobject[]
1 تا 50 مورد
emailstringالزامی
تا 320 نویسهقالبemail
namestring
تا 128 نویسه
ccobject[]
تا 50 مورد
emailstringالزامی
تا 320 نویسهقالبemail
namestring
تا 128 نویسه
bccobject[]
تا 50 مورد
emailstringالزامی
تا 320 نویسهقالبemail
namestring
تا 128 نویسه

همچنین در دسترس در

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

cancelEmail

محدوده‌های دسترسیemails:sendدستیار برنامه همیشه اول می‌پرسدجعبه‌ابزارsent

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الزامی
خالی نباشد

همچنین در دسترس در

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