mailersend-php

KO | EN

gitlite — search

#python #javascript #php #ruby #hacktoberfest #scala #events #blog #plugin #shell #grammar #video

★ 82 Open GitHub ↗

The official MailerSend PHP SDK

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

MailerSend PHP SDK

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/mailersend/mailersend-php/main/LICENSE.md) ![build badge](https://github.com/mailersend/mailersend-php/actions/workflows/php.yml/badge.svg) ![analysis badge](https://github.com/mailersend/mailersend-php/actions/workflows/static-analysis.yml/badge.svg)

# Table of Contents

* [Installation](#installation)
* [Usage](#usage)
    * [Email API](#email-api)
        * [Send an email](#send-an-email)
        * [Add CC, BCC recipients](#cc-bcc-recipients)
        * [Send a template-based email](#template)
        * [Personalization](#personalization)
        * [Send an email with attachment](#attachments)
        * [Send email with inline attachment](#send-email-with-inline-attachment)
        * [Send email with references (threading)](#send-email-with-references-threading)
        * [Send email with list-unsubscribe](#send-email-with-list-unsubscribe)
        * [Send a scheduled message](#send-a-scheduled-message)
        * [Send email with precedence bulk header](#precedence-bulk-header)
        * [Send an email with tracking](#send-an-email-with-tracking)
        * [Send email with custom headers](#custom-headers)
        * [Send an email with RCPT TO recipients](#send-an-email-with-rcpt-to)
    * [Bulk emails API](#bulk-email-api)
        * [Send bulk email](#send-bulk-email)
        * [Get bulk email status](#get-bulk-email-status)
    * [Inbound routing](#inbound-routing)
        * [Get a list of inbound routes](#get-a-list-of-inbound-routes)
        * [Get a single inbound route](#get-a-single-inbound-route)
        * [Add an inbound route](#add-an-inbound-route)
        * [Update an inbound route](#update-an-inbound-route)
        * [Delete an inbound route](#delete-an-inbound-route)
    * [Activity API](#activity)
        * [Get a list of activities](#get-a-list-of-activities)
        * [Get a single activity](#get-a-single-activity)
    * [Analytics API](#analytics)
        * [Get activity data by date](#get-activity-data-by-date)
        * [Opens by country](#opens-by-country)
        * [Opens by user-agent](#opens-by-user-agent)
        * [Opens by reading environment](#opens-by-reading-environment)
    * [Domains API](#domains)
        * [Get a list of domains](#get-a-list-of-domains)
        * [Get domain](#get-domain)
        * [Add a domain](#add-a-domain)
        * [Delete domain](#delete-domain)
        * [Get a list of recipients per domain](#get-a-list-of-recipients-per-domain)
        * [Update domain settings](#update-domain-settings)
        * [Verify a domain](#verify-a-domain)
        * [Get DNS records](#get-dns-records)
    * [Messages API](#messages)
        * [Get a list of messages](#get-a-list-of-messages)
        * [Get info on a message](#get-info-on-a-message)
    * [Scheduled messages API](#scheduled-messages)
        * [Get a list of scheduled messages](#get-a-list-of-scheduled-messages)
        * [Get a single scheduled message](#get-a-single-scheduled-message)
        * [Delete a scheduled message](#delete-a-scheduled-message)
    * [Tokens API](#tokens)
        * [Get all tokens](#get-all-tokens)
        * [Find a token](#find-a-token)
        * [Create a token](#create-a-token)
        * [Change a token name](#change-a-token-name)
        * [Update token](#update-token)
        * [Delete token](#delete-token)
    * [Recipients API](#recipients)
        * [Get a list of recipients](#get-a-list-of-recipients)
        * [Get single recipient](#get-single-recipient)
        * [Delete recipient](#delete-recipient)
        * [Add recipients to a suppression list](#add-recipients-to-a-suppression-list)
        * [Delete recipients from a suppression list](#delete-recipients-from-a-suppression-list)
        * [Get recipients from a suppression list](#get-recipients-from-a-suppression-list)
    * [Webhooks API](#webhooks)
        * [Get a list of webhooks](#get-a-list-of-webhooks)
        * [Get webhook](#get-webhook)
        * [Create webhook](#create-webhook)
        * [Update webhook](#update-webhook)
        * [Delete webhook](#delete-webhook)
    * [Templates API](#templates)
        * [Get a list of templates](#get-a-list-of-templates)
        * [Get a single template](#get-a-single-template)
        * [Create a template](#create-a-template)
        * [Update a template](#update-a-template)
        * [Delete a template](#delete-a-template)
    * [Email Verification API](#email-verification)
        * [Get all email verification lists](#get-all-email-verification-lists)
        * [Get an email verification list](#get-an-email-verification-list)
        * [Create an email verification list](#create-an-email–verification-list)
        * [Verify an email list](#verify-an-email-list)
        * [Get email verification list results](#get-email-verification-list-results)
        * [Verify a single email](#verify-a-single-email)
        * [Verify a single email asynchronously](#verify-a-single-email-async)
        * [Get a single async email verification result](#get-async-verification-result)
    * [SMS API](#sms-api)
        * [Send an sms](#send-sms)
        * [Personalization](#sms-personalization)
    * [SMS phone number API](#sms-numbers-api)
        * [Get a list of sms phone numbers](#get-a-list-of-sms-numbers)
        * [Get an SMS phone number](#get-sms-number)
        * [Update a single SMS phone number](#update-sms-number)
        * [Delete an SMS phone number](#delete-sms-number)
    * [SMS messages API](#sms-messages-api)
        * [Get a list of SMS messages](#get-a-list-of-sms-messages)
        * [Get an SMS message](#get-sms-message)
    * [SMS Activity API](#sms-activity-api)
        * [Get a list of SMS activities](#get-a-list-of-sms-activities)
    * [SMS Recipients API](#sms-recipients-api)
        * [Get a list of SMS recipients](#get-a-list-of-sms-recipients)
        * [Get an SMS recipient](#get-sms-recipient)
        * [Update a single SMS recipient](#update-sms-recipient)
    * [SMS webhooks API](#sms-webhooks-api)
        * [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks)
        * [Get a single SMS webhook](#get-sms-webhook)
        * [Create an SMS webhook](#create-sms-webhook)
        * [Update a single SMS webhook](#update-sms-webhook)
    * [SMS inbound routing API](#sms-inbounds-api)
        * [Get a list of SMS inbound routes](#get-a-list-of-sms-inbounds)
        * [Get a single SMS inbound route](#get-sms-inbound)
        * [Add an SMS inbound route](#create-sms-inbound)
        * [Update an inbound route](#update-sms-inbound)
        * [Delete an SMS inbound route](#delete-sms-inbound)
    * [Sender Identities](#sender-identity-routing)
        * [Get a list of Sender Identities](#get-a-list-of-sender-identity-routes)
        * [Get a single Sender Identity](#get-a-single-sender-identity-route)
        * [Get a single Sender Identity by email](#get-a-single-sender-identity-by-email-route)
        * [Add a Sender_Identity](#add-a-sender-identity-route)
        * [Update a Sender Identity](#update-a-sender-identity-route)
        * [Update a Sender Identity by email](#update-a-sender-identity-by-email-route)
        * [Resend Sender Identity verification email](#resend-sender-identity-route)
        * [Delete a Sender Identity](#delete-a-sender-identity-route)
        * [Delete a Sender Identity by email](#delete-a-sender-identity-by-email-route)
    * [SMTP Users](#smtp-users-routing)
        * [Get a list of SMTP Users](#get-a-list-of-smtp-users)
        * [Get a single SMTP User](#get-a-single-smtp-user)
        * [Add SMTP User](#add-smtp-user)
        * [Update SMTP User](#update-smtp-user)
        * [Delete SMTP User](#delete-smtp-user)
    * [Users](#users-routing)
        * [Get a list of Users](#get-a-list-of-users)
        * [Get a single User](#get-a-single-user)
        * [Add a User](#add-a-user)
        * [Update a User](#update-a-user)
        * [Delete a User](#delete-a-user)
        * [Get a list of Invites](#get-a-list-of-invites)
        * [Get a single Invite](#get-a-single-invite)
        * [Resend an Invite](#resend-an-invite)
        * [Cancel an Invite](#cancel-an-invite)
    * [DMARC Monitoring API](#dmarc-monitoring)
        * [Get a list of monitors](#get-a-list-of-monitors)
        * [Create a monitor](#create-a-monitor)
        * [Update a monitor](#update-a-monitor)
        * [Delete a monitor](#delete-a-monitor)
        * [Get aggregated reports](#get-aggregated-reports)
        * [Get IP-specific reports](#get-ip-specific-reports)
        * [Get report sources](#get-report-sources)
        * [Mark IP as favorite](#mark-ip-as-favorite)
        * [Remove IP from favorites](#remove-ip-from-favorites)
    * [Blocklist Monitoring API](#blocklist-monitoring)
        * [Get a list of blocklist monitors](#get-a-list-of-blocklist-monitors)
        * [Get a single blocklist monitor](#get-a-blocklist-monitor)
        * [Create a blocklist monitor](#create-a-blocklist-monitor)
        * [Update a blocklist monitor](#update-a-blocklist-monitor)
        * [Delete a blocklist monitor](#delete-a-blocklist-monitor)
    * [Other endpoints](#other-endpoints)
        * [Get API quota](#get-api-quota)
* [Debugging validation errors](#debugging-validation-errors)
* [Testing](#testing)
* [Support and Feedback](#support-and-feedback)
* [License](#license)

# Installation

## Requirements

- PHP 7.4
- PSR-7 and PSR-18 based HTTP adapter
- An API Key from [mailersend.com](https://www.mailersend.com)

## Setup

This library, after version v0.22.0 is not compatible with Laravel 8.0 or lower. Please use older versions of SDK, or update your Laravel version.

This library is built atop of [PSR-7](https://www.php-fig.org/psr/psr-7/) and
[PSR-18](https://www.php-fig.org/psr/psr-18/). You will need to install some implementations for those interfaces.

```bash
composer require php-http/guzzle7-adapter nyholm/psr7
```

After that you can install the SDK.

```bash
composer require mailersend/mailersend
```

Finally, add an environment variable called `MAILERSEND_API_KEY` with the appropriate API key.

Optionally, although not recommended, you can manually add the API key when instantiating the `MailerSend` class, like so:

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'your_api_key']);
```

# Usage

## Email

### Send an email

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content')
    ->setReplyTo('reply to')
    ->setReplyToName('reply to name');

$mailersend->email->send($emailParams);
```

HTML content is not required. You still can send an email with Text only.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setText('This is the text content');

$mailersend->email->send($emailParams);
```

### Add CC, BCC recipients

Send an email with CC and BCC.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$cc = [
    new Recipient('cc@mail.com', 'CC'),
];

$bcc = [
    new Recipient('bcc@mail.com', 'BCC'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setCc($cc)
    ->setBcc($bcc)
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content');

$mailersend->email->send($emailParams);
```

### Send a template-based email

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$tags = ['tag'];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setTemplateId('ss243wdasd')
    ->setTags($tags);

$mailersend->email->send($emailParams);
```

You can also send a template in a specific language using a language code (e.g. `de`, `fr`, `pt-BR`). When set, the template's published translation for that language is used, falling back to the base content if none exists. This is only meaningful when a `template_id` is set.

```php
$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setTemplateId('ss243wdasd')
    ->setLanguage('de')
    ->setTags($tags);

$mailersend->email->send($emailParams);
```

### Personalization

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Personalization;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$personalization = [
    new Personalization('your@client.com', [
        'var' => 'variable',
        'number' => 123,
        'object' => [
            'key' => 'object-value'
        ],
        'objectCollection' => [
            [
                'name' => 'John'
            ],
            [
                'name' => 'Patrick'
            ]
        ],
    ])
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject {$var}')
    ->setHtml('This is the html version with a {$var}.')
    ->setText('This is the text versions with a {$var}.')
    ->setPersonalization($personalization);

$mailersend->email->send($emailParams);
```

### Send email with attachment

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Attachment;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$attachments = [
    new Attachment(file_get_contents('attachment.jpg'), 'attachment.jpg')
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the html version.')
    ->setText('This is the text version.')
    ->setAttachments($attachments);

$mailersend->email->send($emailParams);
```

<a name="send-email-with-inline-attachment"></a>
### Send email with inline attachment

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Attachment;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$attachments = [
    new Attachment(file_get_contents('image.png'), 'image.png', 'inline', 'content-id-1')
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the html version with an inline image <img src="cid:content-id-1"/>.')
    ->setText('This is the text version.')
    ->setAttachments($attachments);

$mailersend->email->send($emailParams);
```

<a name="send-email-with-references-threading"></a>
### Send email with references (threading)

> **Note:** The `references` field is available on paid plan accounts only.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Re: Subject')
    ->setHtml('This is the HTML content.')
    ->setText('This is the text content.')
    ->setInReplyTo('<original-message-id@yourdomain.com>')
    ->setReferences(['<original-message-id@yourdomain.com>', '<another-message-id@yourdomain.com>']);

$mailersend->email->send($emailParams);
```

<a name="send-email-with-list-unsubscribe"></a>
### Send email with list-unsubscribe

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the HTML content.')
    ->setText('This is the text content.')
    ->setListUnsubscribe('https://www.yourdomain.com/unsubscribe');

$mailersend->email->send($emailParams);
```

<a name="send-a-scheduled-message"></a>
### Send a scheduled message

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the html version.')
    ->setText('This is the text version.')
    ->setSendAt(1665626400) // Unix timestamp or ISO 8601 string, e.g. '2022-10-13T08:00:00+00:00'
    ->setPrecedenceBulkHeader(true);

$mailersend->email->send($emailParams);
```

<a name="precedence-bulk-header"></a>
### Send email with precedence bulk header

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the html version.')
    ->setText('This is the text version.')
    ->setPrecedenceBulkHeader(true);

$mailersend->email->send($emailParams);
```

<a name="send-an-email-with-tracking"></a>
### Send an email with tracking

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients($recipients)
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content')
    ->setTrackClicks(true)
    ->setTrackOpens(true)
    ->setTrackContent(true);

$mailersend->email->send($emailParams);
```

<a name="custom-headers"></a>
### Send an email with custom headers

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;
use MailerSend\Helpers\Builder\Header;

$mailersend = new MailerSend(['api_key' => 'key']);

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

$headers = [
    new Header('Custom-Header-1', 'Value 1')
    new Header('Custom-Header-2', 'Value 2')
];

$mailersend->email->send($emailParams);
```

<a name="send-an-email-with-rcpt-to"></a>
### Send an email with RCPT TO recipients

`rcptTo` is intended for SMTP source delivery and accepts a list of recipients.
When `to` is empty and `rcptTo` is provided, the addresses are forwarded as BCC.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$rcptTo = [
    new Recipient('rcpt@client.com'),
];

$emailParams = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content')
    ->setRcptTo($rcptTo);

$mailersend->email->send($emailParams);
```

<a name="bulk-email-api"></a>
## Bulk email API

<a name="send-bulk-email"></a>
### Send bulk email

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;

$mailersend = new MailerSend();

$bulkEmailParams = [];

$bulkEmailParams[] = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients([
        new Recipient('recipient1@client.com', 'Your Client'),
    ])
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content');

$bulkEmailParams[] = (new EmailParams())
    ->setFrom('your@domain.com')
    ->setFromName('Your Name')
    ->setRecipients([
        new Recipient('recipient2@client.com', 'Your Client'),
    ])
    ->setSubject('Subject')
    ->setHtml('This is the HTML content')
    ->setText('This is the text content');

$mailersend->bulkEmail->send($bulkEmailParams);
```

<a name="get-bulk-email-status"></a>
### Get bulk email status

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->bulkEmail->getStatus('bulk_email_id');
```

## Inbound routing

### Get a list of inbound routes

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->inbound->getAll($domainId = 'domainId', $page = 1, $limit = 10);
```

### Get a single inbound route

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->inbound->find('inboundId');
```

### Add an inbound route

Example using only classes:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Inbound;
use \MailerSend\Helpers\Builder\CatchFilter;
use \MailerSend\Helpers\Builder\MatchFilter;
use \MailerSend\Helpers\Builder\Forward;
use \MailerSend\Helpers\Builder\Filter;
use \MailerSend\Common\Constants;

$mailersend = new MailerSend();

Example using both classes and arrays:

$mailersend = new MailerSend();

$mailersend->inbound->create(
    (new Inbound('domainId', 'name', true))
        ->setInboundDomain('inboundDomain')
        ->setCatchFilter(
            (new CatchFilter(Constants::TYPE_CATCH_RECIPIENT))
                ->setFilters([
                    [
                        'comparer' => Constants::COMPARER_EQUAL,
                        'value' => 'test@mailersend.com',
                    ]
                ])
        )
        ->setMatchFilter(
            (new MatchFilter(Constants::TYPE_MATCH_SENDER))
                ->setFilters([
                    [
                        'comparer' => Constants::COMPARER_EQUAL,
                        'value' => 'sender@mailersend.com',
                        'key' => 'sender',
                    ]
                ])
        )
        ->addForward(new Forward(Constants::TYPE_WEBHOOK, 'value'))
        ->setInboundPriority(50)
);
```

Example using only arrays:

$mailersend = new MailerSend();

$mailersend->inbound->create(
    (new Inbound('domainId', 'name', true))
        ->setInboundDomain('inboundDomain')
        ->setCatchFilter([
            'type' => Constants::TYPE_CATCH_RECIPIENT,
            'filters' => [
                [
                    'comparer' => Constants::COMPARER_EQUAL,
                    'value' => 'test@mailersend.com',
                ],
            ],
        ])
        ->setMatchFilter([
            'type' => Constants::TYPE_MATCH_SENDER,
            'filters' => [
                [
                    'comparer' => Constants::COMPARER_EQUAL,
                    'value' => 'sender@mailersend.com',
                    'key' => 'sender',
                ],
            ],
        ])
        ->setForwards([
            [
                'type' => Constants::TYPE_WEBHOOK,
                'value' => 'value',
            ]
        ])
        ->setInboundPriority(50)
);
```

### Update an inbound route

The examples on building the `Inbound` object portrayed in the 'Add an inbound route' also apply in here.

$mailersend = new MailerSend();

$mailersend->inbound->update(
    'inboundId',
    (new Inbound('domainId', 'name', true))
        ->setInboundDomain('inboundDomain')
        ->setCatchFilter(
            (new CatchFilter(Constants::TYPE_CATCH_ALL))
        )
        ->setMatchFilter(new MatchFilter(Constants::TYPE_MATCH_ALL))
        ->addForward(new Forward(Constants::TYPE_WEBHOOK, 'value'))
);
```

### Delete an inbound route

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->inbound->delete('inboundId');
```

## Activity

### Get a list of activities

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\ActivityParams;

$mailersend = new MailerSend();

$activityParams = (new ActivityParams())
                    ->setPage(3)
                    ->setLimit(15)
                    ->setDateFrom(1623073576)
                    ->setDateTo(1623074976)
                    ->setEvent(['queued', 'sent', 'survey_opened', 'survey_submitted', 'deferred', 'suppressed']);

$mailersend->activity->getAll('domainId', $activityParams);
```

> **Note:** The `suppressed` event is available on the Starter plan and above, otherwise the API returns error code `MS42240`. Activities of that type also include a `suppression_reason` field, one of `on_hold`, `hard_bounced`, `unsubscribed`, `spam_complained`, `blocklisted`.

### Get a single activity

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\ActivityParams;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->activity->find('activity_id');
```

## Analytics

### Get activity data by date

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\ActivityAnalyticsParams;
use MailerSend\Common\Constants;

$mailersend = new MailerSend();

$activityAnalyticsParams = (new ActivityAnalyticsParams(100, 101))
                    ->setDomainId('domain_id')
                    ->setGroupBy(Constants::GROUP_BY_DAYS)
                    ->setTags(['tag'])
                    ->setEvent(['queued', 'sent']);

$mailersend->analytics->activityDataByDate($activityAnalyticsParams);
```

### Opens by country

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\OpensAnalyticsParams;

$mailersend = new MailerSend();

$opensAnalyticsParams = (new OpensAnalyticsParams(100, 101))
                    ->setDomainId('domain_id')
                    ->setTags(['tag']);

$mailersend->analytics->opensByCountry($opensAnalyticsParams);
```

### Opens by user-agent

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\OpensAnalyticsParams;

$mailersend = new MailerSend();

$opensAnalyticsParams = (new OpensAnalyticsParams(100, 101))
                    ->setDomainId('domain_id')
                    ->setTags(['tag']);

$mailersend->analytics->opensByUserAgentName($opensAnalyticsParams);
```

### Opens by reading environment

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\OpensAnalyticsParams;

$mailersend = new MailerSend();

$opensAnalyticsParams = (new OpensAnalyticsParams(100, 101))
                    ->setDomainId('domain_id')
                    ->setTags(['tag']);

$mailersend->analytics->opensByReadingEnvironment($opensAnalyticsParams);
```

## Domains

### Get a list of domains

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->getAll($page = 1, $limit = 10, $verified = true);
```

### Get domain

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->find('domain_id');
```

### Add a domain

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\DomainParams;

$mailersend = new MailerSend();

$domainParams = (new DomainParams('domainName'))
                    ->setReturnPathSubdomain('returnPath')
                    ->setCustomTrackingSubdomain('customTracking')
                    ->getInboundRoutingSubdomain('inboundRouting');

$mailersend->domain->create($domainParams);

```

<a name="delete-domain"></a>
### Delete domain

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->delete('domain_id');
```

### Get a list of recipients per domain

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->recipients($domainId = 'domain_id', $page = 1, $limit = 10);
```

### Update domain settings

Here you can set as many properties as you need, one or multiple.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\DomainSettingsParams;

$mailersend = new MailerSend();

$domainSettingsParam = (new DomainSettingsParams())
                            ->setSendPaused(true)
                            ->setTrackClicks(true)
                            ->setTrackOpens(false)
                            ->setTrackUnsubscribe(false)
                            ->setTrackContent(true)
                            ->setTrackUnsubscribeHtml('html')
                            ->setTrackUnsubscribeHtmlEnabled(true)
                            ->setTrackUnsubscribePlain('plain')
                            ->setTrackUnsubscribePlainEnabled(true)
                            ->setCustomTrackingEnabled(true)
                            ->setCustomTrackingSubdomain(false);

$mailersend->domain->domainSettings($domainId = 'domain_id', $domainSettingsParam);
```

### Verify a domain

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->verify('domain_id');
```

### Get DNS records

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->domain->getDnsRecords('domain_id');
```

## Messages

### Get a list of messages

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->messages->get($limit = 100, $page = 3, $domainId = 'domain_id');
```

### Get info on a message

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->messages->find('message_id');
```

## Scheduled Messages

### Get a list of scheduled messages

```php
use MailerSend\MailerSend;
use \MailerSend\Common\Constants;

$mailersend = new MailerSend();

$mailersend->scheduleMessages->getAll(
    'domain_id',
    Constants::STATUS_SCHEDULED,
    $page = 3,
    $limit = 100
)
```

### Get a single scheduled message

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->scheduleMessages->find('message_id');
```

### Delete a scheduled message

```php
use MailerSend\MailerSend;
use \MailerSend\Common\Constants;

$mailersend = new MailerSend();

$mailersend->scheduleMessages->delete('message_id');
```

## Tokens

### Get all tokens

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->token->getAll($page = 1, $limit = 10);
```

### Find a token

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->token->find('token_id'); 
```

### Create a token

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TokenParams;

$mailersend = new MailerSend();

$mailersend->token->create(
    new TokenParams('token name', 'domainId', TokenParams::ALL_SCOPES)
);
```

Because of security reasons, we only allow access token appearance once during creation. In order to see the access token created you can do:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TokenParams;

$mailersend = new MailerSend();

$response = $mailersend->token->create(
    new TokenParams('token name', 'domainId', TokenParams::ALL_SCOPES)
);

echo $response['body']['data']['accessToken'];
```

### Change a token name

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TokenParams;

$mailersend = new MailerSend();

$mailersend->token->changeName('token_id', 'new name'); 
```

### Update token

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TokenParams;

$mailersend = new MailerSend();

$mailersend->token->update('token_id', TokenParams::STATUS_PAUSE); // PAUSE
$mailersend->token->update('token_id', TokenParams::STATUS_UNPAUSE); // UNPAUSE
```

### Delete Token

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TokenParams;

$mailersend = new MailerSend();

$mailersend->token->delete('token_id');
```

## Recipients

### Get a list of recipients

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->recipients->get(null, $limit = 100, $page = 3);
// Or for a specific domain
$mailersend->recipients->get('domain_id', $limit = 100, $page = 3);
```

### Get single recipient

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->recipients->find('recipient_id');
```

### Delete recipient

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->recipients->delete('recipient_id');
```

### Add recipients to a suppression list

**Blocklist**

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\BlocklistParams;

$mailersend = new MailerSend();

$params = (new BlocklistParams())
    ->setDomainId('domain_id')
    ->setRecipients(['recipient_one', 'recipient_two'])
    ->setPatterns(['pattern_one', 'pattern_two']);

$mailersend->blocklist->create($params);
```

**Hard Bounces**

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SuppressionParams;

$mailersend = new MailerSend();

$params = (new SuppressionParams())
    ->setDomainId('domain_id')
    ->setRecipients(['recipient_one', 'recipient_two']);

$mailersend->hardBounce->create($params);
```

**Spam Complaints**

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SuppressionParams;

$mailersend = new MailerSend();

$params = (new SuppressionParams())
    ->setDomainId('domain_id')
    ->setRecipients(['recipient_one', 'recipient_two']);

$mailersend->spamComplaint->create($params);
```

**Unsubscribes**

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SuppressionParams;

$mailersend = new MailerSend();

$params = (new SuppressionParams())
    ->setDomainId('domain_id')
    ->setRecipients(['recipient_one', 'recipient_two']);

$mailersend->unsubscribe->create($params);
```

### Delete recipients from a suppression list

**Blocklist**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

// Delete specific instances
$mailersend->blocklist->delete(['id_one', 'id_two']);

// or delete all
$mailersend->blocklist->delete(null, true);

// You can also specify the domain
$mailersend->blocklist->delete(['id'], false, 'domain_id');
```

**Hard Bounces**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

// Delete specific instances
$mailersend->hardBounce->delete(['id_one', 'id_two']);

// or delete all
$mailersend->hardBounce->delete(null, true);

// You can also specify the domain
$mailersend->hardBounce->delete(['id'], false, 'domain_id');
```

**Spam Complaints**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

// Delete specific instances
$mailersend->spamComplaint->delete(['id_one', 'id_two']);

// or delete all
$mailersend->spamComplaint->delete(null, true);

// You can also specify the domain
$mailersend->spamComplaint->delete(['id'], false, 'domain_id');
```

**Unsubscribes**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

// Delete specific instances
$mailersend->unsubscribe->delete(['id_one', 'id_two']);

// or delete all
$mailersend->unsubscribe->delete(null, true);

// You can also specify the domain
$mailersend->unsubscribe->delete(['id'], false, 'domain_id');
```

**On Hold List**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

// Delete specific instances
$mailersend->onHoldList->delete(['id_one', 'id_two']);

// or delete all
$mailersend->onHoldList->delete(null, true);
```

### Get recipients from a suppression list

**Blocklist**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->blocklist->getAll('domain_id', 15);
```

**Hard Bounces**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->hardBounce->getAll('domain_id', 15);
```

**Spam Complaints**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->spamComplaint->getAll('domain_id', 15);
```

**Unsubscribes**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->unsubscribe->getAll('domain_id', 15);
```

**On Hold List**

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->onHoldList->getAll('domain_id', 15);
```

## Webhooks

### Get a list of webhooks

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->webhooks->get('domain_id');

// With limit
$mailersend->webhooks->get('domain_id', $limit = 25);
```

### Get webhook

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->webhooks->find('webhook_id');
```

### Create webhook

```php
use MailerSend\Helpers\Builder\WebhookParams;
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->webhooks->create(
    new WebhookParams('https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES, 'domain_id')
);

// Or a disabled webhook

$mailersend->webhooks->create(
    new WebhookParams('https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES, 'domain_id', false)
);

// Or with a specific webhook payload version (1 or 2)

$mailersend->webhooks->create(
    new WebhookParams('https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES, 'domain_id', true, 2)
);
```

### Update webhook

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\WebhookParams;

$mailersend = new MailerSend();

$mailersend->webhooks->update('webhook_id', 'https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES);

// Enable webhook
$mailersend->webhooks->update('webhook_id', 'https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES, true);

// Disable webhook
$mailersend->webhooks->update('webhook_id', 'https://webhook_url', 'Webhook name', WebhookParams::ALL_ACTIVITIES, false);

// Update version, editable and domain_id
$mailersend->webhooks->update(
    'webhook_id',
    'https://webhook_url',
    'Webhook name',
    WebhookParams::ALL_ACTIVITIES,
    $enabled = true,
    $version = 2,
    $editable = true,
    $domainId = 'domain_id'
);
```

### Delete webhook

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->webhooks->delete('webhook_id');
```

*If, at the moment, some endpoint is not available, please use `cURL` and other available tools to access it. [Refer to official API docs for more info](https://developers.mailersend.com/).*

## Templates

### Get a list of templates

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

// Get all templates of an account
$mailersend->template->getAll();

// Get all templates of a domain
$mailersend->template->getAll('domain_id');

// Get page 2 of templates with 20 records per page
$mailersend->template->getAll('domain_id', 2, 20);
```

### Get a single template

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->template->find('template_id');
```

### Create a template

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TemplateParams;

$mailersend = new MailerSend();

$params = (new TemplateParams())
    ->setName('My Template')
    ->setHtml('<p>Hello {{name}}</p>')
    ->setText('Hello {{name}}')
    ->setDomainId('domain_id')
    ->setCategories(['category1', 'category2'])
    ->setTags(['tag1', 'tag2'])
    ->setAutoGenerate(true);

$mailersend->template->create($params);
```

### Update a template

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\TemplateParams;

$mailersend = new MailerSend();

$params = (new TemplateParams())
    ->setName('Updated Template Name')
    ->setHtml('<p>Hello {{name}}</p>')
    ->setText('Hello {{name}}');

$mailersend->template->update('template_id', $params);
```

### Delete a template

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->template->delete('template_id');
```

## Email Verification

### Get all email verification lists

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->getAll($page = 1, $limit = 10);
```

### Get an email verification list

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->find('email_verification_id');

// With detailed flag and pagination
$mailersend->emailVerification->find(
    'email_verification_id',
    $detailed = true,
    $page = 1,
    $limit = 10,
);
```

### Create an email verification list

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\EmailVerificationParams;

$mailersend = new MailerSend();

$emailVerificationParams = (new EmailVerificationParams('file.csv'))
    ->setEmailAddresses(['test@mail.com']);

$mailersend->emailVerification->create($emailVerificationParams);

// Optionally start verification immediately or attach to an existing list
$emailVerificationParams = (new EmailVerificationParams('file.csv'))
    ->setEmailAddresses(['test@mail.com'])
    ->setListId('existing_list_id')
    ->setVerify(true);

$mailersend->emailVerification->create($emailVerificationParams);
```

### Verify an email list

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->verify('email_verification_id');
```

### Get email verification list results

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\EmailVerificationParams;

$mailersend = new MailerSend();

$mailersend->emailVerification->getResults(
        $emailVerificationId = 'email_verification_id',
        $page = 1,
        $limit = 10,
        $results = [
            EmailVerificationParams::TYPO,
            EmailVerificationParams::CATCH_ALL,
        ],
    );
```

### Verify a single email

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->verifyEmail('test@mail.com');
```

### Verify a single email asynchronously

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->verifyAsync('test@mail.com');
```

### Get a single async email verification result

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->emailVerification->getVerifyAsyncResult('single_email_verification_id');
```

## SMS

### Send SMS

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsParams;

$mailersend = new MailerSend();

$smsParams = (new SmsParams())
    ->setFrom('+12065550101')
    ->setTo(['+12065550102'])
    ->addRecipient('+12065550103')
    ->setText('Text');
    
$sms = $mailersend->sms->send($smsParams);
```

### Personalization

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsParams;

$mailersend = new MailerSend();

$smsParams = (new SmsParams())
    ->setFrom('+12065550101')
    ->setTo(['+12065550102'])
    ->setText('Text {{ var }}')
    ->setPersonalization([
        new SmsPersonalization('+12065550102', [
            'var' => 'variable',
            'number' => 123,
            'object' => [
                'key' => 'object-value'
            ],
            'objectCollection' => [
                [
                    'name' => 'John'
                ],
                [
                    'name' => 'Patrick'
                ]
            ],
        ])
    ]);
    
$sms = $mailersend->sms->send($smsParams);
```

## SMS phone numbers

### Get a list of SMS phone numbers

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$sms = $mailersend->smsNumber->getAll($page = 1, $limit = 10, $paused = true);
```

### Get an SMS phone number

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$sms = $mailersend->smsNumber->find('sms_number_id');
```

### Update a single SMS phone number

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$sms = $mailersend->smsNumber->update('sms_number_id', $paused = true);
```

### Delete an SMS phone number

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$sms = $mailersend->smsNumber->delete('sms_number_id');
```

## SMS messages API

### Get a list of SMS messages

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsMessages = $mailersend->smsMessage->getAll($page = 1, $limit = 10);
```

### Get an SMS message

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsMessage = $mailersend->smsMessage->find('sms_message_id');
```

## SMS activity API

### Get a list of SMS activities

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsActivityParams;

$mailersend = new MailerSend();

$smsActivityParams = (new SmsActivityParams())
    ->setSmsNumberId('sms_number_id')
    ->setDateFrom(1623073576)
    ->setDateTo(1623074976)
    ->setStatus(['queued'])
    ->setPage(3)
    ->setLimit(15);

$smsActivity = $mailersend->smsActivity->getAll($smsActivityParams);
```

## SMS recipients API

### Get a list of SMS recipients

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsRecipientParams;

$mailersend = new MailerSend();

$smsRecipientParams = (new SmsRecipientParams())
    ->setSmsNumberId('sms_number_id')
    ->setStatus('opt_out')
    ->setPage(3)
    ->setLimit(15);

$smsRecipients = $mailersend->smsRecipient->getAll($smsRecipientParams);
```

### Get an SMS recipient

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsRecipient->find('sms_recipient_id');
```

### Update a single SMS recipient

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsRecipient->update('sms_recipient_id', $status = 'opt_out');
```

## SMS webhooks API

### Get a list of SMS webhooks

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsWebhook->get('sms_number_id');

// With limit
$smsRecipients = $mailersend->smsWebhook->get('sms_number_id', $limit = 25);
```

### Get a single SMS webhook

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsWebhook->find('sms_webhook_id');
```

### Create an SMS webhook

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsWebhookParams;

$mailersend = new MailerSend();

$smsWebhookParams = (new SmsWebhookParams())
    ->setSmsNumberId('sms_number_id')
    ->setName('Name')
    ->setUrl('https://mailersend.com/sms_webhook')
    ->setEvents(['sms.sent', 'sms.delivered', 'sms.failed'])
    ->setEnabled(false);

$smsRecipients = $mailersend->smsWebhook->create($smsWebhookParams);
```

### Update a single SMS webhook

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsWebhookParams;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsWebhook->update($smsWebhookParams);
```

## SMS inbound routing API

### Get a list of SMS inbound routes

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsInbound->getAll($smsNumberId = 'sms_number_id', $enabled = true, $page = 3, $limit = 15);
```

### Get a single SMS inbound route

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsInbound->find('sms_inbound_id');
```

### Add an SMS inbound route

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsInbound;
use MailerSend\Helpers\Builder\SmsInboundFilter;

$mailersend = new MailerSend();

$smsInboundParams = (new SmsInbound())
    ->setSmsNumberId('sms_number_id')
    ->setName('Name')
    ->setForwardUrl('https://mailersend.com/inbound_webhook')
    ->setFilter(new SmsInboundFilter($comparer = 'starts-with', $value = 'Stop'))
    ->setEnabled(true);

$smsRecipients = $mailersend->smsInbound->create($smsInboundParams);
```

### Update an inbound route

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SmsInbound;
use MailerSend\Helpers\Builder\SmsInboundFilter;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsInbound->update('sms_inbound_id', $smsInboundParams);
```

### Delete an SMS inbound route

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$smsRecipients = $mailersend->smsInbound->delete('sms_inbound_id');
```

## Sender identities

### Get a list of Sender Identities

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->senderIdentity->getAll($domainId = 'domainId', $page = 1, $limit = 10);

// With search and ordering
$mailersend->senderIdentity->getAll(
    $domainId = 'domainId',
    $page = 1,
    $limit = 10,
    $query = 'email address',
    $orderBy = 'created_at',
    $order = 'desc',
);
```

### Get a single Sender Identity

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->senderIdentity->find('identityId');
```

### Get a single Sender Identity by email

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->senderIdentity->findByEmail('email');
```

### Add a Sender Identity

Example using only classes:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SenderIdentity;

$mailersend = new MailerSend();

$mailersend->senderIdentity->create(
    (new SenderIdentity('domainId', 'name', 'email'))
);
```

Example using all options:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SenderIdentity;

$mailersend = new MailerSend();

$mailersend->senderIdentity->create(
    (new SenderIdentity('domainId', 'name', 'email'))
        ->setReplyToName("John Doe")
        ->setReplyToEmail("john@test.com")
        ->setAddNote(true)
        ->setPersonalNote("Hi John, please use this token")
);
```

### Update a Sender Identity

The examples on building the `Sender Identity` object portrayed in the 'Add a Sender Identity' also apply in here.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SenderIdentity;

$mailersend = new MailerSend();

$mailersend->senderIdentity->update(
    'identityId',
    (new SenderIdentity('domainId', 'name', 'email'))
        ->setReplyToName("John Doe")
        ->setReplyToEmail("john@test.com")
);
```

### Update a Sender Identity by email

The examples on building the `Sender Identity` object portrayed in the 'Add a Sender Identity' also apply in here.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\SenderIdentity;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->senderIdentity->updateByEmail(
    'identityId',
    (new SenderIdentity('domainId', 'name', 'email'))
        ->setReplyToName("John Doe")
        ->setReplyToEmail("john@test.com")
);
```

### Resend Sender Identity verification email

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->senderIdentity->resend('identityId');
```

### Delete a Sender Identity

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->senderIdentity->delete('identityId');
```

### Delete a Sender Identity by email

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->senderIdentity->deleteByEmail('email');
```

## SMTP Users

### Get a list of SMTP Users

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->smtpUser->getAll('domainId', 25);
```

### Get a single SMTP User
```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->smtpUser->find('domainId', 'smtpUserId');
```

### Add SMTP User
```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\UserParams;
use MailerSend\Helpers\Builder\SmtpUserParams;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->smtpUser->create(
    'domainId',
    (new SmtpUserParams('name'))
        ->setEnabled(false)
);
```

### Update SMTP User

The examples on building the `SMTP User` object portrayed in the 'Add SMTP User' also apply in here.
```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\UserParams;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->smtpUser->update(
    'domainId',
    'smtpUserId',
    (new SmtpUserParams('New name'))
        ->setEnabled(false)
);
```

### Delete SMTP User
```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->smtpUser->delete('domainId', 'smtpUserId');
```

## Users

### Get a list of Users

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->getAll();
```

### Get a single User

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->find('userId');
```

### Add a User

Example using only classes:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\UserParams;
use MailerSend\Common\Roles;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->create(
    (new UserParams('email', Roles::ADMIN))
);
```

Example using all options:

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\UserParams;
use MailerSend\Common\Roles;
use MailerSend\Common\Permissions;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->create(
    (new UserParams('email', Roles::CUSTOM_USER))
        ->setDomains(['domainId', 'anotherDomainId'])
        ->setTemplates(['templateId', 'anotherTemplateId'])
        ->setPermissions([Permissions::READ_OWN_TEMPLATES])
        ->setRequiresPeriodicPasswordChange(true)
);
```

### Update a User

The examples on building the `User` object portrayed in the 'Add a User' also apply in here.

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\UserParams;
use MailerSend\Common\Roles;
use MailerSend\Common\Permissions;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->update(
    'userId',
    (new UserParams())
        ->setRole(Roles::CUSTOM_USER)
        ->setDomains(['domainId', 'anotherDomainId'])
        ->setTemplates(['templateId', 'anotherTemplateId'])
        ->setPermissions([Permissions::READ_OWN_TEMPLATES])
        ->setRequiresPeriodicPasswordChange(true)
);
```

### Delete a User

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->user->delete('userId');
```

### Get a list of Invites

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->invite->getAll();
```

### Get a single Invite

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->invite->find('inviteId');
```

### Resend an Invite

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->invite->resend('inviteId');
```

### Cancel an Invite

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend(['api_key' => 'key']);

$mailersend->invite->cancel('inviteId');
```

## DMARC Monitoring

### Get a list of monitors

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->getAll($page = 1, $limit = 25);

// With search and ordering
$mailersend->dmarcMonitoring->getAll(
    $page = 1,
    $limit = 25,
    $query = 'example.com',
    $sortBy = 'created_at',
    $order = 'desc',
);
```

### Create a monitor

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\DmarcMonitoringParams;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->create(
    (new DmarcMonitoringParams('domain-id'))
);
```

### Update a monitor

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\DmarcMonitoringUpdateParams;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->update(
    'monitor-id',
    (new DmarcMonitoringUpdateParams('v=DMARC1; p=reject; rua=mailto:dmarc@example.com;'))
);
```

### Delete a monitor

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->delete('monitor-id');
```

### Get aggregated reports

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->getAggregatedReports('monitor-id', $page = 1, $limit = 25);

// With filters
$mailersend->dmarcMonitoring->getAggregatedReports(
    'monitor-id',
    $page = 1,
    $limit = 25,
    $dateFrom = '2024-01-01',
    $dateTo = '2024-01-31',
    $search = 'example.com',
    $category = 'dmarc',
    $reportSource = 'google.com',
);
```

### Get IP-specific reports

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->getIpReports('monitor-id', '1.2.3.4', $page = 1, $limit = 25);

// With filters
$mailersend->dmarcMonitoring->getIpReports(
    'monitor-id',
    '1.2.3.4',
    $page = 1,
    $limit = 25,
    $dateFrom = '2024-01-01',
    $dateTo = '2024-01-31',
    $search = 'example.com',
    $category = 'dmarc',
    $reportSource = 'google.com',
);
```

### Get report sources

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->getReportSources('monitor-id', '2024-01-01', '2024-01-31');

// With optional status filter
$mailersend->dmarcMonitoring->getReportSources(
    'monitor-id',
    $dateFrom = '2024-01-01',
    $dateTo = '2024-01-31',
    $status = 'accepted', // accepted, rejected, quarantined
);
```

### Mark IP as favorite

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->markIpAsFavorite('monitor-id', '1.2.3.4');
```

### Remove IP from favorites

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->dmarcMonitoring->removeIpFromFavorites('monitor-id', '1.2.3.4');
```

## Blocklist Monitoring

### Get a list of blocklist monitors

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->blocklistMonitoring->getAll($page = 1, $limit = 25);

// With search and ordering
$mailersend->blocklistMonitoring->getAll(
    $page = 1,
    $limit = 25,
    $query = 'example.com',
    $sortBy = 'created_at',
    $order = 'desc',
);
```

### Get a single blocklist monitor

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->blocklistMonitoring->find('monitor-id');
```

### Create a blocklist monitor

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\BlocklistMonitoringParams;

$mailersend = new MailerSend();

$mailersend->blocklistMonitoring->create(
    (new BlocklistMonitoringParams('example.com'))
        ->setName('My monitor')
        ->setNotify(true)
        ->setNotifyEmail('alerts@example.com')
        ->setNotifyAddress('https://example.com/webhook')
);
```

### Update a blocklist monitor

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\BlocklistMonitoringUpdateParams;

$mailersend = new MailerSend();

$mailersend->blocklistMonitoring->update(
    'monitor-id',
    (new BlocklistMonitoringUpdateParams())
        ->setName('My monitor')
        ->setNotify(true)
        ->setNotifyEmail('alerts@example.com')
        ->setNotifyAddress('https://example.com/webhook')
);
```

### Delete a blocklist monitor

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->blocklistMonitoring->delete('monitor-id');
```

## Other endpoints

### Get API quota

```php
use MailerSend\MailerSend;

$mailersend = new MailerSend();

$mailersend->apiQuota->get();
```

<a name="debugging-validation-errors"></a>
# Debugging validation errors

```php
use MailerSend\MailerSend;
use MailerSend\Helpers\Builder\Recipient;
use MailerSend\Helpers\Builder\EmailParams;
use MailerSend\Exceptions\MailerSendValidationException;
use MailerSend\Exceptions\MailerSendRateLimitException;

$mailersend = new MailerSend();

$recipients = [
    new Recipient('your@client.com', 'Your Client'),
];

try{
    $mailersend->email->send($emailParams);
} catch(MailerSendValidationException $e){
    // See src/Exceptions/MailerSendValidationException.php for more more info
    print_r($e->getResponse()->getBody()->getContents());
    print_r($e->getBody());
    print_r($e->getHeaders());
    print_r($e->getErrors());
    print_r($e->getStatusCode());
} catch (MailerSendRateLimitException $e) {
    print_r($e->getHeaders());
    print_r($e->getResponse()->getBody()->getContents());
}
```

<a name="testing"></a>
# Testing

``` bash
composer test
```

<a name="support-and-feedback"></a>
# Support and Feedback

In case you find any bugs, submit an issue directly here in GitHub.

You are welcome to create SDK for any other programming language.

If you have any troubles using our API or SDK free to contact our support by email [info@mailersend.com](mailto:info@mailersend.com)

The official documentation is at [https://developers.mailersend.com](https://developers.mailersend.com)

<a name="license"></a>
# License

[The MIT License (MIT)](LICENSE.md)

mailersend-php

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README