README

mepost-sdk 是一个 PHP 库，旨在简化与 Mepost API 的交互。它提供了方便的方法来高效地发送和管理消息。此 SDK 是希望将 Mepost 消息功能集成到其应用程序中的开发者的理想选择。

功能

• 直接通过 Mepost API 发送电子邮件。
• 安排和管理电子邮件投递。
• 检索有关安排消息的详细信息。
• 取消安排的消息。
• 使用预定义模板发送电子邮件。

安装

要安装 PHP 的 mepost-sdk，您可以使用 Composer。如果您还没有安装 Composer，您可以从 getcomposer.org 下载。

运行以下命令安装 SDK

composer require mepost/mepost-sdk

用法

以下是一个快速示例，帮助您入门

<?php

require 'vendor/autoload.php';

use Mepost\Client\MepostClient;
use Mepost\Config\MepostConfig;

// Initialize the Mepost client
$apiKey = 'your_api_key_here';
$config = new MepostConfig($apiKey);
$client = new MepostClient($config);

// Send an email
$emailData = [
    'from_email' => 'info@example.com',
    'from_name' => 'Example Company',
    'html' => 'This is a test email sent from the Mepost PHP SDK.',
    'subject' => 'Example Subject',
    'to' => [
        ['email' => 'recipient1@example.com'],
        ['email' => 'recipient2@example.com']
    ]
];

$response = $client->sendEmail($emailData);
print_r($response);

API 方法

MepostClient($config)

初始化并返回一个新的 MepostClient 实例。

• 参数
  • $config：包含您的 Mepost API 密钥的配置对象。

公司端点

addDomain(AddDomainRequest $request)

将域名添加到 Mepost 账户。

• 参数
  • $request：包含要添加的域的对象。

getDomainList()

检索与 Mepost 账户关联的域名列表。

• 无参数。

removeDomain(RemoveDomainRequest $request)

从 Mepost 账户中删除域名。

• 参数
  • $request：包含要删除的域的对象。

组端点

listGroups($limit = 10, $page = 1)

检索电子邮件组列表。

• 参数
  • $limit：要返回的最大组数（默认：10）。
  • $page：分页的页码（默认：1）。

createGroup(CreateNewGroupRequest $request)

创建新的电子邮件组。

• 参数
  • $request：包含新组详细信息的对象。

deleteGroup($groupId)

删除电子邮件组。

• 参数
  • $groupId：要删除的组的 ID。

getGroupById($groupId)

检索特定电子邮件组的详细信息。

• 参数
  • $groupId：要检索的组的 ID。

updateGroup($groupId, RenameGroupRequest $request)

更新电子邮件组的名称。

• 参数
  • $groupId：要更新的组的 ID。
  • $request：包含新组名称的对象。

订阅者端点

listSubscribers($groupId, $limit = 10, $page = 1)

检索组中的订阅者列表。

• 参数
  • $groupId：组的 ID。
  • $limit：要返回的最大订阅者数（默认：10）。
  • $page：分页的页码（默认：1）。

addSubscriber($groupId, CreateSubscriberRequest $request)

将订阅者添加到组中。

• 参数
  • $groupId：组的 ID。
  • $request：包含订阅者详细信息的对象。

deleteSubscriber($groupId, DeleteSubscriberRequest $request)

从组中删除订阅者。

• 参数
  • $groupId：组的 ID。
  • $request：包含要删除的订阅者电子邮件的对象。

getSubscriberByEmail($groupId, $email)

通过电子邮件检索订阅者详细信息。

• 参数
  • $groupId：组的 ID。
  • $email：订阅者的电子邮件地址。

消息端点

getMessageInfo($scheduleId, $email)

检索特定安排消息的详细信息。

• 参数
  • $scheduleId：安排消息的 ID。
  • $email：消息发送的电子邮件地址。

cancelScheduledMessage(CancelScheduledMessageRequest $request)

取消安排的消息。

• 参数
  • $request：包含安排消息 ID 的对象。

sendMarketing(SendMarketingRequest $request)

发送营销电子邮件。

• 参数
  • $request：用于发送营销电子邮件的对象。

sendMessageByTemplate(SendMessageByTemplateRequest $request)

使用模板发送电子邮件。

• 参数
  • $request：包含消息详情和模板ID的对象。

getScheduleInfo($scheduleId)

检索特定计划消息的计划信息。

• 参数
  • $scheduleId：安排消息的 ID。

sendTransactional(SendTransactionalRequest $request)

发送交易电子邮件。

• 参数
  • $request：用于发送交易电子邮件的对象。

sendTransactionalByTemplate(SendMessageByTemplateRequest $request)

使用模板发送交易电子邮件。

• 参数
  • $request：包含消息详情和模板ID的对象。

出站IP端点

createIpGroup(CreateIpGroupRequest $request)

创建新的IP组。

• 参数
  • $request：包含IP组详情的对象。

getIpGroupInfo($name)

检索特定IP组的信息。

• 参数
  • $name：IP组的名称。

listIpGroups()

检索所有IP组的列表。

• 无参数。

cancelWarmup(CancelWarmUpRequest $request)

取消IP地址的预热过程。

• 参数
  • $request：包含IP地址的对象。

getIpInfo($ip)

检索特定IP地址的信息。

• 参数
  • $ip：要检索的IP地址。

listIps()

检索所有IP地址的列表。

• 无参数。

setIpGroup(SetIpGroupRequest $request)

将IP地址分配给特定IP组。

• 参数
  • $request：包含IP地址和组详情的对象。

startWarmup(StartWarmUpRequest $request)

为IP地址启动预热过程。

• 参数
  • $request：包含IP地址的对象。

贡献

欢迎贡献！请阅读贡献指南以了解如何为此项目做出贡献。

许可

mepost-sdk遵循MIT许可发布。有关详细信息，请参阅LICENSE文件。