将GMAIL API与Symfony4结合使用

时间:2018-10-15 16:36:59

标签: php symfony oauth gmail

我正在我的symfony4网站上尝试使用 Gmail API 。目标是通过cron定期执行命令,该命令将提取所有未读的电子邮件,获取内容并处理某些事情,然后将其标记为已读。

我目前有(尽管the official documentation):

  • 通过composer安装了库
  • 为此创建了一个新的gmail帐户,启用了gmail API,并下载了我的“ credentials.json”
  • symfony的有效命令(app:upload-from-unread-emails),其代码为:

    $client = new \Google_Client();
    $client->setApplicationName('Gmail API PHP Quickstart');
    $client->addScope(\Google_Service_Gmail::GMAIL_READONLY);
    $client->setAuthConfig('credentials.json');
    $client->setAccessType('offline');
    $client->setPrompt('select_account consent');
    
    $gmail = new \Google_Service_Gmail($client);
    $list = $gmail->users_messages->listUsersMessages('me', ['maxResults' => 1000]);
    
    while ($list->getMessages() != null) {
        foreach ($list->getMessages() as $mlist) {
    
            $message_id = $mlist->id;
            var_dump($message_id);
    
        }
    
        if ($list->getNextPageToken() != null) {
            $pageToken = $list->getNextPageToken();
            $list = $gmail->users_messages->listUsersMessages('me', ['pageToken' => $pageToken, 'maxResults' => 1000]);
        } else {
            break;
        }
    } 
    

我在正确的身份验证上吗?我应该将 credential.json 放在symfony中的哪里?

1 个答案:

答案 0 :(得分:0)

  

我应该在哪里将credential.json放在symfony中?

我认为此文件的最佳位置是config文件夹。但是您可以设置任何路径(除非可能不在public =中)。

假设此文件的路径为config/gmail/credentials.json。因此,下一步是在命令中获取文件路径。为此,您需要从服务容器获取kernel.project_dir参数,并将kernel.project_dir/config/gmail/credentials.json

连接起来

要在命令中使用服务容器,您需要:

  • 实现ContainerAwareInterface
  • 使用ContainerAwareTrait(用于$container属性和setContainer方法)
  • 在命令构造器中
  • 键入提示ContainerInterface $container,调用parent::__constructsetContainer($container)

-

// ...
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

class UploadFromUnreadEmailsCommand extends Command implements ContainerAwareInterface
{
    use ContainerAwareTrait;

    public function __construct(ContainerInterface $container)
    {
        parent::__construct();
        $this->setContainer($container);
    }

    // ...

}

您链接的文档也包含带有getClient函数的示例。只需进行一些更改即可对其进行编辑:

private function getClient()
{
    $projectDir = $this->container->getParameter('kernel.project_dir');
    $credentialsFilePath = sprintf('%s/config/gmail/credentials.json', $projectDir);
    $tokenFilePath = sprintf('%s/config/gmail/token.json', $projectDir);

    // ...
}

并使用execute方法:

$client = $this->getClient();
$gmail = new \Google_Service_Gmail($client);

执行命令并遵循说明(生成令牌)。

完整命令类:

<?php

namespace App\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

class UploadFromUnreadEmailsCommand extends Command implements ContainerAwareInterface
{

    use ContainerAwareTrait;

    protected static $defaultName = 'app:upload-from-unread-emails';

    /**
    * UploadFromUnreadEmailsCommand constructor.
    * @param $container
    */
    public function __construct(ContainerInterface $container)
    {
        parent::__construct();
        $this->setContainer($container);
    }

    protected function configure()
    {
        $this
            ->setDescription('Add a short description for your command')
        ;
    }

    private function getClient()
    {
        $projectDir = $this->container->getParameter('kernel.project_dir');
        $credentialsFilePath = sprintf('%s/config/gmail/credentials.json', $projectDir);
        $tokenFilePath = sprintf('%s/config/gmail/token.json', $projectDir);

        $client = new \Google_Client();
        $client->setApplicationName('Gmail API PHP Quickstart');
        $client->setScopes(\Google_Service_Gmail::GMAIL_READONLY);
        $client->setAuthConfig($credentialsFilePath);
        $client->setAccessType('offline');
        $client->setPrompt('select_account consent');

        // Load previously authorized token from a file, if it exists.
        if (file_exists($tokenFilePath)) {
            $accessToken = json_decode(file_get_contents($tokenFilePath), true);
            $client->setAccessToken($accessToken);
        }

        // If there is no previous token or it's expired.
        if ($client->isAccessTokenExpired()) {
            // Refresh the token if possible, else fetch a new one.
            if ($client->getRefreshToken()) {
                $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
            } else {
                // Request authorization from the user.
                $authUrl = $client->createAuthUrl();
                printf("Open the following link in your browser:\n%s\n", $authUrl);
                print 'Enter verification code: ';
                $authCode = trim(fgets(STDIN));

                // Exchange authorization code for an access token.
                $accessToken = $client->fetchAccessTokenWithAuthCode($authCode);
                $client->setAccessToken($accessToken);

                // Check to see if there was an error.
                if (array_key_exists('error', $accessToken)) {
                    throw new Exception(join(', ', $accessToken));
                }
            }
            // Save the token to a file.
            if (!file_exists(dirname($tokenFilePath))) {
                mkdir(dirname($tokenFilePath), 0700, true);
            }
            file_put_contents($tokenFilePath, json_encode($client->getAccessToken()));
        }
        return $client;
    }


    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $io = new SymfonyStyle($input, $output);

        $client = $this->getClient();

        $gmail = new \Google_Service_Gmail($client);
        $list = $gmail->users_messages->listUsersMessages('me', ['maxResults' => 10]);

        while ($list->getMessages() != null) {
            foreach ($list->getMessages() as $mlist) {

                $message_id = $mlist->id;
                $io->text($message_id);

            }

            if ($list->getNextPageToken() != null) {
                $pageToken = $list->getNextPageToken();
                $list = $gmail->users_messages->listUsersMessages('me', ['pageToken' => $pageToken, 'maxResults' => 1000]);
            } else {
                break;
            }
        }

        $io->success('Success');
    }
}

我还认为更好的解决方案是将getClient函数移到服务中,在命令构造函数中获取容器参数,初始化\Google_Service_Gmail并键入提示GmailService:

# /src/Command/UploadFromUnreadEmailsCommand.php
private $gmailService;
public function __construct(GmailService $gmailService)
{
    $this->gmailService = $gmailService;
}