Set automatic reply of a mailbox

Switch the automatic reply (out of office) of one mailbox on or off, with period and text.

WWriteIdempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_mail_address_autoreply_seton https://mcp.manitu.de/mcp
POST
/v1/webhosting/mail/address/autoreply/seton https://api.manitu.de
Try it
Changes the account. Agents say what will happen and wait for an explicit yes before calling it.
readOnlyHint falsedestructiveHint falseidempotentHint trueopenWorldHint false

Sets the automatic reply (out of office, vacation notice) of a mailbox of a web hosting package of the manitu customer account this connection works in, by site_id and mail_address from manitu_webhosting_mail_address_list. Only the fields given change. active switches it on or off; from_date/to_date (YYYY-MM-DD) and from_time/to_time (HH:MM) in Europe/Berlin limit it to a period - null leaves that end open; times without any date are a window every day (both times, e.g. 18:00 to 08:00). Switched on, it needs subject and message, and sender_name and sender_address together or neither. Placeholders: $SUBJECT (the subject of the mail answered), $PERIOD_FROM_DATE (the first day of the period (date only)), $PERIOD_TO_DATE (the last day of the period (date only)). Each sender gets the reply at most once within 24 hours (not per calendar day); this cannot be changed. Read it first with manitu_webhosting_mail_address_autoreply_get. Every sender gets the text: show the customer subject, text and period and ask for an explicit yes first. Refused with a conflict for an address that is no mailbox (not_a_mailbox) or when the package cannot be changed now (not_configurable).

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

pattern ^[1-9][0-9]*$min 1
mail_addressstringrequired

The mail address from manitu_webhosting_mail_address_list, e.g. info@example.de - a catch-all is written "@" and its domain, e.g. @example.de. Never guess one.

min length 2max length 254
activeboolean

true: on (within the period, if one is set); false: off.

from_datestring | null

First day it answers (YYYY-MM-DD); null: from now on.

pattern ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
from_timestring | null

With from_date: the time it starts on that day (HH:MM); null: the start of the day. Without any date: the daily start of a window, with to_time.

pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
to_datestring | null

Last day it answers (YYYY-MM-DD); null: until switched off.

pattern ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
to_timestring | null

With to_date: the time it ends on that day (HH:MM); null: the end of the day. Without any date: the daily end of the window - over midnight is fine, not the same as from_time.

pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
sender_namestring | null

The name the reply is sent with, 2 to 32 characters, printable ASCII only (no umlauts). Together with sender_address. Left out: unchanged (set) or none (create); null or empty: none.

max length 32
sender_addressstring | null

The address the reply is sent from - the mailbox's or one of its aliases; none: the address the answered mail was sent to. Together with sender_name. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
subjectstring

Subject of the reply, e.g. "Auto: $SUBJECT". Required to switch it on.

max length 100
messagestring

The text of the reply, plain text. Required to switch it on.

max length 2000
mail_addressstringrequired

The mailbox it belongs to.

activebooleanrequired

Switched on - within the period, if one is set.

from_datestring | nullrequired

First day it answers (YYYY-MM-DD, Europe/Berlin); null: from now on.

from_timestring | nullrequired

With from_date: the time it starts on that day (HH:MM). Without any date: the daily start of a window that repeats every day (e.g. 18:00 to 08:00 - over midnight is fine).

to_datestring | nullrequired

Last day it answers (YYYY-MM-DD, Europe/Berlin); null: until switched off.

to_timestring | nullrequired

With to_date: the time it ends on that day (HH:MM). Without any date: the daily end of the window.

sender_namestring | nullrequired

The name the reply is sent with; set together with sender_address.

sender_addressstring | nullrequired

The address the reply is sent from - the mailbox's or one of its aliases; null: the address the answered mail was sent to.

subjectstring | nullrequired

Subject of the reply. Placeholders: $SUBJECT (the subject of the mail answered), $PERIOD_FROM_DATE (the first day of the period (date only)), $PERIOD_TO_DATE (the last day of the period (date only)).

messagestring | nullrequired

The text of the reply, plain text. Placeholders: $SUBJECT (the subject of the mail answered), $PERIOD_FROM_DATE (the first day of the period (date only)), $PERIOD_TO_DATE (the last day of the period (date only)). Each sender gets the reply at most once within 24 hours (not per calendar day); this cannot be changed.

One of X-API-Key, Authorization: Bearer … - never more than one in a request. More

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

pattern ^[1-9][0-9]*$min 1
mail_addressstringrequired

The mail address from manitu_webhosting_mail_address_list, e.g. info@example.de - a catch-all is written "@" and its domain, e.g. @example.de. Never guess one.

min length 2max length 254
activeboolean

true: on (within the period, if one is set); false: off.

from_datestring | null

First day it answers (YYYY-MM-DD); null: from now on.

pattern ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
from_timestring | null

With from_date: the time it starts on that day (HH:MM); null: the start of the day. Without any date: the daily start of a window, with to_time.

pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
to_datestring | null

Last day it answers (YYYY-MM-DD); null: until switched off.

pattern ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
to_timestring | null

With to_date: the time it ends on that day (HH:MM); null: the end of the day. Without any date: the daily end of the window - over midnight is fine, not the same as from_time.

pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
sender_namestring | null

The name the reply is sent with, 2 to 32 characters, printable ASCII only (no umlauts). Together with sender_address. Left out: unchanged (set) or none (create); null or empty: none.

max length 32
sender_addressstring | null

The address the reply is sent from - the mailbox's or one of its aliases; none: the address the answered mail was sent to. Together with sender_name. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
subjectstring

Subject of the reply, e.g. "Auto: $SUBJECT". Required to switch it on.

max length 100
messagestring

The text of the reply, plain text. Required to switch it on.

max length 2000
mail_addressstringrequired

The mailbox it belongs to.

activebooleanrequired

Switched on - within the period, if one is set.

from_datestring | nullrequired

First day it answers (YYYY-MM-DD, Europe/Berlin); null: from now on.

from_timestring | nullrequired

With from_date: the time it starts on that day (HH:MM). Without any date: the daily start of a window that repeats every day (e.g. 18:00 to 08:00 - over midnight is fine).

to_datestring | nullrequired

Last day it answers (YYYY-MM-DD, Europe/Berlin); null: until switched off.

to_timestring | nullrequired

With to_date: the time it ends on that day (HH:MM). Without any date: the daily end of the window.

sender_namestring | nullrequired

The name the reply is sent with; set together with sender_address.

sender_addressstring | nullrequired

The address the reply is sent from - the mailbox's or one of its aliases; null: the address the answered mail was sent to.

subjectstring | nullrequired

Subject of the reply. Placeholders: $SUBJECT (the subject of the mail answered), $PERIOD_FROM_DATE (the first day of the period (date only)), $PERIOD_TO_DATE (the last day of the period (date only)).

messagestring | nullrequired

The text of the reply, plain text. Placeholders: $SUBJECT (the subject of the mail answered), $PERIOD_FROM_DATE (the first day of the period (date only)), $PERIOD_TO_DATE (the last day of the period (date only)). Each sender gets the reply at most once within 24 hours (not per calendar day); this cannot be changed.

200Success.400The request does not match the declared input schema.401No credential was presented, or it was not recognised.403The credential is not permitted to use this operation.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.