openemail out-of-office
Jeder Befehl in diesem Namespace, mit seinen Argumenten, Flags und Beispielen.
Befehle
The automatic reply an address sends while its owner is away: read the replies saved in the workspace, set one for an address or a catch-all with its dates, subject and message, and remove it.
Jeder Befehl hier nimmt auch die globalen Flags an, etwa --json, --profile und --dry-run. Zu den globalen Flags
openemail out-of-office list
Read out of office replies
lsAufruf
openemail out-of-office list [flags]
Resolves every out of office reply saved in the workspace, by address. With --address the array holds exactly one row, the reply of that address, which reads enabled: false with empty text when none was ever saved.
active says whether the reply is going out right now: it is on, the start has passed and the end has not. An address is one address, such as [email protected], or *@example.com for the catch-all of a domain.
Flags
--address <value>One address, such as
[email protected], or*@example.comfor the catch-all of a domain. Left out, every reply saved in the workspace.
Beispiele
openemail out-of-office listopenemail out-of-office list --address [email protected]Auch verfügbar über
openemail out-of-office set
Set an out of office reply
Aufruf
openemail out-of-office set <address> --message <value> [flags] openemail out-of-office set <address> --data <json|@file|-> [flags]
Saves the out of office reply of one address, or of a catch-all with *@example.com, replacing whatever was saved. While it is active, each person who writes to the address gets the message once for the whole away period, as a reply in the same thread. Mail that would not alert anyone gets no reply: spam, mail a rule filed away, newsletters and other bulk mail, automatic mail, bounces, blocked senders and the workspace's own addresses. With --contacts-only, only people in the contacts, or people the workspace has written to, are answered.
Leave --starts-at out to start now, or to keep the start of a reply that is already on, and --ends-at out or null to keep it on until it is switched off. Both take a Date or an ISO 8601 string with an offset, and the SDK converts a Date with toISOString(). An address with a reply of its own is never answered by the catch-all. Replies count toward the monthly sends, carry no tracking, and still go out on muted threads.
Argumente
<address>ErforderlichOne address, such as
[email protected], or*@example.comfor the catch-all of a domain. A key or an app limited to particular addresses or domains reaches only the addresses it holds, and a catch-all only when it holds the domain whole.
Flags
--message <value>The reply, as plain text, 1 to 10,000 characters once trimmed. Line breaks are kept. Required, here or in
--data.--subject <value>The subject of the reply, at most 255 characters. Left out or empty, the reply answers with
Re:and the subject received.Standard""--enabledWhether the reply is switched on. Left out, true.
falsekeeps the text and pauses the reply.Standardtrue--starts-at <when>When the reply starts. Left out or null, now, or the start it already has while the reply is on.
--ends-at <when>When it stops, later than
--starts-at. Left out or null, it stays on until it is switched off.--contacts-onlyAnswer only contacts and people the workspace has written to. Left out, false.
Standardfalse--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Beispiele
openemail out-of-office set [email protected] --message 'I am away until 4 January and will answer when I am back.'openemail out-of-office set [email protected] --message 'I am away until 4 January and will answer when I am back.' --subject 'Away until 4 January' --contacts-onlyopenemail out-of-office set [email protected] --data @out-of-office.jsonAuch verfügbar über
openemail out-of-office clear
Remove an out of office reply
Aufruf
openemail out-of-office clear <address> [flags]
Removes the saved reply of one address or catch-all, so nothing is answered from it any more. Removing a reply that was never saved changes nothing, which is why the SDK retries this call.
To pause a reply and keep its text, save it with enabled: false through set instead.
Argumente
<address>ErforderlichOne address, such as
[email protected], or*@example.comfor the catch-all of a domain. A key or an app limited to particular addresses or domains reaches only the addresses it holds, and a catch-all only when it holds the domain whole.
Beispiele
openemail out-of-office clear [email protected]openemail out-of-office clear [email protected] --yes