README

一个用于预览myemail.com API的简单客户端。

要求

• PHP 5.6+
• guzzlehttp/guzzle 6.2+

安装

使用Composer进行安装

composer require filippo-toso/composer require filippo-toso/preview-my-email

使用方法

创建客户端

use FilippoToso\PreviewMyEmail\Client as PreviewMyEmail;

$client = new PreviewMyEmail('apikey');

返回可用于邮件设计测试的邮件客户端列表

$clients = $client->retrieveEmailClients();

返回您迄今为止进行的邮件设计测试请求列表。请注意：我们每六个月会清除设计测试。

$previews = $client->getPreviewList();

返回当前邮件设计测试服务器的状态。

$status = $client->systemStatus();

此公共API命令将获取您的邮件内容并对其进行小缩略图屏幕截图。这对于在您的邮件活动旁边显示小缩略图很有用。此API命令将返回一个请求ID。您可以在几分钟内使用GetThumbnail API命令查询此请求ID，以检索您的邮件屏幕截图缩略图的URL。

$contentType = 'TEXT';
$content = 'Hello World!';
$request = $client->newThumbnail($contentType, $content)

此公共API命令将返回生成的缩略图URL。如果尚未准备好，将返回错误。

$thumbnail = $client->getThumbnail($requestId);
$requestId = '20170810092854d834ebfe9af9dcac1eb781e668f295a6';

返回您迄今为止进行的收件箱监控测试列表。

$results = $client->getInboxMonitoringResults();

创建一个新的邮件设计测试请求。请注意：为PreviewMyEmail上的所有电子邮件应用程序创建设计测试可能会延迟API响应至1分钟，因此请确保您的时机正确。

$tag = 'filippo-toso-2';
$code = $client->createEmailAnalyticsCode($tag);

此API命令返回总数，例如打开次数、唯一打开次数、转发次数、打印次数等。

$tag = 'filippo-toso-2';
$statistics = $client->getEmailAnalyticsCounts($tag);

此API命令返回您的标签中检测到的“最常点击”的电子邮件应用程序/客户端。

$tag = 'filippo-toso-2';
$topClients = $client->getEmailAnalyticsTopClients($tag);

此API命令返回您的标签中检测到的顶级地理位置。

$tag = 'filippo-toso-2';
$topLocations = $client->getEmailAnalyticsTopLocations($tag);

此API命令将返回在某个特定时间段内发生的邮件“打开”、“打印”和“转发”活动的列表。返回条目的最大数量为150。如果您希望检索所有记录，您将必须使用时间解析器并使用每个解析时间请求检索150条记录。

$tag = 'filippo-toso-2';
$feed = $client->getEmailAnalyticsFeed($tag);

创建一个新的邮件设计测试请求。请注意：为PreviewMyEmail上的所有电子邮件应用程序创建设计测试可能会延迟API响应至1分钟，因此请确保您的时机正确。

$emailBody = '<h1>Hello World!</h1>';
$emailSubject = 'Hello World!';
$targetEmailApps = [74];
$preview = $client->createPreview($emailBody, $emailSubject, $targetEmailApps);

获取预览任务。

$jobId = 1718271789;
$job = $client->fetchPreview($jobId);

针对目标电子邮件应用程序重新运行邮件设计测试。请注意：您不能在创建设计测试时未包含的目标邮件应用程序上执行此命令。

$jobId = 1718267428;
$clientCode = 74;
$result = $client->retryEmailClient($jobId, $clientCode);