https://github.com/laravel-notification-channels/lob
lob.com notifications channel for Laravel
https://github.com/laravel-notification-channels/lob
Last synced: 2 months ago
JSON representation
lob.com notifications channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/lob
- Owner: laravel-notification-channels
- License: mit
- Created: 2016-08-14T09:48:22.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-10-25T06:13:32.000Z (over 4 years ago)
- Last Synced: 2025-03-29T03:32:14.606Z (3 months ago)
- Language: PHP
- Homepage: http://laravel-notification-channels.com
- Size: 34.2 KB
- Stars: 11
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Lob.com notifications channel for Laravel
[](https://packagist.org/packages/laravel-notification-channels/lob)
[](LICENSE.md)
[](https://travis-ci.org/laravel-notification-channels/lob)
[](https://styleci.io/repos/65659860)
[](https://insight.sensiolabs.com/projects/d6b5e386-7830-4623-afd4-2ee6a6eb65a1)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/lob)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/lob/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/lob)
This package makes it easy to send notifications using [Lob.com](https://lob.com/) with Laravel 5.5, 6.x and 7.x
## Contents
- [Installation](#installation)
- [Setting up the lob.com](#setting-up-lob)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
``` bash
composer require laravel-notification-channels/lob
```
You must install the service provider:
```php
// config/app.php
'providers' => [
...
NotificationChannels\Lob\LobServiceProvider::class,
],
```
### Setting up lob
- Register a new account on [Lob.com](https://lob.com)
- Check for [you API keys](https://dashboard.lob.com/#/settings/keys)
- Finally add your API key to your `config/services.php`
```php
// config/services.php
...
'lob' => [
'api_key' => env('LOB_API_KEY'),
],
...
```
## Usage
Now you can use the channel in your `via()` method inside the notification:
```php
use NotificationChannels\Lob\LobChannel;
use NotificationChannels\Lob\LobPostcard;
use NotificationChannels\Lob\LobAddress;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [LobChannel::class];
}
public function toLobPostcard($notifiable)
{
return LobPostcard::create()
->toAddress(
LobAddress::create('300 BOYLSTON AVE E')
->name('John Smith')
->city('SEATTLE')
->state('WA')
->zip('98002');
)
->front('https://path.to/my/image/postcardfront.png')
->message('Wishing you a wonderful weekend!');
}
}
```
### Available Postcard methods
- `fromAddress()` Address of the sender.
- `toAddress()` Address of the receiver.
- `country()` Set the country. `US` is default.
- `city()` required if country is `US`.
- `state()` required if country is `US`.
- `zip()` required if country is `US`.
- `front()` A 4.25"x6.25" or 6.25"x11.25" image to use as the front of the postcard.
- `message()` The message at the back of the card.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Mohamed Said](https://github.com/themsaid)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.