christianezeani/mailchimp

MailChimp API 包装器

1.2.3 2019-08-03 02:51 UTC

This package is auto-updated.

Last update: 2024-09-20 12:53:48 UTC


README

Latest Stable Version Build Status Total Downloads Latest Unstable Version License

Mailchimp PHP 包装器为 MailChimp API 提供基于模型的实现。

安装

该软件包可在 Packagist 上找到,并且可以通过 Composer 进行安装

如果您使用 Composer 来管理依赖项,可以使用

composer require christianezeani/mailchimp

在 Laravel 上使用

对于 Laravel 5.5 及更高版本,服务会自动注册。对于较低版本,请手动在 config/app.php 中注册服务提供者,如下所示

<?php

return [
  ...
  
  "providers" => [
    ...
    MailChimp\Framework\Laravel\MailChimpServiceProvider::class
  ]

  ...
];

将您的 MailChimp API 密钥环境变量添加到项目的 .env 文件中(仅限开发使用)

MAILCHIMP_API_KEY=[Your API Key]

然后您可以将 MailChimp 注入到您的服务和控制器中。

请注意,vendor 文件夹和 vendor/autoload.php 脚本是由 Composer 生成的;它们不是 MailChimp PHP 包装器的一部分。

或者,如果您没有使用 Composer,请手动加载 /path/to/mailchimp/autoload.php 文件。

<?php
require_once '/path/to/mailchimp/autoload.php';

简单示例

<?php
use MailChimp\Config;
use MailChimp\MailChimp;
use MailChimp\Models\Lists\Audience;

$config = new Config('_your_api_key_');
$mailChimp = new MailChimp($config);

$audience = $mailChimp->audience();

$audience->create([
  'name' => 'MailChimp Test',
  'contact' => [
    'company' => 'Demo Company Inc.',
    'address1' => 'Just a demo address',
    'city' => 'Nnewi South',
    'state' => 'Anambra',
    'zip' => '23401',
    'country' => 'Nigeria',
    'phone' => '+2347000000000'
  ],
  'permission_reminder' => 'Demo permission reminder',
  'campaign_defaults' => [
    'from_name' => 'Christian Ezeani',
    'from_email' => 'christian@example.com',
    'subject' => 'Demo Subject',
    'language' => 'en'
  ],
  'email_type_option' => false,
  'visibility' => 'prv'
]);

您可以在 示例 页面上找到更多可以玩耍的内容。

文档

访问 项目站点。如果您遇到问题,这应该是您首先查看的地方,因为它是更新最频繁的。

如何在常见场景中使用 MailChimp PHP 包装器的示例可以在 示例 页面上找到。

完整的生成 API 文档 在线可用

您可以通过在顶层文件夹中运行 composer docs 来生成完整的 API 级别文档,文档将出现在 docs/api 文件夹中,尽管您需要安装 PHPDocumentor。您可能会发现单元测试是了解如何进行各种操作的好来源,例如创建受众、订阅和取消订阅成员,等等。