sendernet/sender-transactional-php

Sendernet transactional email php API client

dev-master 2025-10-30 15:45 UTC

Requires

• php: ^8.2
• ext-json: *
• beberlei/assert: ^3.2
• php-http/client-common: ^2.2
• php-http/discovery: ^1.9
• php-http/httplug: ^2.1
• psr/http-client-implementation: ^1.0
• psr/http-message: ^1.0 || ^2.0
• symfony/options-resolver: ^6.0 || ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• guzzlehttp/psr7: ^2.0
• http-interop/http-factory-guzzle: ^1.0
• mockery/mockery: ^1.6
• orchestra/testbench: ^9.0 || ^10.0
• php-http/guzzle7-adapter: ^1.0
• php-http/message: ^1.0
• php-http/mock-client: ^1.0
• phpunit/phpunit: ^10.0 || ^11.0 || ^12.0

Suggests

• illuminate/mail: Required for Laravel integration (^10.0 || ^11.0 || ^12.0)
• illuminate/support: Required for Laravel integration (^10.0 || ^11.0 || ^12.0)

MIT

• Sender Team

• transactional
• emails
• email-api
• sendernet

README

A modern PHP client for Sender.net transactional email API. The SDK provides a fluent builder for email payloads, consistent exception types, and first-class Laravel transport integration.

Table of Contents

• Requirements
• Installation
• Quick Start
• Email Features
• Error Handling
• Laravel Integration
• Testing
• License

Requirements

• PHP 8.1 or newer
• PSR-18 HTTP client implementation (e.g. php-http/guzzle7-adapter)
• PSR-17 request & stream factories (e.g. nyholm/psr7)
• SenderNet API key

Installation

Install the recommended HTTP client and factories:

composer require php-http/guzzle7-adapter nyholm/psr7

Install the SDK:

composer require sendernet/sender-transactional-php

Quick Start

use SenderNet\SenderNet;
use SenderNet\Helpers\Builder\EmailParams;
use SenderNet\Helpers\Builder\Recipient;

$sender = new SenderNet(['api_key' => getenv('SENDER_API_KEY')]);

$emailParams = (new EmailParams())
    ->setFrom('[e-mail]')
    ->setFromName('Example App')
    ->setRecipients([new Recipient('[e-mail]', 'User')])
    ->setSubject('Welcome')
    ->setText('Thanks for signing up\!');

$response = $sender->email->send($emailParams);

Additional recipes are available in GUIDE.md.

Email Features

• Single primary recipient enforced by validation (setRecipients() must receive exactly one entry).
• Content options for HTML, text and custom headers.
• Attachments using setAttachments().

Error Handling

• All HTTP failures raise subclasses of SenderNet\Exceptions\SenderNetRequestException exposing the original PSR-7 request and response.
• Validation problems surface as SenderNetValidationException, which provides:
  • getErrors() for the raw payload array.
  • getErrorMessages() for formatted strings (e.g. field: message).
  • getFirstError() for the first human-readable issue.
• Rate limiting throws SenderNetRateLimitException including Retry-After metadata.

Laravel Integration

The package provides a Laravel mail transport so you can send messages using the familiar Mail facade.

1. Install the SDK (auto-discovery registers SenderServiceProvider).

2. Run the installer for guided setup:

   php artisan sender:install

3. Configure environment variables:

   SENDER_API_KEY=your_api_key
   MAIL_MAILER=sender

4. Use Laravel's mailing features as usual. Any SenderNetRequestException raised by the SDK is converted into Symfony\Component\Mailer\Exception\TransportException with the original message preserved.

Testing

composer exec phpunit

License

Released under the MIT License.