postal / postal
Postal for PHP library.
Installs: 187 147
Dependents: 13
Suggesters: 0
Security: 0
Stars: 65
Watchers: 7
Forks: 26
Open Issues: 5
Requires
- php: ^7.4 || ^8.0
- guzzlehttp/guzzle: ^6 || ^7
Requires (Dev)
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^9.6
- symplify/easy-coding-standard: ^11.3
This package is not auto-updated.
Last update: 2024-10-29 13:40:35 UTC
README
This library helps you send e-mails through Postal in PHP 7.4 and above.
Installation
Install the library using Composer:
$ composer require postal/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 Postal client using the server key you generate in the web interface $client = new Postal\Client('https://postal.yourdomain.com', 'your-api-key'); // Create a new message $message = new Postal\Send\Message(); // Add some recipients $message->to('john@example.com'); $message->to('mary@example.com'); $message->cc('mike@example.com'); $message->bcc('secret@awesomeapp.com'); // Specify who the message should be from. This must be from a verified domain // on your mail server. $message->from('test@test.postal.io'); // 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!'); // Send the message and get the result $result = $client->send->message($message); // 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; // The message ID $message->token; // The message's token }