atellitech/postal

Postal for PHP library.

1.0.1 2023-01-27 12:57 UTC

Requires

• php: >=8.0
• rmccue/requests: ^2.0

Requires (Dev)

• phpstan/phpstan: ^1.9

MIT

• Eric Huang

• mail
• postal

README

This library is forked by postalserver/postal-php, it helps you send e-mails through Postal in PHP 8.0 and above.

Installation

Install the library using Composer:

$ composer require atellitech/postal

Usage

Sending an email is very simple. Just follow the example below. Before you can begin, you'll need to login to our web interface and generate a new API credential.

// Create a new message
$message = new AtelliTech\Postal\SendMessage;

// Add some recipients
$message->to('[e-mail]');
$message->to('[e-mail]');
$message->cc('[e-mail]');
$message->bcc('[e-mail]');

// Specify who the message should be from. This must be from a verified domain
// on your mail server.
$message->from('[e-mail]');

// Set the subject
$message->subject('Hi there!');

// Set the content for the e-mail
$message->plainBody('Hello world!');
$message->htmlBody('<p>Hello world!</p>');

// Add any custom headers
$message->header('X-PHP-Test', 'value');

// Attach any files
$message->attach('textmessage.txt', 'text/plain', 'Hello world!');

// Create a new Postal client using the server key you generate in the web interface
$client = new AtelliTech\Postal\Client('https://postal.yourdomain.com', 'your-api-key');

// Send the message and get the result
$result = $message->send($client);

// Loop through each of the recipients to get the message ID
foreach ($result->recipients() as $email => $message) {
    $email;            // The e-mail address of the recipient
    $message->id();    // Returns the message ID
    $message->token(); // Returns the message's token
}