README

The Mailchimp PHP library provides convenient access to the Mailchimp APIs from PHP.

Requirements
Installation
Usage
Environments
Exception Handling
Pagination
Advanced
Contributing

Requirements

This SDK requires PHP ^8.1.

Installation

composer require mailchimp/marketing-sdk

Usage

Instantiate and use the client with the following:

<?php

namespace Example;

use Mailchimp\MailchimpClient;
use Mailchimp\AccountExports\Requests\CreateAccountExportsRequest;
use Mailchimp\AccountExports\Types\CreateAccountExportsRequestIncludeStagesItem;

$client = new MailchimpClient(
    token: '<token>',
);
$client->accountExports->create(
    new CreateAccountExportsRequest([
        'includeStages' => [
            CreateAccountExportsRequestIncludeStagesItem::Audiences->value,
            CreateAccountExportsRequestIncludeStagesItem::GalleryFiles->value,
        ],
    ]),
);

Environments

This SDK allows you to configure different environments for API requests.

The SDK defaults to the `Default_` environment. To use a different environment, pass it to the client constructor:

```php
use Mailchimp\MailchimpClient;
use Mailchimp\Environments;

$client = new MailchimpClient(
    token: '<YOUR_TOKEN>',
    options: [
        'baseUrl' => Environments::Staging->value
    ]
);

Available environments:

Environments::Default_


## Exception Handling

When the API returns a non-success status code (4xx or 5xx response), an exception will be thrown.

```php
use Mailchimp\Exceptions\MailchimpApiException;
use Mailchimp\Exceptions\MailchimpException;

try {
    $response = $client->accountExports->create(...);
} catch (MailchimpApiException $e) {
    echo 'API Exception occurred: ' . $e->getMessage() . "\n";
    echo 'Status Code: ' . $e->getCode() . "\n";
    echo 'Response Body: ' . $e->getBody() . "\n";
    // Optionally, rethrow the exception or handle accordingly.
}

Pagination

List endpoints return a Pager<T> which lets you loop over all items and the SDK will automatically make multiple HTTP requests for you.

use Mailchimp\MailchimpClient;

$client = new MailchimpClient(
    '<YOUR_TOKEN>',
    ['baseUrl' => 'https://api.example.com'],
);

$items = $client->accountExports->list(['limit' => 10]);

foreach ($items as $item) {
    var_dump($item);
}

You can also iterate page-by-page:

foreach ($items->getPages() as $page) {
    foreach ($page->getItems() as $pageItem) {
        var_dump($pageItem);
    }
}

Advanced

Custom Client

This SDK is built to work with any HTTP client that implements the PSR-18 ClientInterface. By default, if no client is provided, the SDK will use php-http/discovery to find an installed HTTP client. However, you can pass your own client that adheres to ClientInterface:

use Mailchimp\MailchimpClient;

// Pass any PSR-18 compatible HTTP client implementation.
// For example, using Guzzle:
$customClient = new \GuzzleHttp\Client([
    'timeout' => 5.0,
]);

$client = new MailchimpClient(options: [
    'client' => $customClient
]);

// Or using Symfony HttpClient:
// $customClient = (new \Symfony\Component\HttpClient\Psr18Client())
//     ->withOptions(['timeout' => 5.0]);
//
// $client = new MailchimpClient(options: [
//     'client' => $customClient
// ]);

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

408 (Timeout)
429 (Too Many Requests)
5XX (Internal Server Error)

The retryStatusCodes configuration controls which 5XX status codes are retried:

legacy (default): Retries 408, 429, and all >= 500
recommended: Retries 408, 429, 502, 503, 504 only (excludes 500 Internal Server Error to avoid retrying non-idempotent failures)

Use the maxRetries request option to configure this behavior.

$response = $client->accountExports->create(
    ...,
    options: [
        'maxRetries' => 0 // Override maxRetries at the request level
    ]
);

Timeouts

The SDK defaults to a 30 second timeout. Use the timeout option to configure this behavior.

$response = $client->accountExports->create(
    ...,
    options: [
        'timeout' => 3.0 // Override timeout at the request level
    ]
);

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

mailchimp / marketing-sdk

Package info

Security

Statistics