README

SimpleMailChimp 是对常见的 MailChimp 功能的简化包装。

安装

要安装此包，只需使用 composer。

composer require rapidwebltd/simplemailchimp

如果您的框架尚未这样做，您必须将 require_once "vendor/autoload.php" 添加到您希望使用 SimpleMailChimp 的任何文件中。

入门

为了创建一个 SimpleMailChimp 对象，从 SimpleMailChimpFactory 调用 getByAPIKey 函数，并传入您的 API 密钥。

$simpleMailChimp = SimpleMailChimpFactory::getByAPIKey('API_KEY_GOES_HERE');

将用户订阅到列表

要将用户订阅到列表，调用 subscribe 函数，并传入 MailChimp 列表 ID 和用户的电子邮件。

$simpleMailChimp->subscribe('LIST_ID_GOES_HERE', 'example@example.com');

如果成功，将返回包含订阅者数据的数组。

从列表中取消用户订阅

要从列表中取消用户的订阅，调用 unsubscribe 函数，并传入 MailChimp 列表 ID 和用户的电子邮件。

$simpleMailChimp->unsubscribe('LIST_ID_GOES_HERE', 'example@example.com');

如果成功，将返回包含订阅者数据的数组。

获取订阅者的详细信息

要从列表中获取特定订阅者的详细信息，调用 getSubscriberDetails 函数，并传入 MailChimp 列表 ID 和用户的电子邮件。

$simpleMailChimp->getSubscriberDetails('LIST_ID_GOES_HERE', 'example@example.com');

如果成功，将返回包含订阅者数据的数组。

检查订阅者是否已经在列表中订阅

为了查看订阅者是否已经在列表中并已订阅，调用 isSubscribedToList 函数，并传入 MailChimp 列表 ID 和用户的电子邮件。

$simpleMailChimp->isSubscribedToList('LIST_ID_GOES_HERE', 'example@example.com');

此函数将在订阅者被找到且已订阅列表时返回 TRUE，如果用户未在列表中找到或在列表中但设置为未订阅，则返回 FALSE。

获取列表的所有成员

要获取列表的所有成员，调用 getAllUsersInList 函数，并传入 MailChimp 列表 ID 和您想要返回的特定字段的逗号分隔列表。如果没有设置任何参数，则默认检索成员的电子邮件。

$simpleMailChimp->getAllUsersInList('LIST_ID_GOES_HERE');

将返回属于指定列表成员的电子邮件数组。

$simpleMailChimp->getAllUsersInList('LIST_ID_GOES_HERE','email_address,status');

将返回属于指定列表成员的电子邮件和相关的状态数组。可以在 MailChimp API 文档页面（在 'Response body parameters' -> 'members' -> 'Show properties' 下）找到可用参数：http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members。

请注意，此函数返回列表的所有成员，无论他们是否已订阅。