https://github.com/laravel-notification-channels/apn
APN push notifications channel for Laravel
https://github.com/laravel-notification-channels/apn
Last synced: about 1 month ago
JSON representation
APN push notifications channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/apn
- Owner: laravel-notification-channels
- License: mit
- Created: 2016-08-24T09:12:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-16T22:26:57.000Z (4 months ago)
- Last Synced: 2025-04-06T22:01:50.230Z (3 months ago)
- Language: PHP
- Homepage: http://laravel-notification-channels.com
- Size: 213 KB
- Stars: 191
- Watchers: 8
- Forks: 58
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Laravel APN (Apple Push) Notification Channel
[](https://packagist.org/packages/laravel-notification-channels/apn)
[](LICENSE.md)
[](https://travis-ci.org/laravel-notification-channels/apn)
[](https://github.styleci.io/repos/66449499)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/apn)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/apn/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/apn)
This package makes it easy to send notifications using Apple Push (APN) with Laravel.
## Contents
- [Installation](#installation)
- [Usage](#usage)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
Install this package with Composer:
composer require laravel-notification-channels/apn
### Setting up the APN service
Before using the APN Service, [enable Push Notifications in your app](https://help.apple.com/xcode/mac/current/#/devdfd3d04a1). Then [create a APNS key under Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/authkeys/list) to generate a Key ID and .p8 file.
Collect your Key ID, as well as your Team ID (displayed at the top right of the Apple Developer page) and app bundle ID and configure as necessary in `config/broadcasting.php`.
## JWT Token Authentication
```php
'connections' => [
'apn' => [
'key_id' => env('APN_KEY_ID'),
'team_id' => env('APN_TEAM_ID'),
'app_bundle_id' => env('APN_BUNDLE_ID'),
// Enable either `private_key_path` or `private_key_content` depending on your environment
// 'private_key_path' => env('APN_PRIVATE_KEY'),
'private_key_content' => env('APN_PRIVATE_KEY'),
'private_key_secret' => env('APN_PRIVATE_SECRET'),
'production' => env('APN_PRODUCTION', true),
],
],
```
See the [Establishing a token-based connection to APNs](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns) which will guide you how to obtain the values of the necessary parameters.
## Using Certificate (.pem) Authentication
```php
'connections' => [
'apn' => [
'app_bundle_id' => env('APN_BUNDLE_ID'),
'certificate_path' => env('APN_CERTIFICATE_PATH'),
'certificate_secret' => env('APN_CERTIFICATE_SECRET'),
'production' => env('APN_PRODUCTION', true),
],
],
```
If you are connecting with certificate based APNs, `key_id` and `team_id` are not needed. You can refer to [Send a Push Notification Using a Certificate](https://developer.apple.com/documentation/usernotifications/sending_push_notifications_using_command-line_tools#3694578)
See the [Establishing a certificate-based connection to APNs](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns) which will guide you how to obtain the values of the necessary parameters.
See the [`pushok` docs](https://github.com/edamov/pushok) for more information about what arguments can be supplied to the client.
## Usage
You can now send messages to APN by creating a ApnMessage:
```php
use NotificationChannels\Apn\ApnChannel;
use NotificationChannels\Apn\ApnMessage;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [ApnChannel::class];
}
public function toApn($notifiable)
{
return ApnMessage::create()
->badge(1)
->title('Account approved')
->body("Your {$notifiable->service} account was approved!");
}
}
```
To see more of the methods available to you when creating a message please see the [`ApnMessage` source](https://github.com/laravel-notification-channels/apn/blob/master/src/ApnMessage.php).
In your `notifiable` model, make sure to include a `routeNotificationForApn()` method, which return one or an array of tokens.
```php
public function routeNotificationForApn()
{
return $this->apn_token;
}
```
### Per-message configuration
If you need to provide a custom configuration for a message you can provide an instance of a [Pushok](https://github.com/edamov/pushok) client and it will be used instead of the default one.
```php
$customClient = new Pushok\Client(Pushok\AuthProvider\Token::create($options));
return ApnMessage::create()
->title('Account approved')
->body("Your {$notifiable->service} account was approved!")
->via($customClient)
```
### VoIP push notifications
Sending VoIP push notifications is very similar. You just need to use the `ApnVoipChannel` channel with `ApnVoipMessage` (which has the same API as a regular `ApnMessage`).
```php
use NotificationChannels\Apn\ApnVoipChannel;
use NotificationChannels\Apn\ApnVoipMessage;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [ApnVoipChannel::class];
}
public function toApnVoip($notifiable)
{
return ApnVoipMessage::create()
->badge(1);
}
}
```
In your `notifiable` model, make sure to include a `routeNotificationForApnVoip()` method, which return one or an array of tokens.
```php
public function routeNotificationForApnVoip()
{
return $this->apn_voip_token;
}
```
## 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
- [Fruitcake](https://github.com/fruitcake)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.