Download the PHP package oxemis/oximailing without Composer

On this page you can find all versions of the php package oxemis/oximailing. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of oxemis/oximailing

Informations about the package oximailing

Official OxiMailing PHP Wrapper

MIT License Current Version

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

This library is a wrapper for the OxiMailing API but you don't have to know how to use the API to get started with this library.

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

Compatibility

This library requires PHP v7.4 or higher.

Installation

Use the below code to install the wrapper:

composer require oxemis/oximailing

Authentication

This library is a wrapper to the OxiMailing API. You can request an API KEY in your OxiMailing Account. Free credits are offered.

You should export your API_LOGIN and API_PASSWORD in order to use them in this library :

Initialize your OxiMailing Client:

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.

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. 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!):

With this sample, OxiMailing will send 2 emails, one to [email protected] and another one to [email protected]. 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?

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 :

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 :

Then send the message and get the SendingId in return :

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

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).

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 😀

Contribute

Feel free to ask anything, and contribute to this project. Need help ? 👉 [email protected]

All versions of oximailing with dependencies

PHP Build Version
Package Version
Requires guzzlehttp/guzzle Version ^7.8
ext-json Version *
ext-fileinfo Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package oxemis/oximailing contains the following files

Loading the files please wait ...