README

Gmail

Laravel 9 的 Gmail API

您需要在 Google Console 中创建一个应用。指导在这里。

如果您需要 Laravel 5 兼容性，请使用版本 2.0.x。如果您需要 Laravel 6 兼容性，请使用版本 3.0.x。如果您需要 Laravel 7 兼容性，请使用版本 4.0.x。如果您需要 Laravel 8 兼容性，请使用版本 5.0.x。

要求

PHP ^8.0
Laravel 9

安装

将 dacastro4/laravel-gmail 添加到 composer.json。

"dacastro4/laravel-gmail": "^6.1"

运行 composer update 以获取最新版本。

或者运行

composer require dacastro4/laravel-gmail

现在打开 config/app.php 并将服务提供者添加到 providers 数组中。

'providers' => [
    Dacastro4\LaravelGmail\LaravelGmailServiceProvider::class,
]

现在添加别名。

'aliases' => [
    'LaravelGmail' => Dacastro4\LaravelGmail\Facade\LaravelGmail::class,
]

对于 laravel >=5.5，这样就完成了。此包支持 Laravel 新的 Package Discovery。

为了与 PHP 7.4 兼容，请使用版本 v5.0

从 5.0 到 6.0 的迁移

需要 Laravel 9，并且您必须将依赖项更改为 "laravel/laravel": "^9.0"。请按照从 8.x 升级到 9.0 指南进行操作。

从 4.0 到 5.0 的迁移

需要 Laravel 8，并且您必须将依赖项更改为 "laravel/laravel": "^8.0"。请按照从 7.x 升级到 8.0 指南进行操作。

从 3.0 到 4.0 的迁移

需要 Laravel 7，并且您必须将依赖项更改为 "laravel/laravel": "^7.0"。请按照从 6.x 升级到 7.0 指南进行操作。

从 2.0 到 3.0 的迁移

需要 Laravel 6，并且您只需更改依赖项为 "laravel/laravel": "^6.0"

从 1.0 到 2.0 的迁移

唯一更改是添加了多凭证功能。

将您的 composer.json 从 "dacastro4/laravel-gmail": "^1.0" 更改为 "dacastro4/laravel-gmail": "^2.0"

我不得不更改版本，因为存在一个打字错误，这可能会破坏调用这些属性的应用程序。

所有包含“威胁”一词的变量都更改为“线程”（是的，我知道..抱歉）示例

邮件类 $threatId => $threadId

可回复类 $mail->setReplyThreat() => $mail->setReplyThread()

等等。

从 0.6 到 1.0 的迁移

唯一更改是添加了多凭证功能。

将您的 composer.json 从 "dacastro4/laravel-gmail": "^0.6" 更改为 "dacastro4/laravel-gmail": "^1.0"

如果您不想要多用户凭证，您无需做任何其他操作；如果您需要，您将需要为每个用户再次登录以创建新的凭证文件。

配置

您只需在您的 .env 文件中设置以下变量，然后您就可以开始了

GOOGLE_PROJECT_ID=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_REDIRECT_URI=
GOOGLE_ALLOW_MULTIPLE_CREDENTIALS
GOOGLE_ALLOW_JSON_ENCRYPT

要修改作用域和凭证文件名，只需运行

运行 php artisan vendor:publish --provider="Dacastro4\LaravelGmail\LaravelGmailServiceProvider" 并修改配置文件 config/gmail.php。

允许多用户凭证

为了允许多用户凭据更改，请在您的配置文件中将 allow_multiple_credentials 设置为 true，或者如果您不使用配置文件，请将 .env 变量 GOOGLE_ALLOW_MULTIPLE_CREDENTIALS 设置为 true。

允许对 JSON 文件进行加密

为了允许对 JSON 文件进行加密，请在您的配置文件中将 allow_json_encrypt 设置为 true，或者如果您不使用配置文件，请将 .env 变量 GOOGLE_ALLOW_JSON_ENCRYPT 设置为 true。

