API
Get an API keyTry it

Create mailing list for a web hosting package

A new mailing list for one web hosting package - mail to its address goes to every recipient.

WWriteNot idempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_mail_mailinglist_createon https://mcp.manitu.de/mcp
POST
/v1/webhosting/mail/mailinglist/createon https://api.manitu.de
Try it
Changes the account. Agents say what will happen and wait for an explicit yes before calling it.

Annotations as tools/list sends them

readOnlyHint falsedestructiveHint falseidempotentHint falseopenWorldHint false

Description for the model

Creates a mailing list for a web hosting package of the manitu customer account this connection works in, by its site_id from manitu_webhosting_list, at an address of one of the package's domains that is free (check with manitu_webhosting_mail_address_list and manitu_webhosting_mail_mailinglist_list). Mail to it goes to every address in recipient_list (at most 1000), sent as the list itself. Settings not given are the customer panel's defaults: only recipients may write (policy closed), replies go to the list, subject "$SUBJECT", no public subscription, one-click unsubscribe link on. Refused with a conflict when the package allows no more lists (limit_reached) or cannot be changed now (not_configurable). Usable a few minutes later. For newsletters to many people a specialised service is the better choice (consent, GDPR). Tell the customer the address, every recipient and who may write, and ask for an explicit yes first - the recipients get every mail sent to the list.

Arguments

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

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

The address of the mailing list from manitu_webhosting_mail_mailinglist_list, e.g. club@example.de. Never guess one.

min length 2max length 254
statusstring

active; inactive switches it off without deleting it - mail to it is dropped silently (e.g. to stop it at once). Default when created: active.

One of active inactive
descriptionstring | null

The customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
recipient_listarray of string

The recipients' addresses - the whole list, it replaces the one there (to add or remove a few, use manitu_webhosting_mail_mailinglist_recipient_add/_remove). At most 1000; may be empty. Other people's addresses: they get every mail sent to the list.

max items 1000
subjectstring

The subject of the mails sent; $SUBJECT stands for the subject of the mail that came in, e.g. "[Club] $SUBJECT". Default when created: "$SUBJECT".

min length 1max length 100
reply_tostring

Where a reply goes: mail-list - to the list (default); sender - to the sender of the mail; fixed-address - to reply_to_address (required then).

One of mail-list sender fixed-address
reply_to_addressstring | null

With reply_to fixed-address: the address replies go to. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
return_pathstring | null

Where reports about mail that could not be delivered go (Return-Path) - none: they are dropped. Best an address of the package (else SPF checks may fail, e.g. at Gmail); needed for delivery to GMX, WEB.DE and other United Internet addresses. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
message_idstring

new: a new Message-ID for each mail sent (recommended, default); keep: the one of the mail that came in.

One of new keep
headerstring | null

Text put above every mail sent - plain text mails only, not HTML, signed or encrypted ones. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
footerstring | null

Text put below every mail sent - plain text mails only. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
policystring

Who may write to the list: closed - its recipients only (default); public - anybody.

One of closed public
non_member_forward_tostring | null

