WHM API：emailtrack_search 返回空记录答案

【问题标题】：WHM API: emailtrack_search returns empty recordsWHM API：emailtrack_search 返回空记录
【发布时间】：2017-06-28 21:11:51
【问题描述】：

我正在使用 WHM api 来跟踪邮件传递日志中的电子邮件，但是，使用 emailtrack_search 的 JSON 响应不返回任何记录

我正在调用以下网址

1xx.x.xx.xxx:2087/cpsess####/json-api/emailtrack_search?api.version=1

这是 JSON 响应

{"metadata":{"result":1,"version":1,"command":"emailtrack_search","reason":"OK","overflowed":0,"__chunked":1},"data":{"records":[]}}

请注意，记录是空的，但我在电子邮件传递日志中有消息，我尝试添加一个用户作为参数，但它返回相同。

有人知道如何使用此 API 显示电子邮件发送日志吗？

非常感谢任何帮助

最好的问候。

【问题讨论】：

我可以解决添加参数添加结尾的问题，感谢 cpanel 支持，您需要设置需要获取的电子邮件类型：
1xx.x.xx.xxx:2087/cpsess####/json-api/emailtrack_search?api.version=1&defer=1

标签： json api cpanel whm exim

【解决方案1】：

Daniel，空记录数组也让我发疯。您的发现帮助我更深入地研究了 cPanel 记录不善的 API。为了帮助其他人寻找类似的答案，我在一篇博文中详细介绍了该过程 - Email delivery reports using WHM API and PHP

编辑：这是我的一段代码，它使用 emailtrack_search 从 WHM 的 JSON API 返回结果：

function fetchRecordsByHour($sender, $startTime, $endTime) {
  //Set up variables
  $user = USER;
  $token = TOKEN;
  $hostname = HOSTNAME;

  //Set up query - https://documentation.cpanel.net/display/DD/WHM+API+1+Functions+-+emailtrack_search
  $query = $hostname.'/json-api/emailtrack_search?api.version=1'.
            '&api.filter.enable=1'. //Enable filter (https://documentation.cpanel.net/display/DD/WHM+API+1+-+Filter+Output)
            '&api.filter.a.field=sender&api.filter.a.arg0='.$sender.'&api.filter.a.type=eq'. //Filter records with $sender
            '&api.filter.b.field=sendunixtime&api.filter.b.arg0='.$startTime.'&api.filter.b.type=gt'. //Filter records greater than $startTime
            '&api.filter.c.field=sendunixtime&api.filter.c.arg0='.$endTime.'&api.filter.c.type=lt'. //Filter records less than $endTime
            '&api.sort.enable=1'. //Enable sorting (https://documentation.cpanel.net/display/DD/WHM+API+1+-+Sort+Output)
            '&api.sort.a.field=sendunixtime&api.sort.a.method=numeric&api.sort.a.reverse=0'. //Sort by sent time, not in reverse (By default, the API sorts in reverse order)
            '&success=1'. //Fetch success emails
            '&defer=1'. //Fetch defered emails
            '&failure=1'. //Fetch failed emails
            '&inprogress=1'. //Fetch in progress emails
            '&deliverytype=all'. //Fetch remote and local emails
            '&max_results_by_type=999'; // Fetch a large number of records per batch (Since WHM limits the total at 250 records, anything above 250 is fine)

  //Initialize CURL
  $curl = curl_init();
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
  curl_setopt($curl, CURLOPT_URL, $query);

  //Set authentication parameters
  $header[0] = "Authorization: whm $user:$token";
  curl_setopt($curl, CURLOPT_HTTPHEADER, $header);

  $result = curl_exec($curl);

  //Check for CURL error
  $http_status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  if ($http_status != 200) {
    echo "Error: ".$http_status." returned";
  }

  curl_close($curl);

  //Return only the records, stripping away all the metadata
  return json_decode($result)->data->records;
}

【讨论】：

【解决方案2】：

这个帖子可能会对你有所帮助。您也可以在 cPanel 论坛上提出请求。那里有很多活跃用户：

https://forums.cpanel.net/threads/track-delivery-api.534501/

【讨论】：