Minutemailer API PHP wrapper

v1.0.0 2023-09-08 12:50 UTC

This package is auto-updated.

Last update: 2024-04-04 11:37:55 UTC


README

This library allows you to quickly get started with the Minutemailer API via PHP. Libraries for other languages will come soon.

Before you get started, read the API documentation.

Installation

$ composer require minutemailer/api or download the php-file Minutemailer.php if you are not using composer.

Usage

First you need to create an API token. You can do so by logging in to your Minutemailer account and go to the API settings page.

Make sure the file is loaded, either by require 'vendor/autoload.php' if you are using composer or require 'path/Minutemailer.php' if you are not.

<?php

require 'vendor/autoload.php';

$personalAccessToken = 'myAccessToken';

$client = new Minutemailer\Minutemailer($personalAccessToken);

// Create new contact and add it to list
$response = $client->contacts()->create('validemail@domain.com', ['first_name' => 'Firstname', 'last_name' => 'Lastname'], ['123abc']);

$contact_id = $response->id;

// Add existing contact to list
$response = $client->contact_lists('123abc')->addContact($contact_id);

// Resubscribe unsubscribed contact
$response = $client->contacts($contact_id)->update(['status' => 1]);

Email is required and name is optional. $response will be filled with the contact data if the request is valid. Otherwise, an error will be returned.