获取邮件列表

Get messages list 获取邮件列表

Messages 集合包括所有已发送的邮件，匹配所有指定条件的多封邮件将被返回。指定单一邮件ID可以获取指定邮件的具体信息.

请求数据格式

获取多个邮件

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
tag string 标签. 选填. 如指定, 只有被具有该标签的邮件会被返回.
startDate date 起始日期. 选填. 如指定, 在此日期之前发送的邮件不会被返回. 可以与endDate一起使用指定时间区间。格式：YYYY-MM-DD.
endDate date 与起始日期一致.
type string 仅返回特定的邮件类型. 选填. 有效描述包括:

    • Newsletter
    • Autoresponder
    • Trigger
    • Transactional
    • Confirmation
    • Recurring
    • Test
    • FreeEmailPreview
    • PaidEmailPreview
    • WorkflowMessage

 

示例:
https://api.esv2.com/v2/Api/Messages?apiKey=YOUR_API_KEY_HERE 

https://api.esv2.com/v2/Api/Messages?apiKey=YOUR_API_KEY_HERE&tag=sports 
https://api.esv2.com/v2/Api/Messages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2010-05-20&endDate=2010-05-22
https://api.esv2.com/v2/Api/Messages?apiKey=YOUR_API_KEY_HERE&tag=sports&startDate=2010-05-20&endDate=2010-05-22&type=Recurring

通过邮件ID获取邮件信息

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要验证. 必填.
ID int 邮件ID. 要求作为请求url的一部分之形式应用 (非 GET 参数). 见下例

 

示例:
https://api.esv2.com/v2/Api/Messages/123?apiKey=YOUR_API_KEY_HERE

应答

获取多个邮件

应答数据元素:

元素/属性名称 类型 描述
UserUnknowns array[complex] Message元素组成的数组.


Message子元素:

元素/属性名称 类型 描述
Id int 邮件标识ID.
FromName string 在邮件中设定的发送方名称.
FromEmail string 在邮件中设定的发送方地址.
Subject string 邮件标题.
Type string 邮件类型 (Newsletter, 自动回复邮件 , 触发式邮件 等).
SentDate datetime 选填. 邮件发送日期. 对于发送多次的邮件， (如自动回复) 则为指定时间范畴内该邮件第一次发送的时间.
Tags string 选填. 逗号分割邮件的标签列表.

 

通过邮件ID获取邮件信息


应答数据元素:

元素/属性名称 类型 描述
Id int 邮件标识ID. Subject string Message subject.
FromEmail string 邮件中的“发送方地址:”, 必填.
FromName string 邮件中的“发送方名称:”, 必填.
Subject string 邮件标题.
Type string 邮件类型 (Newsletter, 自动回复邮件 , 触发式邮件 等).
SentDate datetime 邮件发送日期. 对于发送多次的邮件， (如自动回复) 则为指定时间范畴内该邮件第一次发送的时间, 选填.
Tags string 逗号分割邮件的标签列表, 选填.
ThrottlingMethod string 邮件发送方式, 选填.
Throttling int 邮件发送控制阀 (小时).  只有当ThrottlingMethod 被设置为 “Manual” (手动) 时需要填写, 选填.
GoogleAnalyticsTags array[complex] GoogleAnalyticsTag元素组成的数组. (当邮件启用 Google Analytics时填写), 选填.
YandexListId complex Yandex List ID信息. (当邮件启用Yandex插件时填写), 选填.
Channels string 逗号分隔发送通道IP列表 (如果邮件通过非默认通道发送), 选填.
Lists array[complex] List元素组成的数组 (目标收件人列表), 选填.
Segments array[complex] Segment元素组成的数组 (目标收件人细分), 选填.
Status string 只对Newsletter可用, 选填.


GoogleAnalyticsTag子元素

元素/属性名称 类型 描述
Name string 标签名, 例如 “utm_source”.
Value string 标签值.

 

YandexListId子元素
元素/属性名称 类型 描述
Identifier string Yandex标识ID.
Comment string 注释.

 

List子元素: 

 

