作者:管理员  历史版本:1  最后编辑:龚清  更新时间:2024-05-28 11:17

查询外部邮件用户设置

简述:

  • 查询外部邮件用户设置

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
mailConfigId String 外部邮件用户设置id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/mail/mailConfig/get?mailConfigId=673904900970643456

返回示例:

{
    "state": 200,
    "request": null,
    "message": "获取外部邮件用户设置成功",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "673904900970643456",
        "userId": "654384477392338944",
        "userName": "test1",
        "mailAddress": "tom@qq.com",
        "mailPass": "123",
        "smtpHost": "test1",
        "smtpPort": "25",
        "popHost": "test1",
        "popPort": "110",
        "imapHost": null,
        "imapPort": null,
        "isDefault": true,
        "mailType": "POP3",
        "useSsl": false,
        "isValidate": false,
        "isHanDleAttach": false,
        "isDeleteRemote": false
    }
}

返回参数说明:

名称 类型 备注
data MailConfigPo 外部邮件用户设置对象

查询外部邮件用户设置列表

简述:

  • 查询外部邮件用户设置列表

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
request APIRequest[1] 动态查询请求对象

请求参数示例:

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "查询外部邮件用户设置列表成功",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "673904900970643456",
                "userId": "654384477392338944",
                "userName": "test1",
                "mailAddress": "tom@qq.com",
                "mailPass": "123",
                "smtpHost": "test1",
                "smtpPort": "25",
                "popHost": "test1",
                "popPort": "110",
                "imapHost": null,
                "imapPort": null,
                "isDefault": true,
                "mailType": "POP3",
                "useSsl": false,
                "isValidate": false,
                "isHanDleAttach": false,
                "isDeleteRemote": false
            },
            {
                "pk": "",
                "name": null,
                "ip": null,
                "createBy": null,
                "createTime": null,
                "updateBy": null,
                "updateTime": null,
                "tenantId": null,
                "dataStatus": null,
                "dbtype": null,
                "id": "673904596459978752",
                "userId": "654384477392338944",
                "userName": "test",
                "mailAddress": "tom@qq.cc",
                "mailPass": "123",
                "smtpHost": "test",
                "smtpPort": "25",
                "popHost": "test",
                "popPort": "110",
                "imapHost": null,
                "imapPort": null,
                "isDefault": true,
                "mailType": "POP3",
                "useSsl": false,
                "isValidate": false,
                "isHanDleAttach": false,
                "isDeleteRemote": false
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 2,
            "totalPages": 1
        }
    }
}

返回参数说明:

名称 类型 备注
data APIPageList< MailConfigPo > 外部邮件用户设置对象

删除外部邮件用户设置

简述:

  • 删除外部邮件用户设置

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
mailConfigIds String[] 外部邮件用户设置id数组
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/mail/mailConfig/remove?mailConfigIds=673904900970643456

返回示例:

{
    "state": 200,
    "request": null,
    "message": "删除外部邮件用户设置记录成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data Void

保存外部邮件用户设置

简述:

  • 保存外部邮件用户设置

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:

MailConfigPo 对象信息

名称 类型 是否必须 默认值 备注
id String 主键
userId String 用户ID
userName String 用户名称
mailAddress String 外部邮件地址
mailPass String 外部邮件密码
smtpHost String smtp主机
smtpPort String smtp端口
popHost String pop主机
popPort String pop端口
imapHost String imap主机
imapPort String imap端口
isDefault Boolean true 是否默认
mailType String 接收邮件服务器类型
useSsl Boolean false 是否使用SSL连接服务器
isValidate Boolean false 是否下载附件
isHanDleAttach Boolean false 是否下载附件
isDeleteRemote Boolean false 是否删除远程邮件

请求参数示例:

{
    "id": "",
    "userId": "654384477392338944",
    "userName": "test1",
    "isDefault": true,
    "mailAddress": "tom@qq.com",
    "mailPass": "123",
    "mailType": "POP3",
    "isValidate": false,
    "isHanDleAttach": false,
    "useSsl": false,
    "popHost": "test1",
    "popPort": "110",
    "smtpHost": "test1",
    "smtpPort": "25"
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "保存外部邮件用户设置成功",
    "cause": "",
    "variables": {
        "id": "673904900970643456"
    },
    "data": null
}

返回参数说明:

名称 类型 备注
data Void

测试接收/发送 服务器连接

简述:

  • 测试接收/发送 服务器连接

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:

MailConfigPo 对象信息

名称 类型 是否必须 默认值 备注
id String 主键
userId String 用户ID
userName String 用户名称
mailAddress String 外部邮件地址
mailPass String 外部邮件密码
smtpHost String smtp主机
smtpPort String smtp端口
popHost String pop主机
popPort String pop端口
imapHost String imap主机
imapPort String imap端口
isDefault Boolean true 是否默认
mailType String 接收邮件服务器类型
useSsl Boolean false 是否使用SSL连接服务器
isValidate Boolean false 是否下载附件
isHanDleAttach Boolean false 是否下载附件
isDeleteRemote Boolean false 是否删除远程邮件

请求参数示例:

{
    "id": "",
    "userId": "654384477392338944",
    "userName": "QQ邮箱",
    "isDefault": true,
    "mailAddress": "tomchil@163.com",
    "mailPass": "abcdefgh",
    "mailType": "POP3",
    "isValidate": false,
    "isHanDleAttach": false,
    "useSsl": false,
    "popHost": "pop.163.com",
    "popPort": "110",
    "smtpHost": "smtp.163.com",
    "smtpPort": "25"
}

返回示例:

// TODO 测试连接报错
{
    "state": 50002,
    "request": null,
    "message": "",
    "cause": "服务【ibps-platform-provider】不可用,Number of retries on next server exceeded max 1 retries, while making a call for: 192.168.3.230:15300\n",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data Void