API服务

为企业提供底层API服务


查询邮件列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>查询邮件列表</li> </ul> <h5>功能描述</h5> <ul> <li>查询邮件发送列表。</li> <li>其中收件人、发送人、主题和内容为模糊搜索。</li> <li>当查询邮件列表为空时,返回空的集合。</li> </ul> <h5>请求URL</h5> <ul> <li><code>{url}/mail/page/</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET </li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">长度</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">addressee</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">128</td> <td>收件人</td> </tr> <tr> <td style="text-align: left;">sender</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">128</td> <td>发送人</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">512</td> <td>主题</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">1024</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">mode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td style="text-align: left;">1</td> <td>发送模式,1=马上发送,2=指定时间发送</td> </tr> <tr> <td style="text-align: left;">hasSend</td> <td style="text-align: left;">否</td> <td style="text-align: left;">boolean</td> <td style="text-align: left;">是否发送</td> </tr> <tr> <td style="text-align: left;">createStartTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">19</td> <td>邮件创建开始时间(时间格式为:yyyy-MM-dd HH:mm:ss)</td> </tr> <tr> <td style="text-align: left;">createEndTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">19</td> <td>邮件创建结束时间(时间格式为:yyyy-MM-dd HH:mm:ss)</td> </tr> <tr> <td style="text-align: left;">sendtartTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">19</td> <td>邮件发送开始时间(时间格式为:yyyy-MM-dd HH:mm:ss)</td> </tr> <tr> <td style="text-align: left;">sendEndTime</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">19</td> <td>邮件发送结束时间(时间格式为:yyyy-MM-dd HH:mm:ss)</td> </tr> <tr> <td style="text-align: left;">createBy</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">32</td> <td>创建人</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code> { &amp;quot;total&amp;quot;:&amp;quot;100&amp;quot;, &amp;quot;current&amp;quot;:1, &amp;quot;size&amp;quot;:20, &amp;quot;records&amp;quot;:[ { &amp;quot;addressee&amp;quot;:&amp;quot;张三&amp;quot;, &amp;quot;sender&amp;quot;:&amp;quot;李四&amp;quot;, &amp;quot;title&amp;quot;:&amp;quot;新年快乐&amp;quot;, &amp;quot;mode&amp;quot;:&amp;quot;2&amp;quot;, &amp;quot;lazySendTime&amp;quot;:&amp;quot;2024-01-01 00:00:00&amp;quot;, &amp;quot;createTime&amp;quot;:&amp;quot;2024-01-01 00:00:00&amp;quot;, &amp;quot;sendTime&amp;quot;:&amp;quot;2024-01-01 00:00:00&amp;quot;, &amp;quot;hasSend&amp;quot;:true, &amp;quot;createBy&amp;quot;:&amp;quot;张三&amp;quot; } ] }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">addressee</td> <td style="text-align: left;">string</td> <td>收件人</td> </tr> <tr> <td style="text-align: left;">sender</td> <td style="text-align: left;">string</td> <td>发送人</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">string</td> <td>主题</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">string</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">mode</td> <td style="text-align: left;">int</td> <td>发送模式,1=马上发送,2=指定时间发送</td> </tr> <tr> <td style="text-align: left;">lazySendTime</td> <td style="text-align: left;">string</td> <td>当发送模式为“指定时间发送”时必传,时间格式为:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">hasSend</td> <td style="text-align: left;">boolean</td> <td>是否发送成功</td> </tr> <tr> <td style="text-align: left;">createBy</td> <td style="text-align: left;">string</td> <td>创建人</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML