PHPackages                             omarpre/paubox - 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. omarpre/paubox

ActiveLibrary

omarpre/paubox
==============

A PHP package for the Paubox Transactional Email API (Fork of original paubox-php SDK)

v4.0.0(2y ago)03.1k↓46.7%3Apache-2.0PHPPHP ^7.3 || ^8.1

Since Jul 27Pushed 2y ago1 watchersCompare

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

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

#### This is fork of Paubox php SDK, to make it compatible with Laravel version 9

[](#this-is-fork-of-paubox-php-sdk-to-make-it-compatible-with-laravel-version-9)

---

[![Paubox](https://avatars.githubusercontent.com/u/22528478?s=200&v=4)](https://avatars.githubusercontent.com/u/22528478?s=200&v=4)

Paubox PHP
==========

[](#paubox-php)

This is the official PHP wrapper for the [Paubox Email API](https://www.paubox.com/solutions/email-api).

The Paubox Email API allows your application to send secure, HIPAA compliant email via Paubox and track deliveries and opens. The API wrapper also allows you to construct and send messages.

Table of Contents
=================

[](#table-of-contents)

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

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

[](#installation)

Using composer:

```
$ composer require omarpre/paubox
```

### Getting Paubox API Credentials

[](#getting-paubox-api-credentials)

You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).

Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.

### Configuring API Credentials

[](#configuring-api-credentials)

Include your API credentials in your environment file.

```
$ echo "export PAUBOX_API_KEY='YOUR_API_KEY'" > .env
$ echo "export PAUBOX_API_USER='YOUR_ENDPOINT_NAME'" >> .env
$ source .env
$ echo ".env" >> .gitignore
```

Usage
-----

[](#usage)

To send email, prepare a Message object and call the sendMessage method of Paubox.

### Sending messages

[](#sending-messages)

```