With policy closed: where mail from others than the recipients goes (e.g. the customer's own address, to send it on by hand) - none: it is dropped. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
public_subscriptionboolean

true: anybody may subscribe and unsubscribe on a web page, with a confirmation by mail (double opt-in) - the answer has the link (subscription_link). false (default): only the customer changes the recipients. Switched off and on again, the link is a new one.

subscription_page_prologstring | null

Text shown on the subscription page - plain text, no HTML; line breaks kept. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
unsubscribe_link_rfc8058boolean

Every mail carries a one-click unsubscribe link (RFC 8058) - large mail providers (e.g. Gmail) require it. Default true; switch off only in exceptional cases.

send_delay_secondsnumber

The delay between two mails sent, in seconds - more only if receiving servers complain. Default 0.5; recipients times delay over 300 seconds: the default applies.

min 0.5max 50

Result structuredContent, checked against the schema

mail_addressstringrequired

The address of the list - mail to it goes to every recipient. Domain in Unicode.

mail_address_asciistringrequired

The same address as the mail servers have it (an internationalized domain as xn--...).

statusstringrequired

active; inactive: mail to it is neither sent on nor refused - it is dropped silently.

One of active inactive
descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

created_atstring | nullrequired
Format date-time
subjectstringrequired

The subject of the mails sent - $SUBJECT stands for the subject of the mail that came in, e.g. "[Club] $SUBJECT".

reply_tostringrequired

Where a reply goes: mail-list - to the list; sender - to the sender of the mail; fixed-address - to reply_to_address.

One of mail-list sender fixed-address
reply_to_addressstring | nullrequired

With reply_to fixed-address: the address replies go to.

return_pathstring | nullrequired

Where reports about mail that could not be delivered go (Return-Path); null: they are dropped.

message_idstringrequired

new: a new Message-ID for each mail sent (recommended); keep: the one of the mail that came in.

One of new keep
headerstring | nullrequired

Text put above every mail sent - plain text mails only.

footerstring | nullrequired

Text put below every mail sent - plain text mails only.

policystringrequired

Who may write to the list: closed - its recipients only; public - anybody.

One of closed public
non_member_forward_tostring | nullrequired

With policy closed: where mail from others than the recipients goes; null: it is dropped.

public_subscriptionbooleanrequired

Anybody may subscribe and unsubscribe on a web page, with a confirmation by mail (double opt-in); false: only the customer changes the recipients.

subscription_page_prologstring | nullrequired

Text shown on the subscription page - plain text, line breaks kept.

subscription_linkstring | nullrequired

The link to the subscription page, to publish - null while public_subscription is off. A new one when subscribing is switched off and on again.

unsubscribe_link_rfc8058booleanrequired

Every mail carries a one-click unsubscribe link (RFC 8058) - large mail providers (e.g. Gmail) require it; switch off only in exceptional cases.

send_delay_secondsnumberrequired

The delay between two mails sent, 0.5 to 50 seconds - more if receiving servers complain about too many mails at once. Recipients times delay over 300 seconds: the default (0.5) applies.

recipient_countintegerrequired

How many recipients the list has, at most 1000.

recipient_listarray of string | nullrequired

The recipients' addresses, sorted - only when asked for (with_recipient_list), else null. Other people's data: show them only to the customer.

Authentication

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

Request body JSON; unknown fields are refused

site_idinteger | stringrequired

The site_id from manitu_webhosting_list - never guess one.

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

The address of the mailing list from manitu_webhosting_mail_mailinglist_list, e.g. club@example.de. Never guess one.

min length 2max length 254
statusstring

active; inactive switches it off without deleting it - mail to it is dropped silently (e.g. to stop it at once). Default when created: active.

One of active inactive
descriptionstring | null

The customer's description, for his own overview. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
recipient_listarray of string

The recipients' addresses - the whole list, it replaces the one there (to add or remove a few, use manitu_webhosting_mail_mailinglist_recipient_add/_remove). At most 1000; may be empty. Other people's addresses: they get every mail sent to the list.

max items 1000
subjectstring

The subject of the mails sent; $SUBJECT stands for the subject of the mail that came in, e.g. "[Club] $SUBJECT". Default when created: "$SUBJECT".

min length 1max length 100
reply_tostring

Where a reply goes: mail-list - to the list (default); sender - to the sender of the mail; fixed-address - to reply_to_address (required then).

One of mail-list sender fixed-address
reply_to_addressstring | null

With reply_to fixed-address: the address replies go to. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
return_pathstring | null

Where reports about mail that could not be delivered go (Return-Path) - none: they are dropped. Best an address of the package (else SPF checks may fail, e.g. at Gmail); needed for delivery to GMX, WEB.DE and other United Internet addresses. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
message_idstring

new: a new Message-ID for each mail sent (recommended, default); keep: the one of the mail that came in.

One of new keep
headerstring | null

Text put above every mail sent - plain text mails only, not HTML, signed or encrypted ones. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
footerstring | null

Text put below every mail sent - plain text mails only. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
policystring

Who may write to the list: closed - its recipients only (default); public - anybody.

One of closed public
non_member_forward_tostring | null

With policy closed: where mail from others than the recipients goes (e.g. the customer's own address, to send it on by hand) - none: it is dropped. Left out: unchanged (set) or none (create); null or empty: none.

max length 254
public_subscriptionboolean

true: anybody may subscribe and unsubscribe on a web page, with a confirmation by mail (double opt-in) - the answer has the link (subscription_link). false (default): only the customer changes the recipients. Switched off and on again, the link is a new one.

subscription_page_prologstring | null

Text shown on the subscription page - plain text, no HTML; line breaks kept. Left out: unchanged (set) or none (create); null or empty: none.

max length 1024
unsubscribe_link_rfc8058boolean

Every mail carries a one-click unsubscribe link (RFC 8058) - large mail providers (e.g. Gmail) require it. Default true; switch off only in exceptional cases.

send_delay_secondsnumber

The delay between two mails sent, in seconds - more only if receiving servers complain. Default 0.5; recipients times delay over 300 seconds: the default applies.

min 0.5max 50

Response in data; the rest of the body as on every call

mail_addressstringrequired

The address of the list - mail to it goes to every recipient. Domain in Unicode.

mail_address_asciistringrequired

The same address as the mail servers have it (an internationalized domain as xn--...).

statusstringrequired

active; inactive: mail to it is neither sent on nor refused - it is dropped silently.

One of active inactive
descriptionstring | nullrequired

What the customer wrote about it (his description), null if nothing - not its name or user name.

created_atstring | nullrequired
Format date-time
subjectstringrequired

The subject of the mails sent - $SUBJECT stands for the subject of the mail that came in, e.g. "[Club] $SUBJECT".

reply_tostringrequired

Where a reply goes: mail-list - to the list; sender - to the sender of the mail; fixed-address - to reply_to_address.

One of mail-list sender fixed-address
reply_to_addressstring | nullrequired

With reply_to fixed-address: the address replies go to.

return_pathstring | nullrequired

Where reports about mail that could not be delivered go (Return-Path); null: they are dropped.

message_idstringrequired

new: a new Message-ID for each mail sent (recommended); keep: the one of the mail that came in.

One of new keep
headerstring | nullrequired

Text put above every mail sent - plain text mails only.

footerstring | nullrequired

Text put below every mail sent - plain text mails only.

policystringrequired

Who may write to the list: closed - its recipients only; public - anybody.

One of closed public
non_member_forward_tostring | nullrequired

With policy closed: where mail from others than the recipients goes; null: it is dropped.

public_subscriptionbooleanrequired

Anybody may subscribe and unsubscribe on a web page, with a confirmation by mail (double opt-in); false: only the customer changes the recipients.

subscription_page_prologstring | nullrequired

Text shown on the subscription page - plain text, line breaks kept.

subscription_linkstring | nullrequired

The link to the subscription page, to publish - null while public_subscription is off. A new one when subscribing is switched off and on again.

unsubscribe_link_rfc8058booleanrequired

Every mail carries a one-click unsubscribe link (RFC 8058) - large mail providers (e.g. Gmail) require it; switch off only in exceptional cases.

send_delay_secondsnumberrequired

The delay between two mails sent, 0.5 to 50 seconds - more if receiving servers complain about too many mails at once. Recipients times delay over 300 seconds: the default (0.5) applies.

recipient_countintegerrequired

How many recipients the list has, at most 1000.

recipient_listarray of string | nullrequired

The recipients' addresses, sorted - only when asked for (with_recipient_list), else null. Other people's data: show them only to the customer.

Statuses

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.