文件列表:

.editorconfig (220, 2023-08-17)
CHANGELOG.md (3532, 2023-08-17)
LICENSE.md (1090, 2023-08-17)
UPGRADING.md (235, 2023-08-17)
composer.json (2092, 2023-08-17)
config/ (0, 2023-08-17)
config/newsletter.php (1351, 2023-08-17)
phpstan-baseline.neon (0, 2023-08-17)
phpstan.neon.dist (115, 2023-08-17)
phpunit.xml (549, 2023-08-17)
src/ (0, 2023-08-17)
src/Drivers/ (0, 2023-08-17)
src/Drivers/Driver.php (878, 2023-08-17)
src/Drivers/MailChimpDriver.php (4662, 2023-08-17)
src/Drivers/MailcoachDriver.php (2689, 2023-08-17)
src/Exceptions/ (0, 2023-08-17)
src/Exceptions/CouldNotUpdateMember.php (295, 2023-08-17)
src/Exceptions/InvalidNewsletterList.php (598, 2023-08-17)
src/Facades/ (0, 2023-08-17)
src/Facades/Newsletter.php (983, 2023-08-17)
src/NewsletterServiceProvider.php (864, 2023-08-17)
src/Support/ (0, 2023-08-17)
src/Support/Lists.php (1299, 2023-08-17)
src/Support/NewsletterList.php (447, 2023-08-17)

# Manage newsletters in Laravel [](https://github.com/spatie/laravel-newsletter/releases) [](LICENSE.md)   [](https://packagist.org/packages/spatie/laravel-newsletter) This package provides an easy way to integrate subscriptions to email lists of various email services. Currently this package support: - [Mailcoach](https://mailcoach.app) (built by us :-)) - [MailChimp](https://mailchimp.com) ## Support us [](https://spatie.be/github-ad-click/laravel-newsletter) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). ## Installation You can install this package via composer using: ```bash composer require spatie/laravel-newsletter ``` To publish the config file to `config/newsletter.php` run: ```bash php artisan vendor:publish --tag="newsletter-config" ``` This will publish a file `newsletter.php` in your config directory with the following contents: ```php return [ /* * The driver to use to interact with MailChimp API. * You may use "log" or "null" to prevent calling the * API directly from your environment. */ 'driver' => env('NEWSLETTER_DRIVER', Spatie\Newsletter\Drivers\MailcoachDriver::class), /** * These arguments will be given to the driver. */ 'driver_arguments' => [ 'api_key' => env('NEWSLETTER_API_KEY'), 'endpoint' => env('NEWSLETTER_ENDPOINT'), ], /* * The list name to use when no list name is specified in a method. */ 'default_list_name' => 'subscribers', 'lists' => [ /* * This key is used to identify this list. It can be used * as the listName parameter provided in the various methods. * * You can set it to any string you want and you can add * as many lists as you want. */ 'subscribers' => [ /* * When using the Mailcoach driver, this should be Email list UUID * which is displayed in the Mailcoach UI * * When using the MailChimp driver, this should be a MailChimp list id. * http://kb.mailchimp.com/lists/managing-subscribers/find-your-list-id. */ 'id' => env('NEWSLETTER_LIST_ID'), ], ], ]; ``` ### Using Mailcoach To let this package work with Mailcoach, you need to install the Mailcoach SDK. ```bash composer require spatie/mailcoach-sdk-php ``` Next, you must provide values for the API key, endpoint and `list.subscribers.id` in the config file. You'll find the API key and endpoint in the [Mailcoach](https://mailcoach.app) settings screen. The value for `list.subscribers.id` must be the UUID of an email list on Mailcoach. You'll find this value on the settings screen of an email list ### Using MailChimp To use MailChimp, install this extra package. ```bash composer require drewm/mailchimp-api ``` The `driver` key of the `newsletter` config file must be set to `Spatie\Newsletter\Drivers\MailChimpDriver::class`. Next, you must provide values for the API key and `list.subscribers.id`. You'll find these values in the MailChimp UI. The `endpoint` config value must be set to null. ## Usage After you've installed the package and filled in the values in the config-file working with this package will be a breeze. All the following examples use the facade. Don't forget to import it at the top of your file. ```php use Spatie\Newsletter\Facades\Newsletter; ``` ### Subscribing, updating and unsubscribing Subscribing an email address can be done like this: ```php use Newsletter; Newsletter::subscribe('rincewind@discworld.com'); ``` Let's unsubscribe someone: ```php Newsletter::unsubscribe('the.luggage@discworld.com'); ``` For Mailcoach, you can pass extra attributes as the second argument: ```php Newsletter::subscribe('rincewind@discworld.com', ['first_name' => 'Rince', 'last_name' => 'Wind']); ``` For MailChimp you can pass merge variables as the second argument: ```php Newsletter::subscribe('rincewind@discworld.com', ['FNAME'=>'Rince', 'LNAME'=>'Wind']); ``` You can subscribe someone to a specific list by passing a list name: ```php Newsletter::subscribe('rincewind@discworld.com', listName: 'subscribers'); ``` That third argument is the name of a list you configured in the config file. You can also subscribe and/or update someone. The person will be subscribed or updated if he/she is already subscribed: ```php Newsletter::subscribeOrUpdate('rincewind@discworld.com', ['first_name' => 'Rince', 'last_name' => 'Wind']); ``` For MailChimp, You can subscribe someone to one or more specific group(s)/interest(s) by using the fourth argument: ```php Newsletter::subscribeOrUpdate( 'rincewind@dscworld.com', ['FNAME'=>'Rince','LNAME'=>'Wind'], 'subscribers', ['interests'=>['interestId'=>true, 'interestId'=>true]], ); ``` Simply add `false` if you want to remove someone from a group/interest. Here's how to unsubscribe someone from a specific list: ```php Newsletter::unsubscribe('rincewind@discworld.com', 'subscribers'); ``` ### Deleting subscribers Deleting is not the same as unsubscribing. Unlike unsubscribing, deleting a member will result in the loss of all history (add/opt-in/edits) as well as removing them from the list. In most cases you want to use `unsubscribe` instead of `delete`. Here's how to perform a delete: ```php Newsletter::delete('rincewind@discworld.com'); ``` ### Getting subscriber info You can get information on a subscriber by using the `getMember` function: ```php Newsletter::getMember('lord.vetinari@discworld.com'); ``` For MailCoach, this will return an instance of `Spatie\Mailcoach\Resources|Subscriber` For MailChimp, this will return an array with information on the subscriber. If there's no one subscribed with that e-mail address the function will return `false` There's also a convenience method to check if someone is already subscribed: ```php Newsletter::hasMember('nanny.ogg@discworld.com'); //returns a boolean ``` In addition to this you can also check if a user is subscribed to your list: ```php Newsletter::isSubscribed('lord.vetinari@discworld.com'); //returns a boolean ``` ### Need something else? If you need more functionality you get an instance of the underlying API with ```php $api = Newsletter::getApi(); ``` If you're having troubles getting the MailChimp integration, you can see the last error with: ```php Newsletter::getApi()->getLastError(); ``` ## Testing Run the tests with: ```bash vendor/bin/pest ``` ### Changelog Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. ## Security If you discover any security related issues, please email [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker. ## Credits - [Freek Van der Herten](https://github.com/freekmurze) - [All Contributors](../../contributors) be dedicated to allocating workforce on maintenance and new awesome stuff. ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：