PHPackages                             oxemis/oximailing - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. oxemis/oximailing

ActiveLibrary[API Development](/categories/api)

oxemis/oximailing
=================

PHP wrapper for the OxiMailing API

v1.1.2(1y ago)31.8kMITPHP

Since Apr 17Pushed 1y ago2 watchersCompare

[ Source](https://github.com/oxemis/oximailing-php)[ Packagist](https://packagist.org/packages/oxemis/oximailing)[ RSS](/packages/oxemis-oximailing/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

Official OxiMailing PHP Wrapper
===============================

[](#official-oximailing-php-wrapper)

[![MIT License](https://camo.githubusercontent.com/48593de0035d3aebc555d81be22bb1136d0741866cc69614fd437cacc7553cf7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d3030374543372e7376673f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/48593de0035d3aebc555d81be22bb1136d0741866cc69614fd437cacc7553cf7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d3030374543372e7376673f7374796c653d666c61742d737175617265)[![Current Version](https://camo.githubusercontent.com/97f85f046265623c4b26076add9bcc55f9608152c20e78f07076369977c77d05/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e302e302d677265656e2e737667)](https://camo.githubusercontent.com/97f85f046265623c4b26076add9bcc55f9608152c20e78f07076369977c77d05/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e302e302d677265656e2e737667)

Overview
--------

[](#overview)

This repository contains the official PHP wrapper for the OxiMailing API. To get started, create an account and request your free credits on [this page](https://account.oxemis.com/)

This library is a wrapper for the [OxiMailing API](https://api.oximailing.com) but you don't have to know how to use the API to get started with this library.

What is OxiMailing ?
--------------------

[](#what-is-oximailing-)

OxiMailing is a solution designed to enable you to **send your emails quickly and easily and in the best possible conditions**.

From transactional emails to massive campaigns, we can handle all your needs.

Founded in 2004, OxiMailing focuses on the **deliverability of your emails**. Our experience and knowledge of the email world enable us to offer you an exceptional quality of service. We're a small team, but we're recognized for the quality of our support and expertise.

Table of contents
-----------------

[](#table-of-contents)

- [Compatibility](#compatibility)
- [Installation](#installation)
- [Authentication](#authentication)
- [Getting information about your account](#getting-information-about-your-account)
- [Sending your first email](#sending-your-first-email)
- [How to send customized messages ?](#how-to-send-customized-messages)
- [Tracking a message](#tracking-a-message)
- [Other features](#other-features)
- [Contribute](#contribute)

Compatibility
-------------

[](#compatibility)

This library requires **PHP v7.4** or higher.

Installation
------------

[](#installation)

Use the below code to install the wrapper:

`composer require oxemis/oximailing`

Authentication
--------------

[](#authentication)

This library is a wrapper to the [OxiMailing API](https://api.oximailing.com). You can request an API KEY in your [OxiMailing Account](https://account.oxemis.com). Free credits are offered.

You should export your API\_LOGIN and API\_PASSWORD in order to use them in this library :

```
export OXIMAILING_API_LOGIN='your API login'
export OXIMAILING_API_PWD='your API password'
```

Initialize your **OxiMailing** Client:

```
require_once "vendor/autoload.php";
use Oxemis\OxiMailing\OxiMailingClient;

// getenv will allow us to get the OXIMAILING_API_LOGIN/OXIMAILING_API_PWD variables we created before:

$apilogin = getenv('OXIMAILING_API_LOGIN');
$apipwd = getenv('OXIMAILING_API_PWD');

$oximailing = new OxiMailingClient($apilogin, $apipwd);

// or, without using environment variables:

$apilogin = 'your API login';
$apipwd = 'your API password';

$oximailing = new OxiMailingClient($apilogin, $apipwd);
```

Getting information about your account
--------------------------------------

[](#getting-information-about-your-account)

You will find all the information about your OxiMailing account with the "**UserAPI**" object. Informations returned are documented in the class.

```
require_once "vendor/autoload.php";
use Oxemis\OxiMailing\OxiMailingClient;

$client = new OxiMailingClient(API_LOGIN,API_PWD);
$user = $client->userAPI->getUser();

echo "Name :" . $user->getCompanyName() . "\n" .
     "Remaining credits : " . $user->getCredits() . "\n";
```

Sending your first email
------------------------

[](#sending-your-first-email)

In order to send a mail, you must instantiate a `Message` object and, send it, via the `$client->sendAPI->Send()` method.

> **PLEASE NOTE**
>
> Before sending any message you **MUST** register your sender email address on your account (or using the `$client->sendersAPI` object). Validated senders can be managed on [this page](https://account.oxemis.com/oximailing?senders). If your address is not validated, sending will be refused.

You can add attachments, recipients, CC, Reply-To, BCC and many other options with the `Message` properties. Every property of the `Message` object is described with PHPDoc.

Here's a simple sample of how to send a mail (**be careful and change the email addresses of the sender and recipients of this example!**):

```
require_once 'vendor/autoload.php';
use Oxemis\OxiMailing\OxiMailingClient;
use Oxemis\OxiMailing\Objects\Message;

// Create the Client
$apilogin = 'your API login';
$apipwd = 'your API password';
$client = new OxiMailingClient($apilogin, $apipwd);

// Define the message
// TODO : be careful and change the email addresses of the sender and recipients of this example!
$mail = new Message();
$mail
->addRecipientEmail("joe@example.com")
->addRecipientEmail("jane@example.com")
->setSender("support@example.com")
->setSenderName("Your name")
->setSubject("Hello world !")
->setHtmlMessage("Hi there ! This is my first email sent with the awesome oximailing-php library !");

// Send the message
$client->sendAPI->send($mail);
```

> With this sample, OxiMailing will send **2 emails**, one to **** and another one to ****. Joe will not see Jane and vice versa !

You can also **schedule a sending** by using the `$mail->setScheduledDateTime($selectedDateAndTime)` method.

How to send customized messages?
--------------------------------

[](#how-to-send-customized-messages)

With this library you can send customized messages based on templating. Basically, every content between `{{` and `}}` will be replaced by the corresponding **recipient metadata**.

Here is a simple sample :

```
require_once 'vendor/autoload.php';
use Oxemis\OxiMailing\Objects\Recipient;
use Oxemis\OxiMailing\Objects\Message;
use Oxemis\OxiMailing\OxiMailingClient;

// First of all we need recipients with meta data
$myFirstRecipient = new Recipient();
$myFirstRecipient->setEmail("joe@example.com");
$myFirstRecipient->setMetaData(["Name" => "Joe", "ID" => 1]);

$mySecondRecipient = new Recipient();
$mySecondRecipient->setEmail("jane@example.com");
$mySecondRecipient->setMetaData(["Name" => "Jane", "ID" => 2]);

// We create the message with {{custom parts}}
// TODO : be careful and change the email addresses of the sender and recipients of this example!
$mail = new Message();
$mail->addRecipient($myFirstRecipient)
->addRecipient($mySecondRecipient)
->setSender("support@example.com")
->setSenderName("Your name")
->setSubject("Hello {{Name}} !")
->setHtmlMessage("Hi {{Name}} ! This is your ID : {{ID}}");

// Then we send the two messages in one call !
$client = new OxiMailingClient(API_LOGIN, API_PWD);
$client->sendAPI->send($mail);
```

Tracking a message
------------------

[](#tracking-a-message)

With OxiMailing you'll be able to track events recorded on your emails. To enable tracking you must use the `setTrackEmails = true` option of the message and get events using the `$client->trackingAPI` object.

Here is a simple sample. First send a tracked message :

```
require_once 'vendor/autoload.php';
use Oxemis\OxiMailing\Objects\Message;

// Define the message
// TODO : be careful and change the email addresses of the sender and recipients of this example!
$mail = new Message();
$mail
->addRecipientEmail("joe@example.com")
->addRecipientEmail("jane@example.com")
->setSender("support@example.com")
->setSenderName("Your name")
->setSubject("Hello world !")
->setHtmlMessage("Hi there ! This is my first email sent with the awesome oximailing-php library !")
->setTrackEmails(true);
```

Then send the message and get the SendingId in return :

```
require_once 'vendor/autoload.php';
use Oxemis\OxiMailing\OxiMailingClient;

// Create the client
$client = new OxiMailingClient(API_LOGIN,API_PWD);

// Send the message
$sending = $client->sendAPI->send($mail);

// Store the sending id somewhere
$sid = $sending->getSendingId();
```

After that, you'll be able to get events recorded on this message with the tracking API :

```
require_once 'vendor/autoload.php';
use Oxemis\OxiMailing\Objects\Event;
use Oxemis\OxiMailing\OxiMailingClient;

// Create the client
$client = new OxiMailingClient(API_LOGIN,API_PWD);

// Will return an array of events (or null if none)
// You can filter on many things, here we use the Sending Id
$events = $client->trackingAPI->getEvents(Event::EVENT_TYPE_CLICK, null, null, null, $sid);
```

Other features
--------------

[](#other-features)

You'll find a lot of other features by exploring the `*API` objects in the APIClient. Here is a non-exhaustive list of these objects (each one is documented with PHPDoc).

- `blacklistsAPI` : get / set your blacklists (lists of unsubscribed recipients)
- `bouncesAPI` : get / set your bounces (list of invalid addresses)
- `complaintsAPI` : get the list of spam complaints received on your account
- `domainsAPI` : manage your domains used in OxiMailing
- `sendAPI` : send now or schedule your messages
- `sendersAPI` : add or remove senders on your account
- `trackingAPI` : everything related about tracking (statistics on your messages)
- `userAPI` : everything about your account

Each object is documented with PHPDoc. Other features will be added in the future. You can also make direct call to the API (and even contribute to this project !). Please take a look at the [API Reference](https://api.oximailing.com) 😀

Contribute
----------

[](#contribute)

Feel free to ask anything, and contribute to this project. Need help ? 👉

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance43

Moderate activity, may be stable

Popularity21

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 94.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~102 days

Total

4

Last Release

453d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ddb5ecce29e61a4d9664d7d2f27caebc2c504560a6a8d2007299001cd8d5a3d5?d=identicon)[oxemis](/maintainers/oxemis)

---

Top Contributors

[![laudep59](https://avatars.githubusercontent.com/u/98906510?v=4)](https://github.com/laudep59 "laudep59 (16 commits)")[![damienDevOX](https://avatars.githubusercontent.com/u/83002710?v=4)](https://github.com/damienDevOX "damienDevOX (1 commits)")

### Embed Badge

![Health badge](/badges/oxemis-oximailing/health.svg)

```
[![Health](https://phpackages.com/badges/oxemis-oximailing/health.svg)](https://phpackages.com/packages/oxemis-oximailing)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)