rhysnhall/laravel-socketlabs-driver

Laravel 邮件驱动,用于 SocketLabs 注入 API。

1.0.0 2021-12-30 11:44 UTC

This package is auto-updated.

Last update: 2024-08-29 05:50:34 UTC


README

Latest Stable Version PHP Version Require

为 Laravel 的邮件服务添加 SocketLabs 注入 API 驱动器。

要求

  • PHP 7.3 或更高版本。
  • 拥有一个 SocketLabs 账户,包括服务器 ID 和 API 密钥。

安装

使用 composer 安装该软件包。

composer require rhysnhall/laravel-socketlabs-driver

设置

一旦您在 SocketLabs 上注册并设置账户,您将获得一个服务器 ID 和 API 密钥。将这两者添加到您的 ENV 文件中。

SOCKET_LABS_API_KEY={your_key}
SOCKET_LABS_SERVER_ID={server_id}

接下来,将 SocketLabs 凭据添加到您的 config\services.php 配置文件中。

'socketlabs' => [
  'key' => env('SOCKET_LABS_API_KEY'),
  'id' => env('SOCKET_LABS_SERVER_ID')
]

将 SocketLabs 服务提供者添加到 config\app.php 配置文件中。

'providers' => [
  ...
  Rhysnhall\LaravelSocketLabsDriver\SocketLabsServiceProvider::class
]

最后一步是将 SocketLabs 驱动器添加到 config\mail.php 配置文件中。

'mailers' => [
  ...
  'socketlabs' => [
    'transport' => 'socketlabs'
  ]
]

根据您的设置,您可能还需要将 SocketLabs 设置为默认的邮件发送者。您需要更新 ENV 文件中的 MAIL_MAILER 变量。

MAIL_MAILER=socketlabs

配置

您可以直接将配置变量添加到 config\mail.php 配置文件中,或者创建一个新的配置文件来保存这些变量。

config\mail.php

'mailers' => [
  ...
  'socketlabs' => [
    'transport' => 'socketlabs',
    'retries' => 2,
    'timeout' => 120,
    'proxy_url' => 'https://example'
  ]
]

config\socketlabs.php

<?php

return [
  'retries' => 2,
  'timeout' => 120,
  'proxy_url' => 'https://example'
];

用法

像使用任何其他邮件驱动器一样使用此驱动器。

App\Mail\Test

class Test extends Mailable {
  public function build()
  {
      return $this->from('sender@example.com')
        ->view('emails.html.test')
        ->text('emails.plain.test')
        ->attach(storage_path('test_image.png'));
  }
}
Mail::to('recipient@example.com')->send(new \App\Mail\Test);

贡献

通过贡献来帮助改进此软件包。

在打开 pull request 之前,请通过 Github issue 或 电子邮件 讨论提议的更改。

许可

本项目采用 MIT 许可证 - 详细信息请参阅 LICENSE 文件。