> For the complete documentation index, see [llms.txt](https://pratikdai404.gitbook.io/adminetic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pratikdai404.gitbook.io/adminetic/addons/newsletter.md).
# Newsletter
## Newsletter Module for Adminetic Admin Panel
[](https://packagist.org/packages/adminetic/newsletter)
[](https://github.com/pratiksh404/adminetic-newsletter/stargazers) [](https://packagist.org/packages/adminetic/newsletter) [](https://github.styleci.io/repos/385822775?branch=main) [](https://pratikdai404.gitbook.io/adminetic/addons/packagist.org/packages/adminetic/newsletter)
Newsletter module for Adminetic Admin Panel
For detailed documentation visit [Adminetic Newsletter Module Documentation](https://app.gitbook.com/@pratikdai404/s/adminetic/addons/newsletter)
### Install
```bash
composer require adminetic/newsletter
```
**Publish Resources**
```bash
php artisan vendor:publish --tag=newsletter-config
php artisan vendor:publish --tag=newsletter-migrations
```
### Uses
**Display Subscriber Panel**
```
@livewire('subscriber-panel')
```
**Subscribe and unsubscribe an email**
```
subscribe('johndoe@test.com'); //subscribe
unsubscribe('johndoe@test.com'); //unsubscribe
```
**Subscribe Model Methods**
```
$subscriber = Adminetic\Newsletter\Models\Admin\Subscriber::first();
$subscriber->subscribe();
$subscriber->unsubscribe();
$subscriber->verify();
$subscriber->unverify();
```
**Subscribe Verification Email**
Note : Only works when config `newsletter.subscription_mail` is set to `true`
```
$subscriber = Adminetic\Newsletter\Models\Admin\Subscriber::first();
$subscriber->send_subscription_notification_email()
```
#### Testing
```bash
composer test
```
#### Changelog
Please see CHANGELOG for more information what has changed recently.
### Contributing
Please see CONTRIBUTING for details.
#### Security
If you discover any security related issues, please email instead of using the issue tracker.
### Credits
* [Pratik Shrestha](https://github.com/adminetic)
* [Laravel Excel](https://laravel-excel.com/)
* All Contributors
### License
The MIT License (MIT). Please see License File for more information.
### Screenshots
