README

Maropost API For Laravel

联系服务

以下所有方法均为 公共。根据需要注入 Railroad\Maropost\Services\ContactService 类。

/** @var Railroad\Maropost\Services\ContactService $contactService */
protected $contactService;
public function __constructor(Railroad\Maropost\Services\ContactService $contactService){
    $this->contactService = $contactService;
}

在文件顶部包含命名空间

use Railroad\Maropost\Services\ContactService;

... 以免您需要在每个地方都指定命名空间

/** @var ContactService $contactService */
protected $contactService;
public function __constructor(ContactService $contactService){
    $this->contactService = $contactService;
}

createOrUpdate

创建一个没有列表的联系人。如果传递了已存在的电子邮件，则更新。

使用示例

$content = $this->contactService->createOrUpdate(ContactVO $contact);

参数

响应

update

根据 id 更新没有列表的联系人。当更新电子邮件地址时应使用此方法。

使用示例

$content = $this->contactService->update($contactId, ContactVO $contact);

参数

响应

findOneByEmail

根据电子邮件地址获取联系人

使用示例

$content = $this->contactService->findOneByEmail($email);

参数

响应

findOneById

根据 id 获取联系人

使用示例

$content = $this->contactService->findOneById($id);

参数

响应

addContactToLists

将联系人添加到指定的列表。

使用示例

$content = $this->contactService->addContactToLists($listIds, $contactId);

参数

响应

removeContactFromLists

从指定的列表中删除联系人。

使用示例

$content = $this->contactService->removeContactFromLists($listIds, $contactId);

参数

响应

getListContacts

获取指定列表的联系人列表

使用示例

$content = $this->contactService->getListContacts($listId);

参数

响应

deleteContactByEmail

从所有列表中删除指定的联系人。

使用示例

$content = $this->contactService->deleteContactByEmail($email);

参数

响应

addTagsToContact

向联系人添加标签

使用示例

$content = $this->contactService->addTagsToContact($contactId, $tags);

参数

响应

removeTagsFromContact

从联系人中删除指定的标签

使用示例

$content = $this->contactService->removeTagsFromContact($contactId, $tags);

参数

响应

列表服务

以下所有方法均为 公共。根据需要注入 Railroad\Maropost\Services\ListService 类。

/** @var Railroad\Maropost\Services\ListService $listService */
protected $listService;
public function __constructor(Railroad\Maropost\Services\ListService $listService){
    $this->listService = $listService;
}

在文件顶部包含命名空间

use Railroad\Maropost\Services\ListService;

... 以免您需要在每个地方都指定命名空间

/** @var ListService $listService */
protected $listService;
public function __constructor(ListService $listService){
    $this->listService = $listService;
}

index

获取列表

使用示例

$content = $this->listService->index();

参数

响应

create

创建一个新的列表。

使用示例

$content = $this->listService->create(ListVO $list);

参数

响应

update

修改一个列表。

使用示例

$content = $this->listService->update($id, ListVO $list);

参数

响应

delete

删除一个列表。

使用示例

$content = $this->listService->delete($listId);

参数

响应

Null

show

拉取具有指定 id 的列表。

使用示例

$content = $this->listService->show($listId);

参数

响应

标签服务

以下所有方法均为 公共。根据需要注入 Railroad\Maropost\Services\TagService 类。

/** @var Railroad\Maropost\Services\TagService $tagService */
protected $tagService;
public function __constructor(Railroad\Maropost\Services\TagService $tagService){
    $this->tagService = $tagService;
}

在文件顶部包含命名空间

use Railroad\Maropost\Services\TagService;

... 以免您需要在每个地方都指定命名空间

/** @var TagService $tagService */
protected $tagService;
public function __constructor(TagService $tagService){
    $this->tagService = $tagService;
}

create

创建一个新的标签。

使用示例

$content = $this->tagService->create(TagVO $tag);

参数

响应

findByName

按名称查找标签。

使用示例

$content = $this->tagService->findByName($name);

参数

响应

findById

按 id 查找标签。

使用示例

$content = $this->tagService->findById($tagId);

参数

响应

delete

Delete tag

使用示例

$content = $this->tagService->delete($tagId);

参数

响应

Null