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.
manitu_webhosting_mail_address_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
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).
Arguments
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
mail_addressstringrequiredThe 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.
Result structuredContent, checked against the schema
mail_addressstringrequiredThe 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_asciistringrequiredThe same address as the mail servers have it (internationalized domains in ASCII, xn--).
typestring | nullrequiredWhat 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.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
target_listarray of string | nullrequiredWhere 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 | nullrequiredOther addresses whose mail ends up here (mailbox and forward only, else null) - they are not addresses of their own.
greylistingboolean | nullrequiredGreylisting against spam: mail from an unknown sender is accepted only on its second try, minutes later. Mailbox and forward only, else null.
created_atstring | nullrequiredWhen it was created.
mailboxobject | nullrequiredThe mailbox - type mailbox only, else null.
mailbox.quota_mbinteger | nullrequiredDisk space in MB its mail may take; null: no limit of its own (the package's applies).
mailbox.suspendedbooleanrequiredSwitched off by the customer: no login, mail to it is refused - kept for later.
mailbox.alias_login_allowedbooleanrequiredA mail program may log in with an alias as well, not only with mail_address.
mailbox.panel_accessbooleanrequiredWith 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_activebooleanrequiredAn automatic reply (e.g. out of office) is switched on - manitu_webhosting_mail_address_autoreply_get shows it.
mailbox.password_change_recommendedbooleanrequiredThe password is kept in an outdated form - the customer should set a new one.
mailbox.last_login_atstring | nullrequiredIts last login (mail program or webmail), null if never.
mailbox.connectionobjectrequiredmailbox.connection.hoststringrequiredThe server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.
mailbox.connection.usernamestringrequiredThe user name to log in with - the full mail address; the password is the mailbox's.
mailbox.connection.method_listarray of objectrequiredThe 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[].protocolstringrequiredmailbox.connection.method_list[].portintegerrequiredmailbox.connection.method_list[].securitystringrequiredssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").
mailbox.connection.method_list[].is_recommendedbooleanrequiredAuthentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
site_idinteger | stringrequiredThe site_id from manitu_webhosting_list - never guess one.
mail_addressstringrequiredThe 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.
Response in data; the rest of the body as on every call
mail_addressstringrequiredThe 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_asciistringrequiredThe same address as the mail servers have it (internationalized domains in ASCII, xn--).
typestring | nullrequiredWhat 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.
descriptionstring | nullrequiredWhat the customer wrote about it (his description), null if nothing - not its name or user name.
target_listarray of string | nullrequiredWhere 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 | nullrequiredOther addresses whose mail ends up here (mailbox and forward only, else null) - they are not addresses of their own.
greylistingboolean | nullrequiredGreylisting against spam: mail from an unknown sender is accepted only on its second try, minutes later. Mailbox and forward only, else null.
created_atstring | nullrequiredWhen it was created.
mailboxobject | nullrequiredThe mailbox - type mailbox only, else null.
mailbox.quota_mbinteger | nullrequiredDisk space in MB its mail may take; null: no limit of its own (the package's applies).
mailbox.suspendedbooleanrequiredSwitched off by the customer: no login, mail to it is refused - kept for later.
mailbox.alias_login_allowedbooleanrequiredA mail program may log in with an alias as well, not only with mail_address.
mailbox.panel_accessbooleanrequiredWith 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_activebooleanrequiredAn automatic reply (e.g. out of office) is switched on - manitu_webhosting_mail_address_autoreply_get shows it.
mailbox.password_change_recommendedbooleanrequiredThe password is kept in an outdated form - the customer should set a new one.
mailbox.last_login_atstring | nullrequiredIts last login (mail program or webmail), null if never.
mailbox.connectionobjectrequiredmailbox.connection.hoststringrequiredThe server a mail program connects to - for receiving (IMAP, POP3) and sending (SMTP) alike. NOT the MX server of the package.
mailbox.connection.usernamestringrequiredThe user name to log in with - the full mail address; the password is the mailbox's.
mailbox.connection.method_listarray of objectrequiredThe 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[].protocolstringrequiredmailbox.connection.method_list[].portintegerrequiredmailbox.connection.method_list[].securitystringrequiredssl_tls: encrypted from the start (often "SSL/TLS"); starttls: switched to encryption after connecting ("STARTTLS").
mailbox.connection.method_list[].is_recommendedbooleanrequiredStatuses
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.