可用作用域

all (这个作用域在 Gmail 作用域中不存在，我添加了它。)
compose
insert
labels
metadata
modify
readonly
send
settings_basic
settings_sharing

更多关于 Gmail API 作用域的信息

注意：要更改作用域，用户必须注销并重新登录。

附加作用域

如果出于某种原因您需要添加附加作用域。

在 config/gmail.php 中以 URL 风格添加附加作用域

 'additional_scopes' => [
            'https://www.googleapis.com/auth/drive',
            'https://www.googleapis.com/auth/documents',
            'https://www.googleapis.com/auth/spreadsheets'
    ],

示例

欢迎模板

<body>
    <h1>{{ LaravelGmail::user() }}</h1>
    @if(LaravelGmail::check())
        <a href="{{ url('oauth/gmail/logout') }}">logout</a>
    @else
        <a href="{{ url('oauth/gmail') }}">login</a>
    @endif
</body>

路由

Route::get('/oauth/gmail', function (){
    return LaravelGmail::redirect();
});

Route::get('/oauth/gmail/callback', function (){
    LaravelGmail::makeToken();
    return redirect()->to('/');
});

Route::get('/oauth/gmail/logout', function (){
    LaravelGmail::logout(); //It returns exception if fails
    return redirect()->to('/');
});

然后在您的控制器或其他您想执行逻辑的地方，您会做类似以下的事情

$messages = LaravelGmail::message()->subject('test')->unread()->preload()->all();
foreach ( $messages as $message ) {
    $body = $message->getHtmlBody();
    $subject = $message->getSubject();
}

注意：如果您没有预加载消息，您必须做如下操作：$body = $message->load()->getSubject(); 之后，您不需要再次调用它。

分页

使用 $messages->hasNextPage() 检查是否有下一页可用。使用 $messages->next() 获取下一页的结果，这些结果使用与加载第一页时相同的参数（每页结果数、过滤器等）。使用 $messages->getPageToken() 获取下一页标记的唯一标识符。这在将结果存储到缓存时创建唯一标识符时很有用。一般来说，使用 API 进行分页是不好的做法。它很慢且成本高昂。因此，建议在页面之间检索缓存的結果，并且只有在必须时才清除缓存。

文档

基本

LaravelGmail::getAuthUrl 获取用户授权的 URL。

LaravelGmail::redirect 您可以使用此作为直接方法 <a href="{{ LaravelGmail::redirect() }}">登录</a>

LaravelGmail::makeToken() 设置并保存到 json 文件中的 AccessToken（在回调中很有用）

LaravelGmail::logout 注销用户

LaravelGmail::check 检查用户是否已登录

LaravelGmail::setUserId($account_id)->makeToken() 为 $account_id 设置并保存 AccessToken（v5.1.2 添加）

发送

use Dacastro4\LaravelGmail\Services\Message\Mail;

...

$mail = new Mail;

对于 to、from、cc 和 bcc，您可以设置电子邮件地址和名称的数组或电子邮件地址和名称的字符串。

$mail->using( $token ) 如果您不想使用令牌文件，可以使用此功能设置请求中使用的令牌。它不会刷新

$mail->to( $to, $name = null ) 设置收件人电子邮件和名称（可选）

$mail->from( $from, $name = null ) 设置发件人电子邮件

$mail->cc( $cc, $name = null ) 设置抄送

$mail->bcc( $bcc, $name = null ) 设置盲抄送

$mail->subject( $subject ) 设置电子邮件的主题

$mail->message( $message ) 设置电子邮件正文

$mail->view( 'view.name', $dataArray ) 从 blade 文件设置正文

$mail->markdown( 'view.name', $dataArray ) 从 markdown 文件设置正文

$mail->attach( ...$path ) 将文件附件添加到电子邮件

$mail->priority( $priority ) 设置电子邮件的优先级（从 1 到 5）

$mail->reply() 回复现有电子邮件

$mail->send() 发送新电子邮件

