laravel newsletter

Administrar boletines en Laravel

Este paquete proporciona una manera sencilla de integrar suscripciones a listas de correo electrónico de varios servicios de correo electrónico.

Actualmente este paquete admite:

• Mailcoach (construido por nosotros :-))

• CorreoChimp

Apóyanos

Invertimos muchos recursos en la creación de los mejores paquetes de código abierto. Puedes apoyarnos comprando uno de nuestros productos pagos.

Agradecemos mucho que nos envíe una postal desde su ciudad natal, mencionando cuál de nuestros paquetes está utilizando. Encontrarás nuestra dirección en nuestra página de contacto. Publicamos todas las postales recibidas en nuestro muro virtual de postales.

Instalación

Puede instalar este paquete a través de Composer usando:

 El compositor requiere spatie/laravel-newsletter.

Para publicar el archivo de configuración en config/newsletter.php ejecute:

 Proveedor artesanal de php: publicar --tag="newsletter-config"

Esto publicará un archivo newsletter.php en su directorio de configuración con el siguiente contenido:

 return [/* * El controlador que se utilizará para interactuar con la API de MailChimp.     * Puede utilizar "log" o "null" para evitar llamar a la * API directamente desde su entorno.     */'driver' => env('NEWSLETTER_DRIVER', SpatieNewsletterDriversMailcoachDriver::class),/** * Estos argumentos se le darán al conductor.     */'driver_arguments' => ['api_key' => env('NEWSLETTER_API_KEY'),'endpoint' => env('NEWSLETTER_ENDPOINT'),
    ],/* * El nombre de la lista que se utilizará cuando no se especifique ningún nombre de lista en un método.     */'default_list_name' => 'subscribers','lists' => [/* * Esta clave se utiliza para identificar esta lista. Se puede utilizar * como parámetro listName proporcionado en los distintos métodos.         * * Puedes configurarlo en cualquier cadena que desees y puedes agregar * tantas listas como quieras.         */'subscribers' => [/* * Cuando se usa el controlador Mailcoach, este debe ser el UUID de la lista de correo electrónico * que se muestra en la interfaz de usuario de Mailcoach * * Cuando se usa el controlador MailChimp, debe ser una identificación de la lista de MailChimp.             * http://kb.mailchimp.com/lists/managing-subscribers/find-your-list-id.             */'id' => env('NEWSLETTER_LIST_ID'),
        ],
    ],
];

Usando el entrenador de correo

Para permitir que este paquete funcione con Mailcoach, debe instalar el SDK de Mailcoach.

 El compositor requiere spatie/mailcoach-sdk-php.

A continuación, debe proporcionar valores para la clave API, el punto final y list.subscribers.id en el archivo de configuración. Encontrarás la clave API y el punto final en la pantalla de configuración de Mailcoach. El valor de list.subscribers.id debe ser el UUID de una lista de correo electrónico en Mailcoach. Encontrarás este valor en la pantalla de configuración de una lista de correo electrónico.

Usando MailChimp

Para utilizar MailChimp, instale este paquete adicional.

 el compositor requiere drawm/mailchimp-api

La clave driver del archivo de configuración newsletter debe estar configurada en SpatieNewsletterDriversMailChimpDriver::class .

A continuación, debe proporcionar valores para la clave API y list.subscribers.id . Encontrarás estos valores en la interfaz de usuario de MailChimp.

El valor de configuración endpoint debe establecerse en nulo.

Uso

Una vez que haya instalado el paquete y haya completado los valores en el archivo de configuración, trabajar con este paquete será muy sencillo. Todos los ejemplos siguientes utilizan la fachada. No olvides importarlo en la parte superior de tu archivo.

 utilizar SpatieNewsletterFacadesNewsletter;

Suscribirse, actualizar y darse de baja

La suscripción de una dirección de correo electrónico se puede hacer así:

 utilizar el boletín;

Boletín::subscribe('[email protected]');

Demos de baja a alguien:

 Boletín::cancelar suscripción('[email protected]');

Para Mailcoach, puedes pasar atributos adicionales como segundo argumento:

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

Para MailChimp puedes pasar variables de combinación como segundo argumento:

 Boletín::subscribe('[email protected]', ['FNAME'=>'Rince', 'LNAME'=>'Wind']);

Puedes suscribir a alguien a una lista específica pasando un nombre de lista:

 Boletín::subscribe('[email protected]', listName: 'suscriptores');

Ese tercer argumento es el nombre de una lista que configuró en el archivo de configuración.

También puedes suscribirte y/o actualizar a alguien. La persona será suscrita o actualizada si ya está suscrita:

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

Para MailChimp, puede suscribir a alguien a uno o más grupos/intereses específicos utilizando el cuarto argumento:

 Boletín::subscribeOrUpdate( '[email protected]',
    ['FNAME'=>'Rince','LNAME'=>'Viento'],
    'suscriptores',
    ['intereses'=>['interestId'=>true, 'interestId'=>true]],
);

Simplemente agregue false si desea eliminar a alguien de un grupo/interés.

A continuación se explica cómo cancelar la suscripción de alguien de una lista específica:

 Boletín::unsubscribe('[email protected]', 'suscriptores');

Eliminar suscriptores

Eliminar no es lo mismo que darse de baja. A diferencia de cancelar la suscripción, eliminar un miembro resultará en la pérdida de todo el historial (agregar/inscribirse/editar), además de eliminarlo de la lista. En la mayoría de los casos, querrás cancelar unsubscribe en lugar de delete .

A continuación se explica cómo realizar una eliminación:

 Boletín::delete('[email protected]');

Obtener información del suscriptor

Puede obtener información sobre un suscriptor utilizando la función getMember :

 Boletín::getMember('[email protected]');

Para MailCoach, esto devolverá una instancia de SpatieMailcoachResources|Subscriber Para MailChimp, esto devolverá una matriz con información sobre el suscriptor.

Si no hay nadie suscrito con esa dirección de correo electrónico, la función devolverá false

También existe un método conveniente para verificar si alguien ya está suscrito:

 Boletín::hasMember('[email protected]'); //devuelve un booleano

Además de esto, también puedes comprobar si un usuario está suscrito a tu lista:

 Boletín::isSubscribed('[email protected]'); //devuelve un booleano

¿Necesitas algo más?

Si necesita más funcionalidad, obtiene una instancia de la API subyacente con

 $api = Boletín::getApi();

Si tiene problemas para integrar MailChimp, puede ver el último error con:

 Boletín::getApi()->getLastError();

Pruebas

Ejecute las pruebas con:

 vendedor/contenedor/plaga

Registro de cambios

Consulte CHANGELOG para obtener más información sobre los cambios recientes.

Contribuyendo

Consulte CONTRIBUCIÓN para obtener más detalles.

Seguridad

Si descubre algún problema relacionado con la seguridad, envíe un correo electrónico a [email protected] en lugar de utilizar el rastreador de problemas.

Créditos

• Freek Van der Herten

• Todos los contribuyentes se dedicarán a asignar mano de obra para el mantenimiento y nuevas cosas increíbles.

Licencia

La Licencia MIT (MIT). Consulte el archivo de licencia para obtener más información.