Saltar para a documentação
CLI

openemail follow-ups

Cada comando deste espaço de nomes, com os seus argumentos, opções e exemplos.

Comandos

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.

Cada comando aqui aceita também as opções globais, como --json, --profile e --dry-run. Ver as opções globais

openemail follow-ups list

List reminders

Âmbitosthreads:readRequer início de sessãoAliasesls

Utilização

openemail follow-ups list [flags]

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.

Opções

--status <value>

Only reminders in this state: waiting, answered, due or cancelled.

--thread-id <value>

Only the reminders on this thread.

--limit <n>

How many to return, newest first, from 1 to 200. 100 when left out.

Exemplos

openemail follow-ups list
With optional flags
openemail follow-ups list --status waiting

Também disponível em

API
GET /follow-ups
TypeScript
followUps.list()
Python
follow_ups.list()
Ruby
follow_ups.list
PHP
followUps->list
Go
FollowUps.List
Java
followUps().list
C#
FollowUps.ListAsync

openemail follow-ups set

Set a reminder on a thread

Âmbitosthreads:writeRequer início de sessão

Utilização

openemail follow-ups set --thread-id <value> --remind-at <when> [flags]
openemail follow-ups set --data <json|@file|-> [flags]

Asks to be reminded about a thread if nobody replies by --remind-at. 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. --remind-at 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.

Opções

--thread-id <value>

The thread to be reminded about, as threads.list returns it. Required, here or in --data.

--remind-at <when>

When the thread comes back if nobody replied: a future instant, at most 365 days out. Required, here or in --data.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Exemplos

openemail follow-ups set --thread-id CAHk7pQ2x9LmZ4-mail.example.com --remind-at 2026-10-01T00:00:00Z
Read the whole body from a JSON file
openemail follow-ups set --data @follow-ups.json

Também disponível em

API
POST /follow-ups
TypeScript
followUps.set()
Python
follow_ups.set()
Ruby
follow_ups.set
PHP
followUps->set
Go
FollowUps.Set
Java
followUps().set
C#
FollowUps.SetAsync

openemail follow-ups cancel

Cancel a reminder

Âmbitosthreads:writeRequer início de sessão
Pede-lhe confirmação

Utilização

openemail follow-ups cancel <id> [flags]

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.

Argumentos

<id>Obrigatório

The id of the reminder, fup_ and 24 hex characters, as list returns it.

Exemplos

openemail follow-ups cancel fup_4c1b257a9e3d6f8025b7c1d4
Skip the confirmation, for scripts
openemail follow-ups cancel fup_4c1b257a9e3d6f8025b7c1d4 --yes

Também disponível em

API
DELETE /follow-ups/{id}
TypeScript
followUps.cancel()
Python
follow_ups.cancel()
Ruby
follow_ups.cancel
PHP
followUps->cancel
Go
FollowUps.Cancel
Java
followUps().cancel
C#
FollowUps.CancelAsync