openemail.followUps
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
Reminders on mail you sent: ask for a thread to come back to the top of the inbox if nobody replies by a time you choose, list the reminders still waiting and the ones that ended, and cancel one.
followUps.list()
List reminders
list(options?: FollowUpListOptions): Promise<Array<FollowUpResource>>Resolves the reminders you set on mail you sent, newest first: the ones still waiting for a reply and the ones that ended. A reminder is waiting until somebody replies (answered), its time comes with no reply (due, and the thread is back at the top of the inbox, unread) or it is cancelled.
An API key lists the reminders of the workspace owner, and an app those of the person who connected it. A key or an app limited to particular addresses lists only reminders on threads delivered to them. They come back as one plain array with no paging, and limit caps how many.
Parameters
options.statusFollowUpStatusOnly reminders in this state:
waiting,answered,dueorcancelled.options.threadIdstringOnly the reminders on this thread.
options.limitnumberHow many to return, newest first, from 1 to 200. 100 when left out.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Array<FollowUpResource>, each { object: 'follow_up', id, threadId, messageId, emailId, subject, remindAt, status, answeredAt, firedAt, createdAt }. threadId is null until a scheduled message with a reminder goes out, emailId names the email when the reminder was set with followUpAt, answeredAt is null unless answered and firedAt is null unless due.
Example
const waiting = await openemail.followUps.list({ status: 'waiting' }) for (const reminder of waiting) console.log(reminder.subject, reminder.remindAt)Notes
In
query,is:waitingfinds the same conversations throughthreads.list: the ones with a reminder nobody has answered yet.Read only, so the SDK retries it after a network failure like any other read.
Also available in
followUps.set()
Set a reminder on a thread
set(body: FollowUpSet, options?: RequestScope): Promise<FollowUpResource>Asks to be reminded about a thread if nobody replies by remindAt. If a real reply arrives first, the reminder closes by itself. Otherwise, when the time comes, the thread returns to the top of the inbox, unread, with the built-in FOLLOW_UP label and a push to your phones. Automatic replies, delivery reports and your own sending address do not count as a reply.
A thread holds one waiting reminder per person, so setting another moves the time. remindAt takes a Date or an ISO 8601 string with an offset, and the SDK converts a Date with toISOString(). To set one as you send, pass followUpAt to emails.send instead.
Parameters
body.threadIdstringRequiredThe thread to be reminded about, as
threads.listreturns it.body.remindAtDate | stringRequiredWhen the thread comes back if nobody replied: a future instant, at most 365 days out.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
FollowUpResource, the reminder with status set to waiting: { object: 'follow_up', id, threadId, messageId, emailId, subject, remindAt, status, answeredAt, firedAt, createdAt }.
Example
const remindAt = new Date()remindAt.setUTCDate(remindAt.getUTCDate() + 3) const reminder = await openemail.followUps.set({ threadId: 'CAHk7pQ2x9LmZ4-mail.example.com', remindAt}) console.log(reminder.id, reminder.status, reminder.remindAt)Notes
A
remindAtthat is not in the future, or is more than 365 days out, is a 422invalid_follow_up. A thread that does not exist, or one delivered to no address the key covers, is a 404.An API key sets the reminder for the workspace owner, and an app for the person who connected it. The push goes out unless that person turned
phoneFollowUpsoff insettings.The SDK retries this call after a network failure, which is safe because setting the same time twice leaves one reminder.
Also available in
followUps.cancel()
Cancel a reminder
cancel(id: string, options?: RequestScope): Promise<FollowUpResource>Cancels a waiting reminder, so the thread stays where it is when the time comes. A reminder that already ended is returned as it is, which is why the SDK retries this call. Only your own reminders can be cancelled.
Parameters
idstringRequiredThe id of the reminder,
fup_and 24 hex characters, aslistreturns it.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
FollowUpResource, the reminder as it is now: cancelled when it was waiting, and unchanged when it had already ended.
Example
const cancelled = await openemail.followUps.cancel('fup_4c1b257a9e3d6f8025b7c1d4') console.log(cancelled.status, cancelled.remindAt)Notes
An unknown id, and a reminder somebody else set, are each a 404. So is one on a thread delivered to no address the key covers.
A cancelled reminder is kept, and
listreturns it withstatusset tocancelled.