kevinpurwito/laravel-mailcoach-api

v1.0.0 2022-10-12 09:35 UTC

This package is auto-updated.

Last update: 2024-09-12 13:48:27 UTC


README

Tests Code Style Psalm Latest Version on Packagist Total Downloads

Laravel 邮件教练 API 是一个包,用于简化您在 Laravel 项目中集成自己的邮件教练 API

参考此文档

安装

您可以通过 composer 安装此包

composer require kevinpurwito/laravel-mailcoach-api

配置

vendor:publish 命令会在您的 Laravel 项目配置文件夹中发布一个名为 kp_mailcoach.php 的文件,位于 config/kp_mailcoach.php

已发布配置文件内容

[
    'url' => strtolower(env('KP_MAILCOACH_API_URL')),
    
    'token' => env('KP_MAILCOACH_API_TOKEN'),

    'list_id' => intval(env('KP_MAILCOACH_LIST_ID', 1)),
];

或者,您可以忽略上述发布命令,并将以下变量添加到您的 .env 文件中。

KP_MAILCOACH_API_URL=your_mailcoach_api_url
KP_MAILCOACH_API_TOKEN=your_mailcoach_api_token

自动发现

如果您使用的是 Laravel 5.5+,则不需要手动添加服务提供者或外观。这将自动发现。对于 Laravel 5.5 以下的所有版本,您必须在您的 Laravel 项目 config/app.php 文件中的相应数组中手动添加 ServiceProvider & Facade。

提供者

[
    Kevinpurwito\LaravelMailcoachApi\MailcoachApiServiceProvider::class,
];

别名 / 外观

[
    'MailcoachApi' => Kevinpurwito\LaravelMailcoachApi\Facades\MailcoachApi::class,
];

用法

使用外观

use Kevinpurwito\LaravelMailcoachApi\Facades\MailcoachApi;

MailcoachApi::getSubscribers();

使用类

use Kevinpurwito\LaravelMailcoachApi\MailcoachApi;
use Kevinpurwito\LaravelMailcoachApi\Data\InputSubscriberData;

$mcApi = (new MailcoachApi(url: '', token: ''));

$data = new InputSubscriberData(email: '', first_name: '', last_name: '');

$subscriber = $mcApi->addSubscriber(listId: 0, data: $data);

测试

composer test

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全性

如果您发现任何安全问题,请通过电子邮件kevin.purwito@gmail.com联系,而不是使用问题跟踪器。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件以获取更多信息。

Laravel 包模板

此包是使用PHP 包模板生成的,由Beyond Code提供,并从PHP 包骨架中吸取了一些灵感,由spatie提供。