laravel newsletter

Gerenciar newsletters no Laravel

Este pacote fornece uma maneira fácil de integrar assinaturas a listas de e-mail de vários serviços de e-mail.

Atualmente este pacote suporta:

• Mailcoach (construído por nós :-))

• MailChimp

Apoie-nos

Investimos muitos recursos na criação dos melhores pacotes de código aberto. Você pode nos apoiar comprando um de nossos produtos pagos.

Agradecemos muito que você nos envie um cartão postal de sua cidade natal, mencionando qual(is) de nossos pacotes você está usando. Você encontrará nosso endereço em nossa página de contato. Publicamos todos os cartões postais recebidos em nosso mural virtual de cartões postais.

Instalação

Você pode instalar este pacote via Composer usando:

 compositor requer spatie/laravel-newsletter

Para publicar o arquivo de configuração em config/newsletter.php execute:

 fornecedor de artesão php:publish --tag="newsletter-config"

Isso publicará um arquivo newsletter.php em seu diretório de configuração com o seguinte conteúdo:

 return [/* * O driver a ser usado para interagir com a API MailChimp.     * Você pode usar "log" ou "null" para evitar chamar a API * diretamente do seu ambiente.     */'driver' => env('NEWSLETTER_DRIVER', SpatieNewsletterDriversMailcoachDriver::class),/** * Esses argumentos serão fornecidos ao driver.     */'driver_arguments' => ['api_key' => env('NEWSLETTER_API_KEY'),'endpoint' => env('NEWSLETTER_ENDPOINT'),
    ],/* * O nome da lista a ser usado quando nenhum nome de lista for especificado em um método.     */'default_list_name' => 'subscribers','lists' => [/* * Esta chave é usada para identificar esta lista. Pode ser usado * como o parâmetro listName fornecido nos vários métodos.         * * Você pode configurá-lo para qualquer string que desejar e pode adicionar * quantas listas desejar.         */'subscribers' => [/* * Ao usar o driver Mailcoach, este deve ser o UUID da lista de e-mail * que é exibido na UI do Mailcoach * * Ao usar o driver MailChimp, este deve ser um ID de lista MailChimp.             * http://kb.mailchimp.com/lists/managing-subscribers/find-your-list-id.             */'id' => env('NEWSLETTER_LIST_ID'),
        ],
    ],
];

Usando Mailcoach

Para permitir que este pacote funcione com Mailcoach, você precisa instalar o Mailcoach SDK.

 compositor requer spatie/mailcoach-sdk-php

Em seguida, você deve fornecer valores para a chave de API, endpoint e list.subscribers.id no arquivo de configuração. Você encontrará a chave API e o endpoint na tela de configurações do Mailcoach. O valor para list.subscribers.id deve ser o UUID de uma lista de e-mail no Mailcoach. Você encontrará esse valor na tela de configurações de uma lista de e-mail

Usando MailChimp

Para usar o MailChimp, instale este pacote extra.

 compositor requer drawm/mailchimp-api

A chave driver do arquivo de configuração newsletter deve ser definida como SpatieNewsletterDriversMailChimpDriver::class .

Em seguida, você deve fornecer valores para a chave de API e list.subscribers.id . Você encontrará esses valores na interface do MailChimp.

O valor de configuração endpoint deve ser definido como nulo.

Uso

Depois de instalar o pacote e preencher os valores no arquivo de configuração, trabalhar com este pacote será muito fácil. Todos os exemplos a seguir usam a fachada. Não se esqueça de importá-lo no topo do seu arquivo.

 usar SpatieNewsletterFacadesNewsletter;

Assinando, atualizando e cancelando a assinatura

A inscrição de um endereço de e-mail pode ser feita assim:

 usar Boletim Informativo;

Boletim informativo::subscribe('[email protected]');

Vamos cancelar a inscrição de alguém:

 Boletim informativo::unsubscribe('[email protected]');

Para Mailcoach, você pode passar atributos extras como segundo argumento:

 Newsletter::subscribe('[email protected]', ['first_name' => 'Rince', 'last_name' => 'Wind']);

Para MailChimp você pode passar variáveis ​​de mesclagem como segundo argumento:

 Boletim informativo::subscribe('[email protected]', ['FNAME'=>'Rince', 'LNAME'=>'Wind']);

Você pode inscrever alguém em uma lista específica passando o nome da lista:

 Newsletter::subscribe('[email protected]', listName: 'assinantes');

Esse terceiro argumento é o nome de uma lista que você configurou no arquivo de configuração.

Você também pode se inscrever e/ou atualizar alguém. A pessoa será inscrita ou atualizada se já estiver inscrita:

 Newsletter::subscribeOrUpdate('[email protected]', ['first_name' => 'Rince', 'last_name' => 'Wind']);

Para MailChimp, você pode inscrever alguém em um ou mais grupos/interesses específicos usando o quarto argumento:

 Boletim informativo::subscribeOrUpdate( '[email protected]',
    ['FNAME'=>'Rince','LNAME'=>'Vento'],
    'assinantes',
    ['interesse'=>['interestId'=>true, 'interestId'=>true]],
);

Basta adicionar false se quiser remover alguém de um grupo/interesse.

Veja como cancelar a inscrição de alguém de uma lista específica:

 Boletim informativo::unsubscribe('[email protected]', 'assinantes');

Excluindo assinantes

Excluir não é o mesmo que cancelar a assinatura. Ao contrário do cancelamento da assinatura, a exclusão de um membro resultará na perda de todo o histórico (adições/opções/edições), bem como na remoção do membro da lista. Na maioria dos casos, você deseja usar unsubscribe em vez de delete .

Veja como realizar uma exclusão:

 Boletim informativo::delete('[email protected]');

Obtendo informações do assinante

Você pode obter informações sobre um assinante usando a função getMember :

 Boletim informativo::getMember('[email protected]');

Para MailCoach, isso retornará uma instância de SpatieMailcoachResources|Subscriber Para MailChimp, isso retornará um array com informações sobre o assinante.

Se não houver ninguém inscrito com esse endereço de e-mail a função retornará false

Também existe um método conveniente para verificar se alguém já está inscrito:

 Boletim informativo::hasMember('[email protected]'); //retorna um booleano

Além disso, você também pode verificar se um usuário está inscrito na sua lista:

 Boletim informativo::isSubscribed('[email protected]'); //retorna um booleano

Precisa de mais alguma coisa?

Se precisar de mais funcionalidades, você obtém uma instância da API subjacente com

 $api = Boletim Informativo::getApi();

Se estiver tendo problemas para obter a integração do MailChimp, você pode ver o último erro com:

 Boletim informativo::getApi()->getLastError();

Teste

Execute os testes com:

 fornecedor/lixo/praga

Registro de alterações

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Contribuindo

Consulte CONTRIBUINDO para obter detalhes.

Segurança

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [email protected] em vez de usar o rastreador de problemas.

Créditos

• Freek Van der Herten

• Todos os colaboradores se dedicam a alocar força de trabalho para manutenção e novidades incríveis.

Licença

A licença MIT (MIT). Consulte Arquivo de licença para obter mais informações.