README

此项目是dacastro4/laravel-gmail的分支

Gmail

Laravel 9的Gmail API

您需要在Google Console中创建一个应用。请参考这里的指南。

要求

PHP ^8.0
Laravel 9

安装

将cerbaro/laravel-gmail添加到composer.json文件中。

"cerbaro/laravel-gmail": "^2.1.0"

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

或者运行

composer require cerbaro/laravel-gmail

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

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

现在添加别名。

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

对于laravel >=5.5，以上步骤就完成了。此包支持Laravel新的包发现。

为了与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中的"cerbaro/laravel-gmail": "^1.0"更改为"cerbaro/laravel-gmail": "^2.0"

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

所有带有“威胁”一词的变量都更改为“thread”（是的，我知道……对不起）。例如

邮件类$threatId => $threadId

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

等等。

从0.6迁移到1.0

唯一的变化是增加了多凭证功能。

将composer.json中的"cerbaro/laravel-gmail": "^0.6"更改为"cerbaro/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="Cerbaro\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。

可用作用域

所有 （这个在Gmail作用域中不存在，我添加了它。）
编写
插入
标签
元数据
修改
只读
发送
基本设置
共享设置

关于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'
    ],

示例

欢迎Blade

<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() 设置并保存AccessToken到json文件（在回调中使用很有用）

LaravelGmail::logout 注销用户

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

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

发送

use Cerbaro\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 Cerbaro\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 Cerbaro\LaravelGmail\Services\Message\Attachment
...

$attachment = new Attachment;