client.follow_ups
Jede Methode in diesem Namespace: ihre Signatur, ihre Parameter, was sie zurückgibt und ein Beispiel.
Methoden
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.
follow_ups.list
List reminders
list(status: nil, thread_id: nil, limit: nil, api_key: nil) -> Array<Hash>Returns 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.
Parameter
statusStringOnly reminders in this state:
waiting,answered,dueorcancelled.OpenEmail::FOLLOW_UP_STATUSESholds the values.thread_idStringOnly the reminders on this thread.
limitIntegerHow many to return, newest first, from 1 to 200. 100 when left out.
api_keyStringOverrides the client's API key for this call only.
Rückgabe
An Array of Hashes, each with object set to follow_up, id, threadId, messageId, emailId, subject, remindAt, status, answeredAt, firedAt and createdAt. threadId is nil until a scheduled message with a reminder goes out, emailId names the email when the reminder was set with followUpAt, answeredAt is nil unless answered and firedAt is nil unless due.
Beispiel
waiting = client.follow_ups.list(status: "waiting") waiting.each { |reminder| puts "#{reminder[:subject]} #{reminder[:remindAt]}" }Hinweise
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.
Auch verfügbar über
follow_ups.set
Set a reminder on a thread
set(body = nil, api_key: nil, **fields) -> HashAsks 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 Time, a DateTime or an ISO 8601 string with an offset, and the SDK sends a Time or a DateTime as a UTC ISO 8601 instant. Only threadId and remindAt are sent, and any other field is left out of the request. To set one as you send, pass followUpAt to emails.send instead.
Parameter
threadIdStringErforderlichThe thread to be reminded about, as
threads.listreturns it.remindAtTime, DateTime or StringErforderlichWhen the thread comes back if nobody replied: a future instant, at most 365 days out.
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash, the reminder with status set to waiting. It has object set to follow_up, id, threadId, messageId, emailId, subject, remindAt, status, answeredAt, firedAt and createdAt.
Beispiel
reminder = client.follow_ups.set( threadId: "CAHk7pQ2x9LmZ4-mail.example.com", remindAt: Time.now + (3 * 86_400)) puts reminder[:id], reminder[:status], reminder[:remindAt]Hinweise
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 withsettings.update.The SDK retries this call after a network failure, which is safe because setting the same time twice leaves one reminder.
Auch verfügbar über
- API
POST /follow-ups- TypeScript
followUps.set()- Python
follow_ups.set()- PHP
followUps->set- Go
FollowUps.Set- Java
followUps().set- C#
FollowUps.SetAsync- CLI
openemail follow-ups set
follow_ups.cancel
Cancel a reminder
cancel(id, api_key: nil) -> HashCancels 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.
Parameter
idStringErforderlichThe id of the reminder,
fup_and 24 hex characters, aslistreturns it.api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash, the reminder as it is now: status is cancelled when it was waiting, and unchanged when it had already ended.
Beispiel
cancelled = client.follow_ups.cancel("fup_4c1b257a9e3d6f8025b7c1d4") puts cancelled[:status], cancelled[:remindAt]Hinweise
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.