$mail->setHeader( $header, $value ) 设置电子邮件的标题

邮件

$mail->getId 返回电子邮件的 ID

$mail->getInternalDate 返回 UNIX 格式的日期

$mail->getDate 返回来自电子邮件标题的 Carbon 日期

$mail->getLabels 返回电子邮件的所有标签数组

$mail->getHeaders 返回标题集合。每个标题都是一个包含键和值的数组

$mail->getSubject 返回主题的字符串

$mail->getFrom 返回发送者的姓名和电子邮件的数组

$mail->getFromName 返回姓名字符串

$mail->getFromEmail 返回电子邮件字符串

$mail->getTo 返回所有收件者的姓名和电子邮件的数组

$mail->getDeliveredTo 返回收件人的电子邮件

$mail->getPlainTextBody 返回电子邮件的纯文本版本

$mail->getRawPlainTextBody 返回基于 base64 加密的正文原始版本

$mail->hasAttachments 如果电子邮件有附件，则返回布尔值

$mail->load 加载电子邮件的所有信息（标签、正文、标题）。您需要在单个电子邮件上调用此函数。要从开头加载，请参阅 preload()

$mail->getHeader( $headerName, $regex = null ) 返回按名称的标题。可选地，您可以在值上执行正则表达式

    $mailbox = new LaravelGmailClass(config(), LaravelGmail::user());

    $label = new \Google_Service_Gmail_Label($this);
    $label->setMessageListVisibility('show'); `show || hide`
    $label->setLabelListVisibility('labelShow'); `labelShow || labelShowIfUnread || labelHide`
    $label->setName('labelName');
    $mailbox->createLabel($userEmail, $label);

FirstOrCreateLabel：如果不存在，则使用标签名称在电子邮件上创建新标签

https://developers.google.com/gmail/api/reference/rest/v1/users.labels/create

示例

    $mailbox = new LaravelGmailClass(config(), LaravelGmail::user());

    $label = new \Google_Service_Gmail_Label($this);
    $label->setMessageListVisibility('show'); `show || hide`
    $label->setLabelListVisibility('labelShow'); `labelShow || labelShowIfUnread || labelHide`
    $label->setName('labelName');
    $mailbox->firstOrCreateLabel($userEmail, $label);

附件

use Dacastro4\LaravelGmail\Services\Message\Attachment
...

$attachment = new Attachment;

$attachment->getId 返回附件的 ID

$attachment->getFileName 返回附件的文件名

$attachment->getMimeType 返回 MIME 类型。例如：application/pdf

$attachment->getSize 返回附件的大小（以字节为单位）

$attachment->getData 从附件获取所有信息。如果您调用 getAttachmentsWithData，则不需要此方法。

$attachment->saveAttachmentTo($path = null, $filename = null, $disk = 'local') 在存储文件夹中保存附件。您可以传递路径、名称和使用磁盘。

消息

LaravelGmail::message()->all( $pageToken = null ) 返回收件箱中的所有电子邮件

LaravelGmail::message()->take(2)->all( $pageToken = null ) take 方法通过设置的数字限制从查询中返回的电子邮件数量

LaravelGmail::message()->get( $id ) 返回具有所有信息的单个电子邮件

修改器

您可以使用这些方法修改查询。例如

要获取所有未读电子邮件： LaravelGmail::message()->unread()->all()

message()->unread()

message()->from( $email )

message()->in( $box = 'inbox' )

message()->hasAttachment()

message()->subject($subject)

->after($date) 和 ->before($date)

message()->raw($query) 用于自定义查询

所有可能的过滤器都在可过滤特性（Filterable Trait）中

当然，您也可以将其用作流畅的API。

    LaravelGmail::message()
                ->from('someone@gmail.com')
                ->unread()
                ->in('TRASH')
                ->hasAttachment()
                ->all()

附件

use Dacastro4\LaravelGmail\Services\Message\Attachment
...

$attachment = new Attachment;