Download the PHP package omarpre/paubox without Composer
On this page you can find all versions of the php package omarpre/paubox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download omarpre/paubox
More information about omarpre/paubox
Files in omarpre/paubox
Package paubox
Short Description A PHP package for the Paubox Transactional Email API (Fork of original paubox-php SDK)
License Apache-2.0
Homepage https://github.com/omarpre/paubox
Informations about the package paubox
This is fork of Paubox php SDK, to make it compatible with Laravel version 9
Paubox PHP
This is the official PHP wrapper for the Paubox 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
- Installation
- Usage
- Contributing
- License
Installation
Using composer:
Getting Paubox API Credentials
You will need to have a Paubox account. You can sign up here.
Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
Configuring API Credentials
Include your API credentials in your environment file.
Usage
To send email, prepare a Message object and call the sendMessage method of Paubox.
Sending messages
Allowing non-TLS message delivery
If you want to send non-PHI mail that does not need to be HIPAA-compliant, you can allow the message delivery to take place even if a TLS connection is unavailable.
This means the message will not be converted into a secure portal message when a non-TLS connection is encountered. To allow a non-TLS message delivery, call the setAllowNonTLS(true)
method on the message object.
Forcing Secure Notifications
Paubox Secure Notifications allow an extra layer of security, especially when coupled with an organization's requirement for message recipients to use 2-factor authentication to read messages (this setting is available to org administrators in the Paubox Admin Panel).
Instead of receiving an email with the message contents, the recipient will receive a notification email that they have a new message in Paubox.
Adding Attachments and Additional Headers
Checking Email Dispositions
The SOURCE_TRACKING_ID of a message is returned in the response of the sendMessage method. To check the status for any email, use its source tracking id and call the getEmailDisposition method of Paubox:
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/omarpre/paubox.
License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright
Copyright © 2021, Paubox, Inc.