README

Laravel Brevo

This package is a wrapper for Brevo's API v3 PHP library.

Tested with PHP versions 8.1, 8.2, 8.3, and 8.4 on Laravel 10, Laravel 11, and Laravel 12.

Installation

You can install the package via Composer:

composer require hofmannsven/laravel-brevo

Publish the config files

Publish package config files:

php artisan vendor:publish --provider="Hofmannsven\Brevo\BrevoServiceProvider"

Set the API Key

In your .env file, add your Brevo API key:

BREVO_API_KEY=xxx

Usage

use Hofmannsven\Brevo\Facades\Brevo;

// Account
$result = Brevo::AccountApi()->getAccount();
var_dump($result);

// Domains
$result = Brevo::DomainsApi()->getDomains();
var_dump($result);

// Contacts
$result = Brevo::ContactsApi()->getContacts();
var_dump($result);

// With custom client
$result = Brevo::AccountApi(
    new \GuzzleHttp\Client()
)->getAccount();

Available APIs

Use any getbrevo/brevo-php API (see supported functions):

• AccountApi
• AttributesApi
• CompaniesApi
• ContactsApi
• ConversationsApi
• CouponsApi
• CRMApi
• DealsApi
• DomainsApi
• EcommerceApi
• EmailCampaignsApi
• EventsApi
• ExternalFeedsApi
• FilesApi
• FoldersApi
• InboundParsingApi
• ListsApi
• MasterAccountApi
• NotesApi
• ProcessApi
• ResellerApi
• SendersApi
• SMSCampaignsApi
• TasksApi
• TransactionalEmailsApi
• TransactionalSMSApi
• TransactionalWhatsAppApi
• UserApi
• WebhooksApi
• WhatsAppCampaignsApi

Development

Code Style Fixer

composer format

Testing

composer test

Changelog

Please read the changelog for more information about recent changes.

Contributing

Please read the contribution guidelines for details.

Support

Always feel free to raise an issue on GitHub.

Security

If you discover a security issue, please contact me directly. My GPG fingerprint/key is available on Keybase.

Credits

• Sven Hofmann
• All Contributors

License

MIT License (MIT). Please read the license for more information.

^{_{Laravel and the Laravel logo are trademarks of Taylor Otwell. Banner image generated with banners.beyondco.de}}