socketlabs/email-delivery

SocketLabs Email Delivery PHP Client Library

Maintainers

Details

github.com/socketlabs/socketlabs-php

Homepage

Source

Issues

Installs: 22 804

Dependents: 1

Suggesters: 0

Security: 0

Stars: 9

Watchers: 13

Forks: 10

Open Issues: 2

1.4.5 2023-12-11 14:23 UTC

Requires

  • php: >=5.6

MIT abb703b42772cba31a8083155a0fcc10198c120d

emailsocketlabsdeliverabilitytransactional-email

This package is not auto-updated.

Last update: 2024-04-15 16:14:39 UTC

README

SocketLabs

Twitter Follow MIT licensed PRs Welcome

The SocketLabs Email Delivery PHP library allows you to easily send email messages via the SocketLabs Injection API. The library makes it easy to build and send any type of message supported by the API, from a simple message to a single recipient all the way to a complex bulk message sent to a group of recipients with unique merge data per recipient.

Table of Contents

Prerequisites and Installation

Prerequisites

Installation

For most uses we recommend installing the socketlabs/email-delivery package via Composer. If you have Composer installed already, you can add the latest version of the package with the following command:

composer require socketlabs/email-delivery

Alternately, you can simply clone this repository directly to include the source code in your project. Be sure to reference the following includes for your convenience: includes.php.

Getting Started

Obtaining your API Key and SocketLabs ServerId number

