README

通过Mocean Api集成的Mailchimp

现在免费试用。注册后可获得20个试用短信积分。注册后，可申请更多短信积分，具体取决于MoceanAPI的审核。

安装

要安装库，请在终端运行此命令。

composer require mocean/mailchimp

配置

默认配置列表

'MOCEAN_API_VERSION' => '1',
'MOCEAN_API' => 'rest.moceanapi.com/rest',
'MOCEAN_API_KEY' => '',
'MCOEAN_API_SECRET' => '',
'MOCEAN_API_SENDER_ID' => '', //for mocean-from field (leave empty to use mailchimp list name as sender id)
'MOCEAN_API_TEXT' => 'Testing Text',

'MAILCHIMP_API_VERSION' => '3.0',
'MAILCHIMP_API' => 'api.mailchimp.com',
'MAILCHIMP_API_KEY' => '',
'MAILCHIMP_LISTS_SEARCH_NAME' => '', //search for mailchimp list to be used (leave this empty to use all lists)
'MAILCHIMP_CAMPAIGNS_SEARCH_TITLE' => '', //search for campaign title to be used (leave this empty to use all campaigns)

'ALLOW_DUPLICATE_MEMBER' => false, //set to true if the you wish to send to the same member in different list multiple time

使用方法

如果你使用composer，请确保自动加载器包含在你的项目引导文件中

require_once "vendor/autoload.php";

设置你的配置

$config = array(
    'MOCEAN_API_KEY' => 'xxxx',
    'MCOEAN_API_SECRET' => 'xxxx',
    'MOCEAN_API_TEXT' => 'Testing Text',
    
    'MAILCHIMP_API_KEY' => 'xxxx-xxx',
);

创建一个Mailchimp对象

$mailchimp = new Mocean\Mailchimp\Mailchimp($config);

通过活动广播消息

$totalSmsSent = $mailchimp->campaigns()->lists()->members()->broadcast();
echo "Total SMS Sent: $totalSmsSent";

通过列表广播消息

$totalSmsSent = $mailchimp->lists()->members()->broadcast();
echo "Total SMS Sent: $totalSmsSent";

通过传递自定义文本参数进行广播（默认使用配置中的文本）

broadcast('custom text');

有时你可能不会使用所有活动或列表，这个库提供了一个方便的方法，你可以在配置中设置它

//seperate multiple name by (,)
$config => array(
    'MAILCHIMP_LISTS_SEARCH_NAME' => 'First List,Second List',
    'MAILCHIMP_CAMPAIGNS_SEARCH_TITLE' => 'First Campaign,Second Campaign',
);

如果你希望从Mailchimp获取响应数据，请使用get()

$campaignResponse = $mailchimp->campaigns()->get();
$listResponse = $mailchimp->lists()->get();
$memberResponse = $mailchimp->lists()->members()->get();

动态设置配置（始终覆盖当前配置）

$mailchimp->setConfig($config);

API错误

如果发生任何API错误，你请求的对象将返回false，你可以从API类中获取具体的错误信息

$campaigns = $mailChimp->campaigns();
if($campaigns === false){
    echo Mocean\Mailchimp\api\MailChimpApi::$errMsg;
}

异常

如果没有活动或无法在配置中搜索到活动，将抛出Mocean\Mailchimp\exceptions\CampaignNotFoundException异常

如果没有列表或无法在配置中搜索到列表，将抛出Mocean\Mailchimp\exceptions\ListNotFoundException异常

如果列表中没有成员，将抛出Mocean\Mailchimp\exceptions\MemberNotFoundException异常

如果有密钥凭证错误，将抛出Mocean\Mailchimp\exceptions\InvalidKeyException异常

如果有配置键名称错误，将抛出Mocean\Mailchimp\exceptions\ConfigKeyNotFoundException异常

示例

在example/example.php文件夹中有使用示例

许可

这个库是在MIT许可证下发布的