Skip to main content

Retrieves email settings

GET/v2/users/:id_or_email/mailboxSettings

Retrieves the email settings for a specified user or the current user. The $select query parameter can be used to specify which settings to return.

Request​

Path parameters

    id_or_email stringrequired
    • id:
    • email:

Query parameters

    $select string

Response

    forbidReceiveMailFromOutside boolean

    Block emails from external senders (Optional field: returned when the $select=forbidReceiveMailFromOutside query parameter is added to the URL. Use commas to separate multiple fields.)

    forbidSendMailToOutside boolean

    Prohibit external email sending (Optional field: returned after adding the $select=forbidSendMailToOutside query parameter to the URL. Use commas to separate multiple fields).

    forbidAutoForward boolean

    Forbids auto-forwarding (Optional field: returned when the $select=forbidAutoForward query parameter is added to the URL. Use commas to separate multiple fields.)

    attachmentSize number<int32>

    Attachment size limit (MB) (Optional field: returned by adding the $select=attachmentSize query parameter in the URL. For multiple fields, separate them with commas.)

    recipientCount number<int32>

    Recipient count limit. (Optional field: returned when the query parameter $select=recipientCount is added to the URL. Separate multiple fields with commas.)

    forbidSendMail boolean

    Send mail disabled (a value of true indicates the account is blocked) (optional field: returned by adding the $select=forbidSendMail query parameter to the URL; for multiple fields, separate them with commas).

    forbidSendMailToOutsideExceptions string[]

    Prohibits sending emails to external addresses, except for the following addresses or domains. (Optional field: Returned by appending the $select=forbidSendMailToOutsideExceptions query parameter in the URL. To request multiple fields, separate them with commas.)

    forbidSendMailToOutsideExceptionsAlias string[]

    Sending emails to external addresses is prohibited, but no restriction is applied when sending using the following aliases (Optional field: returned when the $select=forbidSendMailToOutsideExceptionsAlias query parameter is added to the URL; separate multiple fields with commas).

    forbidReceiveMailFromOutsideExceptions string[]

    Rejects incoming emails from external addresses, except for the following addresses. (Optional field: Returned by adding the $select=forbidReceiveMailFromOutsideExceptions query parameter in the URL. Use commas to separate multiple fields.)

    forwardingMode enum

    Forwarding settings (Optional field: add the query parameter $select=forwardingMode to the URL to return; use a comma to separate multiple fields).

    • FORBIDDEN: Forwarding prohibited
    • ALLOWED: Forwarding allowed
    • FORBIDOUTBOUND: Internal forwarding allowed, outbound forwarding prohibited

    Possible values: [FORBIDDEN, ALLOWED, FORBIDOUTBOUND]

Errors

401

Access is unauthorized. Please check whether the correct authorization token is passed.

403

No API access permission. Please complete the relevant authorization on the application management page of the domain administrator.