In order to get started, you'll need to enable the Injection API feature in the SocketLabs Control Panel. Once logged in, navigate to your SocketLabs server's dashboard (if you only have one server on your account you'll be taken here immediately after logging in). Make note of your 4 or 5 digit ServerId number, as you'll need this along with your API key in order to use the Injection API.

To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option. Once here, you can enable the feature by choosing the "Enabled" option in the dropdown. Enabling the feature will also generate your API key, which you'll need (along with your ServerId) to start using the API. Be sure to click the "Update" button to save your changes once you are finished.

Basic Message

A basic message is an email message like you'd send from a personal email client such as Outlook. A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses. You can also send a file attachment in a basic message.

include_once ("./socketlabs-php/InjectionApi/src/includes.php");
//or if using composer: include_once ('./vendor/autoload.php');

use Socketlabs\SocketLabsClient;
use Socketlabs\Message\BasicMessage;
use Socketlabs\Message\EmailAddress;

$client = new SocketLabsClient(000001, "YOUR-API-KEY"); //Your SocketLabs ServerId and Injection API key

$message = new BasicMessage();

$message->subject = "Sending A Basic Message";
$message->htmlBody = "<html>This is the Html Body of my message.</html>";
$message->plainTextBody = "This is the Plain Text Body of my message.";

$message->from = new EmailAddress("from@example.com");
$message->replyTo = new EmailAddress("replyto@example.com");

//A basic message supports up to 50 recipients and supports several different ways to add recipients
$message->addToAddress("recipient1@example.com"); //Add a To address by passing the email address
$message->addCcAddress("recipient2@example.com", "Recipient #2"); //Add a CC address by passing the email address and a friendly name
$message->addBccAddress(new EmailAddress("recipient3@example.com")); //Add a BCC address by passing an EmailAddress object

$response = $client->send($message);

Bulk Message

A bulk message usually contains a single recipient per message and is generally used to send the same content to many recipients, optionally customizing the message via the use of MergeData. For more information about using Merge data, please see the Injection API documentation.

include_once ("./socketlabs-php/InjectionApi/src/includes.php");
//or if using composer: include_once ('./vendor/autoload.php');

use Socketlabs\Message\BulkMessage;
use Socketlabs\Message\BulkRecipient;
use Socketlabs\Message\EmailAddress;
use Socketlabs\SocketLabsClient;

$client = new SocketLabsClient(000001, "YOUR-API-KEY"); //Your SocketLabs ServerId and Injection API key

//Build the message
$message = new BulkMessage();
$message->subject = "Sending A Bulk Message";
$message->htmlBody = "<html>This is the Html Body of my message sent to the recipient with %%EyeColor%% eyes.</html>";
$message->plainTextBody = "This is the Plain Text Body of my message sent to the recipient with %%EyeColor%% eyes.";
$message->from = new EmailAddress("from@example.com");
$message->replyTo = new EmailAddress("replyto@example.com");

//Add Bulk Recipients
$recipient1 = $message->addToAddress("recipient1@example.com", "Recipient #1");
$recipient1->addMergeData("EyeColor", "Green");

$recipient2 = $message->addToAddress("recipient2@example.com", "Recipient #2");
$recipient2->addMergeData("EyeColor", "Blue");


//Create the client and send the message
$response = $client->send($message);

Managing API Keys

For ease of demonstration, many of our examples include the ServerId and API key directly in our code sample. Generally it is not considered a good practice to store sensitive information like this directly in your code.

Examples and Use Cases

In order to demonstrate the many possible use cases for the SDK, we've provided an assortment of code examples. These examples demonstrate many different features available to the Injection API and SDK, including using templates created in the SocketLabs Email Designer, custom email headers, sending attachments, sending content that is stored in an HTML file, advanced bulk merging, and even pulling recipients from a datasource.

Basic send example

This example demonstrates a Basic Send.

Basic send complex example

This example demonstrates many features of the Basic Send, including adding multiple recipients, adding message and mailing id's, and adding an embedded image.

Basic send from HTML file

This example demonstrates how to read in your HTML content from an HTML file rather than passing in a string directly.

Basic send from SocketLabs API Template

This example demonstrates the sending of a piece of content that was created in the SocketLabs Email Designer. This is also known as the API Templates feature.

Basic send with specified character set

This example demonstrates sending with a specific character set.

Basic send with file attachment

This example demonstrates how to add a file attachment to your message.

Basic send with custom email headers

This example demonstrates how to add custom headers to your email message.

Basic send with embedded image

This example demonstrates how to embed an image in your message.

Basic send with a web proxy

This example demonstrates how to use a proxy with your HTTP client.

Basic send with retry enabled

This example demonstrates how to use the retry logic with your HTTP client.

Basic send with Amp

This example demonstrates how to send a basic message with an AMP Html body. For more information about AMP please see AMP Project

Basic send with invalid file attachment

This example demonstrates the results of attempting to do a send with an invalid attachment.

Basic send with invalid from address

This example demonstrates the results of attempting to do a send with an invalid from address.

Basic send with invalid recipients

This example demonstrates the results of attempting to do a send with invalid recipients.

Bulk send with multiple recipients

This example demonstrates how to send a bulk message to multiple recipients.

Bulk send with complex merge including attachments

This example demonstrates many features of the BulkMessage(), including adding multiple recipients, merge data, and adding an attachment.

Bulk send with recipients pulled from a datasource

This example uses a mock repository class to demonstrate how you would pull your recipients from a database and create a bulk mailing with merge data.

Bulk send with Ascii charset and special characters

This example demonstrates how to send a bulk message with a specified character set and special characters.

Bulk send with merge data

This example demonstrates how to send a bulk message to multiple recipients with unique merge data per recipient.

Bulk send with Amp

This example demonstrates how to send a bulk message with an AMP Html body. For more information about AMP please see AMP Project

Version

  • 1.4.5 - Adding error handling on RetryHandler
  • 1.4.4 - Removed Debugging Code
  • 1.4.3 - Added MetadataOrTagsAreTooLarge error messsage
  • 1.4.2 - Adding API Key Authorization
  • 1.4.0 - Adding Metadata and Tags
  • 1.2.1 - Adding optional retry logic for Http requests. If configured, the request will retry when certain 500 errors occur (500, 502, 503, 504)
  • 1.1.2 - Add support of PHP 8.0
  • 1.1.1 - Adding request timeout value on the client for Http requests
  • 1.1.0 - Adds Amp Html Support
  • 1.0.0 - Initial Release

License

The SocketLabs.EmailDelivery library and all associated code, including any code samples, are MIT Licensed.