跳到主要内容

获取邮箱设置

GET/v2/users/:id_or_email/mailboxSettings

获取指定用户或当前用户的邮箱设置。可通过 $select 查询参数指定需要返回的设置项。

Request​

Path parameters

    id_or_email stringrequired
    • id:
    • email:

Query parameters

    $select string

响应

    forbidReceiveMailFromOutside boolean

    禁止外部收信(可选字段:在URL中增加$select=forbidReceiveMailFromOutside查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidSendMailToOutside boolean

    禁止外部发信(可选字段:在URL中增加$select=forbidSendMailToOutside查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidAutoForward boolean

    禁止自动转发(可选字段:在URL中增加$select=forbidAutoForward查询参数后返回,如需多个字段使用英文逗号分隔)

    attachmentSize number<int32>

    附件大小限制(MB)(可选字段:在URL中增加$select=attachmentSize查询参数后返回,如需多个字段使用英文逗号分隔)

    recipientCount number<int32>

    收件人个数限制(可选字段:在URL中增加$select=recipientCount查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidSendMail boolean

    禁止发信(取值为true对应账号已封禁)(可选字段:在URL中增加$select=forbidSendMail查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidSendMailToOutsideExceptions string[]

    禁止给外部地址发信,但是以下地址例外(email或者域名)(可选字段:在URL中增加$select=forbidSendMailToOutsideExceptions查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidSendMailToOutsideExceptionsAlias string[]

    禁止给外部地址发信,但是用以下别名发送则不限制(可选字段:在URL中增加$select=forbidSendMailToOutsideExceptionsAlias查询参数后返回,如需多个字段使用英文逗号分隔)

    forbidReceiveMailFromOutsideExceptions string[]

    禁止从外部地址收信,但是以下地址例外(可选字段:在URL中增加$select=forbidReceiveMailFromOutsideExceptions查询参数后返回,如需多个字段使用英文逗号分隔)

    forwardingMode enum

    转发设置(可选字段:在URL中增加$select=forwardingMode查询参数后返回,如需多个字段使用英文逗号分隔)

    • FORBIDDEN: 禁止转发
    • ALLOWED: 允许转发
    • FORBIDOUTBOUND: 允许内部转发,但禁止出站转发

    Possible values: [FORBIDDEN, ALLOWED, FORBIDOUTBOUND]

错误

401

访问未授权,请检查是否传递了正确的授权token

403

无API访问权限,请在域管的应用管理页面完成相关授权