Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micovi/laravel-sendy
Service provider for Sendy API in PHP Laravel 5+
https://github.com/micovi/laravel-sendy
laravel laravel-framework php sendy
Last synced: 4 days ago
JSON representation
Service provider for Sendy API in PHP Laravel 5+
- Host: GitHub
- URL: https://github.com/micovi/laravel-sendy
- Owner: micovi
- License: mit
- Created: 2019-03-10T11:51:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:30:32.000Z (about 1 year ago)
- Last Synced: 2024-11-15T08:16:15.533Z (about 1 month ago)
- Topics: laravel, laravel-framework, php, sendy
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Sendy
[](https://github.com/micovi/laravel-sendy/)
[](https://packagist.org/packages/micovi/laravel-sendy)
[](https://packagist.org/packages/micovi/laravel-sendy)
Package description: Laravel simple integration with Sendy API to subscribe/unsubscribe users to list.
## Installation
Install via composer
```bash
composer require micovi/laravel-sendy
```
### Register Service Provider
**Note! This step is optional if you use laravel >= 5.5
with package auto discovery feature.**
Add service provider to `config/app.php` in `providers` section
```php
Micovi\LaravelSendy\ServiceProvider::class,
```
### Register Facade
Register package facade in `config/app.php` in `aliases` section
```php
'LaravelSendy' => Micovi\LaravelSendy\Facades\LaravelSendy::class,
```
### Add env variables
```env
SENDY_API_KEY=your-api-key
SENDY_URL=your-sendy-url
SENDY_LIST_ID=your-list-id
```
LIST ID can be found encrypted & hashed in View all lists section under the column named ID
## Customizing or extending
### Publish configuration file
You can publish configuration file to edit the variables, in case you don't want to use ENV. File will pe published in `/config/larave-sendy.php`
```bash
php artisan vendor:publish --provider="Micovi\LaravelSendy\ServiceProvider" --tag="config"
```
### Publish translations
You can publish translations to edit them. Files will be published in `/resources/lang/vendor/laravel-sendy`.
**Note:** You can extend translations by creating a new file in `/resources/lang/vendor/laravel-sendy/{lang}/messages.php` using the format from `en` language file.
## Usage examples
Before any usage add Namespace to file.
```php
use Micovi\LaravelSendy\LaravelSendy;
```
### Subscribe
Subscribes a new email to list. This can be used to edit already subscribed users. (eg. change name)
```php
// initialize LaravelSendy
$sendy = new LaravelSendy();
// Simple email subscribe
$subscribe = $sendy->subscribe('[email protected]');
// Add subscriber with email and name
$subscribe = $sendy->subscribe('[email protected]', 'John Doe');
// Full subscribe method
$subscribe = $sendy->subscribe($email, $name = null, $listId = null, $json = false, $customFields = []);
// Response example
$subscribe = [
"success" => true
"message" => "You have been subscribed."
]
```
### Unsubscribe Examples
Marks email as unsubscribed from the list.
```php
// initialize LaravelSendy
$sendy = new LaravelSendy();
// Simple unsubscribe
$unsubscribe = $sendy->unsubscribe('[email protected]');
// Full unsubscribe method
$unsubscribe = $sendy->unsubscribe($email, $listId = null, $json = false);
// Response example
$unsubscribe = [
"success" => true
"message" => "You have been unsubscribed."
]
```
### Delete Example
Deletes email from list. Action is definitive.
```php
// initialize LaravelSendy
$sendy = new LaravelSendy();
// Simple delete
$delete = $sendy->delete('[email protected]');
// Full unsubscribe method
$delete = $sendy->delete($email, $listId = null, $json = false);
// Response example
$delete = [
"success" => true
"message" => "You have been deleted from the list."
]
```
## Security
If you discover any security related issues, please email
instead of using the issue tracker.
## Contribute
If you wish to contribute to translations for the package in your language you can submit a PR request with the lang files copied from en `resources/lang/en/messages.php`.