Show mail address of a web hosting package

One mail address of a web hosting package; a mailbox with how to set up a mail program.

RReadIdempotentbetaNeeds service_webhosting
Tool
manitu_webhosting_mail_address_geton https://mcp.manitu.de/mcp
POST
/v1/webhosting/mail/address/geton https://api.manitu.de
Try it
readOnlyHint truedestructiveHint falseidempotentHint trueopenWorldHint false

Returns one mail address 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 (a catch-all as @example.de): its type, targets, aliases, description - and for a mailbox its disk space, whether it is suspended or answers automatically, its last login, and connection: host, user name (the full address) and the protocols with their ports - what the customer enters in his mail program (Outlook, Thunderbird, phone). The password is never shown: it is what the customer chose. An alias is answered with a conflict naming the address it belongs to (mail_address_is_alias, alias_of).

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
mail_addressstringrequired

The address - what the other mail address tools take. A catch-all is "@" and its domain, e.g. @example.de. Internationalized domains in Unicode.

mail_address_asciistringrequired

The same address as the mail servers have it (internationalized domains in ASCII, xn--).

typestring | nullrequired

What happens to its mail: mailbox - kept, to read with a mail program or webmail; forward - sent on to target_list, nothing kept; catchall - every address of its domain not set up otherwise, sent on to target_list; reject - refused, the sender gets an error; delete - accepted and deleted unread, the sender learns nothing. null: a kind no longer used.

One of mailbox forward catchall reject delete null
descriptionstring | nullrequired

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

target_listarray of string | nullrequired

Where its mail goes on to - for a forward and a catch-all where it goes, for a mailbox copies besides the mailbox. An entry "@other.example" (catch-all only) sends to the same name at that domain. null for reject and delete.

alias_listarray of string | nullrequired

Other addresses whose mail ends up here (mailbox and forward only, else null) - they are not addresses of their own.

greylistingboolean | nullrequired

Greylisting against spam: mail from an unknown sender is accepted only on its second try, minutes later. Mailbox and forward only, else null.

created_atstring | nullrequired

When it was created.

Format date-time
mailboxobject | nullrequired

The mailbox - type mailbox only, else null.

mailbox.quota_mbinteger | nullrequired

Disk space in MB its mail may take; null: no limit of its own (the package's applies).

mailbox.suspendedbooleanrequired

Switched off by the customer: no login, mail to it is refused - kept for later.

mailbox.alias_login_allowedbooleanrequired

A mail program may log in with an alias as well, not only with mail_address.

mailbox.panel_accessbooleanrequired

With its address and password one may log in to the customer panel - for this mailbox only (password, autoreply, filters). Changed in the customer panel only.

mailbox.autoreply_activebooleanrequired

An automatic reply (e.g. out of office) is switched on - manitu_webhosting_mail_address_autoreply_get shows it.

mailbox.password_change_recommendedbooleanrequired

The password is kept in an outdated form - the customer should set a new one.

mailbox.last_login_atstring | nullrequired

Its last login (mail program or webmail), null if never.

Format date-time
mailbox.connectionobjectrequired
mailbox.connection.hoststringrequired

The server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.

mailbox.connection.usernamestringrequired

The user name to log in with - the full mail address; the password is the mailbox's.

mailbox.connection.method_listarray of objectrequired

The ways to connect, per protocol the one to prefer first - encrypted only, there is no unencrypted way. Receiving: IMAP (mail stays on the server, several devices) or POP3 (mail is fetched); sending: SMTP with login (the same user name and password) - port 587 with STARTTLS where 465 is blocked.

mailbox.connection.method_list[].protocolstringrequired
One of imap pop3 smtp
mailbox.connection.method_list[].portintegerrequired
mailbox.connection.method_list[].securitystringrequired

ssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").

One of ssl_tls starttls
mailbox.connection.method_list[].is_recommendedbooleanrequired

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
mail_addressstringrequired

The address - what the other mail address tools take. A catch-all is "@" and its domain, e.g. @example.de. Internationalized domains in Unicode.

mail_address_asciistringrequired

The same address as the mail servers have it (internationalized domains in ASCII, xn--).

typestring | nullrequired

What happens to its mail: mailbox - kept, to read with a mail program or webmail; forward - sent on to target_list, nothing kept; catchall - every address of its domain not set up otherwise, sent on to target_list; reject - refused, the sender gets an error; delete - accepted and deleted unread, the sender learns nothing. null: a kind no longer used.

One of mailbox forward catchall reject delete null
descriptionstring | nullrequired

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

target_listarray of string | nullrequired

Where its mail goes on to - for a forward and a catch-all where it goes, for a mailbox copies besides the mailbox. An entry "@other.example" (catch-all only) sends to the same name at that domain. null for reject and delete.

alias_listarray of string | nullrequired

Other addresses whose mail ends up here (mailbox and forward only, else null) - they are not addresses of their own.

greylistingboolean | nullrequired

Greylisting against spam: mail from an unknown sender is accepted only on its second try, minutes later. Mailbox and forward only, else null.

created_atstring | nullrequired

When it was created.

Format date-time
mailboxobject | nullrequired

The mailbox - type mailbox only, else null.

mailbox.quota_mbinteger | nullrequired

Disk space in MB its mail may take; null: no limit of its own (the package's applies).

mailbox.suspendedbooleanrequired

Switched off by the customer: no login, mail to it is refused - kept for later.

mailbox.alias_login_allowedbooleanrequired

A mail program may log in with an alias as well, not only with mail_address.

mailbox.panel_accessbooleanrequired

With its address and password one may log in to the customer panel - for this mailbox only (password, autoreply, filters). Changed in the customer panel only.

mailbox.autoreply_activebooleanrequired

An automatic reply (e.g. out of office) is switched on - manitu_webhosting_mail_address_autoreply_get shows it.

mailbox.password_change_recommendedbooleanrequired

The password is kept in an outdated form - the customer should set a new one.

mailbox.last_login_atstring | nullrequired

Its last login (mail program or webmail), null if never.

Format date-time
mailbox.connectionobjectrequired
mailbox.connection.hoststringrequired

The server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.

mailbox.connection.usernamestringrequired

The user name to log in with - the full mail address; the password is the mailbox's.

mailbox.connection.method_listarray of objectrequired

The ways to connect, per protocol the one to prefer first - encrypted only, there is no unencrypted way. Receiving: IMAP (mail stays on the server, several devices) or POP3 (mail is fetched); sending: SMTP with login (the same user name and password) - port 587 with STARTTLS where 465 is blocked.

mailbox.connection.method_list[].protocolstringrequired
One of imap pop3 smtp
mailbox.connection.method_list[].portintegerrequired
mailbox.connection.method_list[].securitystringrequired

ssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").

One of ssl_tls starttls
mailbox.connection.method_list[].is_recommendedbooleanrequired
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.