所有接口与IMAP同步,需要使用utf8编码来解析json

简要描述:

  • 获取新邮件数据

使用该接口可获取及时邮件数量与未读邮件、新邮件

使用方法:

网站应用可使用ajax来循环获取该接口来判断,建议30秒循环一次。

在post中提供了uidNext参数才会判断是否有新邮件来,因为是跟imap同步的,所以第一次可不提供,不判断新邮件。

newMessage参数详解:
当有新邮件来,该参数才会有数据

"newMessage":
{
    "list":[{  //该参数是一个数组,如果是多个新邮件,就会有多条数据
        "uid":邮件uid,
        "subject":邮件标题,
        "from":发件人邮箱
        "from_name":发件人名称
        "time":发件时间,unix时间戳
    }],
    "topUid":最新的邮件uid,list中有该uid的数据

}

请求URL:

请求方式:

  • POST

请求参数:

参数名 默认 是否必须 类型 说明
email null string 邮箱地址
uidNext 0 int 下一个邮件uid,提供该uid才会判断是否有新的邮件,可从返回的数据参数获取

返回示例:

正确时返回:

{
    "status":1,
    "data":
    {
        "count":返回收件箱总数,包含已读与未读的邮件,
        "unseenCount":返回未读邮件数量
        "uidNext":下一个邮件uid,每次获取都是最新的uid,未录入数据的uid
        "newMessage":新邮件数据,如没新邮件,该参数是空数组
    }
}

错误时返回:

{
    "status":0,
    "msg":"错误说明"
}

简要描述:

  • 获取邮件列表

请求URL:

请求方式:

  • POST

请求参数:

参数名 默认 是否必须 类型 说明
email null string 邮箱地址
offset 0 int 设定第几条数据开始
limit 0 int 设定获取的总条数

返回示例:

正确时返回:

{
    "status":1,
    "data":
    {
        "count":全部邮件总数,
        "unseenCount":未读邮件总数,
        "list":{
            [
             "uid": 邮件id,
             "subject": 邮件标题,
             "from": 发件人邮箱,
             "from_name": 发件人名称,
             "to": [  //收件人邮箱,数组
                 "xxx@xxx.com",
             ],
             "seen": 该邮件是否已读,
             "time": 发件时间,unix时间戳
            ]
        }
    }
}

错误时返回:

{
    "status":0,
    "msg":"错误说明"
}

简要描述:

  • 获取单个邮件的详细数据

请求URL:

请求方式:

  • POST

请求参数:

参数名 默认 是否必须 类型 说明
email null string 邮箱地址
uid 0 int 邮件uid

返回示例:

正确时返回:

{
    "status":1,
    "data":
    {
        "subject":邮件标题,
        "from":发件人邮箱,
        "from_name":发件人名称,发件人如果没填写名称,那么该参数就是空的,
        "to":收件人,这是一个数组,可能包含多个收件人
        "seen":该邮件是否已读,true已读,false未读,
        "content":邮件内容,该参数会有html代码的,可根据情况是否过滤,
        "time":邮件创建时间
    }
}

错误时返回:

{
    "status":0,
    "msg":"错误说明"
}
文档更新时间: 2018-11-08 14:34   作者:ewomail