元素/属性名称 类型 描述
Id int 列表标识ID.
Name string 列表名称.


Segment子元素:

元素/属性名称 类型 描述
Id int 收件人细分标识ID.
Name string 收件人细分名称.

 

合法的Throttling模式值:
ThrottlingMethod 描述
None 不启用任何邮件发送控制阀.
Auto 启用自动邮件发送控制阀.
Manual 手动控制邮件发送控制阀 (见 “Throttling” 元素).

所有可能的邮件状态值: 

状态值
Scheduled
InProgress
Sent
Paused
Draft
Deleted

示例

获取多个邮件

请求:

GET 

https://api.esv2.com/v2/Api/Messages?startDate=2010-05-19&apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3

OK 应答:

HTTP/1.1 200 OK 

Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:56:22 GMT 
Content-Length: 415 
 
 
 <ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
   <Data>
     <Messages>
       <Message>
         <Id>892</Id>
         <FromName>John Smith</FromName>
         <FromEmail>j.smith@domain.com</FromEmail>
         <Subject>test newsletter</Subject>
         <Type>Newsletter</Type>
         <SentDate>2010-05-19T19:35:08</SentDate>
       </Message>
       <Message>
         <Id>893</Id>
         <FromName>Your Favorite Shop</FromName>
         <FromEmail>contact@yfs.com</FromEmail>
         <Subject>test newsletter 2</Subject>
         <Type>Newsletter</Type>
          <SentDate>2010-05-21T14:09:15</SentDate>
         <Tags>test 1</Tags>
       </Message>
     </Messages>
   </Data>
 </ApiResponse>

通过邮件ID获取邮件细节信息

请求：
GET 

https://api.esv2.com/v2/Api/Messages/893?apiKey=test_api_key1 HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
OK 应答:
HTTP/1.1 200 OK 

Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:59:37 GMT 
Content-Length: 369 
 
 
 <ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
   <Data>
     <Id>893</Id>
     <FromName>Your Favorite Shop</FromName>
     <FromEmail>contact@yfs.com</FromEmail>
     <Subject>test newsletter 2</Subject>
     <Type>Newsletter</Type>
     <SentDate>2010-05-21T14:09:15</SentDate>
     <Tags>test 1</Tags>
     <Channels>192.168.10.2, 192.168.10.3</Channels>
     <Status>Sent</Status>
     <Lists>
       <List>
         <Id>2</Id>
         <Name>test list</Name>
       </List>
     </Lists>
    </Data>
 </ApiResponse>
包含Google Analytics tags和Yandex List ID的应答示例：
HTTP/1.1 200 OK 

Cache-Control: private 
Content-Type: text/xml; charset=utf-8 
Content-Encoding: gzip 
Vary: Accept-Encoding 
Server: Microsoft-IIS/7.5 
Set-Cookie: ASP.NET_SessionId=3e0htsjefgfcby55ra5b2045; path=/; HttpOnly 
X-AspNetMvc-Version: 1.0 
X-AspNet-Version: 2.0.50727 
X-Powered-By: ASP.NET 
Date: Mon, 24 May 2010 12:59:37 GMT 
Content-Length: 455 
<ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”>
  <Data>
    <Id>123951</Id>
    <FromName>myFromName</FromName>
    <FromEmail>myfromEmail@domain.com</FromEmail>
    <Subject>Google Analytics tags test</Subject>
    <Type>Newsletter</Type>
    <ThrottlingMethod>Auto</ThrottlingMethod>
    <GoogleAnalyticsTags>
      <GoogleAnalyticsTag>
        <Name>utm_source</Name>
        <Value>testsource</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_medium</Name>
        <Value>Email</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_content</Name>
        <Value>testcontent</Value>
      </GoogleAnalyticsTag>
      <GoogleAnalyticsTag>
        <Name>utm_campaign</Name>
        <Value>testcampaign</Value>
      </GoogleAnalyticsTag>
    </GoogleAnalyticsTags>
    <YandexListId>
      <Identifier>testid</Identifier>
      <Comment>testcomment</Comment>
    </YandexListId>
    <Status>Draft</Status>
  </Data>
</ApiResponse>