README

#Addemar 的 PHP API 包装器

完全重写了这些旧代码。现在包含 3 个管理器。

ContactManager
SendingManager
ContactGroupsManager

所有都与此处 Addemar 文档的结构相匹配：https://ws-email.addemar.com/docs/current/

##设置

需要设置才能连接到客户端。在构造函数中，您可以设置您的 Token。其他参数是预定义的，但可以更新。

class Settings
{
	private $token;
	private $version = 1.4;
	private $wsdl = 'https://ws-email.addemar.com/soap/wsdl/';
	private $options = array();
	
	...
}

##连接

连接是标准 SoapClient 的扩展。您不需要了解太多关于这个组件。只需传递您的设置，这将提供一个有效连接。

##管理器

管理器只是特定类别函数的分组名称。每个管理器包含您在 Addemar 文档中能找到的功能。您可以通过调用工厂来加载管理器。

示例

use Addemar\Factory\ManagerFactory;
use Addemar\Client\Connection;
use Addemar\Configuration\Settings;

$connection = new Connection(new Settings('Your Token'));
ManagerFactory::create($connection, 'Addemar\Manager\ContactGroupsManager');

###ContactManager

函数列表

####getStructure()

从联系人获取结构

返回：结构 ContactData

####create($structure)

创建新的联系人

• ContactData $contact_data: 结构: ContactData

返回：整数 (联系人 ID)

####getContactId($status, $filter, $search_field_id = 1)

获取联系人 ID 列表

• integer $status: 0=全部 1=未取消订阅 2=已取消订阅
• string $filter: 要搜索的文本
• integer $search_field_id: 要搜索的字段 ID

返回：整数数组 (联系人 ID)

####getContactData($cid)

通过联系人 ID 获取数据

• integer $cid: 联系人 ID

返回：结构 ContactData

####getFieldIdByName($name)

获取字段 ID 列表

• string $parameter: 要搜索的字段参数

返回：数组 (字段 ID)

####update($contact_data)

更新联系人

• ContactData $contact_data: 结构: ContactData

返回：布尔值 (true=成功, false=失败)

####delete($cid)

通过联系人 ID 移除/删除联系人

• integer $cid: 联系人 ID

返回：布尔值 (true=成功, false=失败)

####subscribeContact($cid, $mgid)

通过联系人 ID 订阅联系人

• integer $cid: 联系人 ID
• integer $mgid: 邮件组 ID

返回：布尔值 (true=成功, false=失败)

###ContactGroupsManager

函数列表

####getMailgroupId($name)

获取邮件组 ID 列表

• string $name: 要搜索的邮件组名称

返回：数组 (邮件组 ID)

###SendingManager

函数列表

####sendTriggeredItem(SendItem $senditem)

发送触发项（存在活动项）

object $senditem: Addemar\Model\SendItem 实例

返回：整数 (eid)