Gmail API - PHP - 使用服务帐户发送电子邮件

Posted 2023-03-25

【中文标题】Gmail API - PHP - 使用服务帐户发送电子邮件

【英文标题】：Gmail API - PHP - Sending email using service account

【发布时间】：2020-09-30 09:48:51

【问题描述】：

问题：我遇到了一个 HTTP 400 错误，指出“前提条件检查失败”。每当我调用 sendMessage() 方法时。

我不知道我有什么可以考虑：

已启用 Gmail API。 创建了一个服务帐号。 设置域范围的委派（适用于 G-Suites）。 为服务启用了域范围的委派。

请注意，我已成功运行 quickstart.php，因此我知道 google 库已正确安装。以下是我的代码：

<?php
 require_once('../../vendor/autoload.php');

$client = new Google_Client();
$credentials_file = '../../vendor/google/auth/credentials.json';

$client->setAuthConfig($credentials_file);
$client->setApplicationName("no-reply mailing");
$client->setScopes(['https://www.googleapis.com/auth/gmail.send']);
$service = new Google_Service_Gmail($client);
$message = createMessage('me', '[e-mail]', 'This is but a test', 'Please work...');

// Email a user
sendMessage($service, 'me', $message);

/**
* @param $sender string sender email address
* @param $to string recipient email address
* @param $subject string email subject
* @param $messageText string email text
* @return Google_Service_Gmail_Message
*/
function createMessage($sender, $to, $subject, $messageText) 
 $message = new Google_Service_Gmail_Message();

 $rawMessageString = "From: <$sender>\r\n";
 $rawMessageString .= "To: <$to>\r\n";
 $rawMessageString .= 'Subject: =?utf-8?B?' . base64_encode($subject) . "?=\r\n";
 $rawMessageString .= "MIME-Version: 1.0\r\n";
 $rawMessageString .= "Content-Type: text/html; charset=utf-8\r\n";
 $rawMessageString .= 'Content-Transfer-Encoding: quoted-printable' . "\r\n\r\n";
 $rawMessageString .= "$messageText\r\n";

 $rawMessage = strtr(base64_encode($rawMessageString), array('+' => '-', '/' => '_'));
 $message->setRaw($rawMessage);
 return $message;


function sendMessage($service, $userId, $message) 
  try 
    $message = $service->users_messages->send($userId, $message);
    print 'Message with ID: ' . $message->getId() . ' sent.';
    return $message;
   catch (Exception $e) 
    print 'An error occurred: ' . $e->getMessage();
  

?>

非常感谢任何帮助！

【问题讨论】：

嗨！您的 create 函数是否正常工作而没有返回任何错误？您能否在方法SendMessage 中更改您的电子邮件地址的参数me 并查看您得到什么错误？当您使用服务帐户进行授权时，可能会出现一些问题，因为服务帐户无法发送消息或模拟用户。谢谢：D

【参考方案1】：

我为此联系了 Google 支持，他们已经解决了我的问题！

以下是支持人员在电子邮件中告诉我的内容：“您必须在代码上模拟用户才能使用服务帐户调用 Gmail API。” 所以“前提条件检查失败。”错误是由于身份验证不正确引起的。

因此，为了完整起见，我将介绍您必须经过的过程才能让您的代码正常工作。请注意，您需要三样东西：G-Suites、访问 Google 开发者控制台和访问 G-Suites 管理控制台。

开始编码之前的要求。

获取 Google 客户端库（确保 php 在您的系统路径中 > 安装 Composer > 安装库 composer require google/apiclient:^2.0） 启用 Gmail API（Google Developer console > 库 > 搜索“Gmail API”> 启用（如果已启用，您将看到管理按钮） 创建服务帐户 (Google Developer console > IAM & Admin > Service Accounts > 点击“创建服务帐户” > 照常填写第 1 步 > 第 2 步，我将我的服务帐户设置为项目所有者。 > 第 3 步我跳过了.) 创建密钥（Google Developer console > IAM 和管理员 > 服务帐户 > 单击新创建的服务帐户的“操作”菜单 > 创建密钥 > JSON > 将其存储在您的代码可以访问的位置。） 设置域范围委派（Google Admin > 安全 > API 权限 > 一直向下滚动以找到“管理域范围委派”> 单击“添加新”> 输入您在 json 文件中找到的客户端 ID刚刚下载 > 输入您需要的范围。通过 gmail 发送电子邮件，look under 'Authorization' here。） 启用域范围委派（Google Developer console > IAM 和管理员 > 服务帐户 > 单击新创建的服务帐户 > 单击“编辑”> 显示域范围委派 > 启用 G-Suite 域范围委派）

如果您已经按照并完成了这些步骤，那么您就可以继续执行代码部分了！

代码本身。

<?php
// Library obtained from https://developers.google.com/gmail/api/quickstart/php
require_once('../../vendor/autoload.php');

// Some user within your G-Suites domain
$user_to_impersonate = "[e-mail]";

$sender = $user_to_impersonate;
$to = '[e-mail]';
$subject = 'The subject of an email.';
$messageText = 'Finally this works!';

// The path to your service account credentials goes here.
putenv("GOOGLE_APPLICATION_CREDENTIALS=credentials.json");
$client = new Google_Client();
$client->useApplicationDefaultCredentials();
$client->setSubject($sender);
$client->setApplicationName("Quickstart");
$client->setScopes(["https://mail.google.com/",
                    "https://www.googleapis.com/auth/gmail.compose",
                    "https://www.googleapis.com/auth/gmail.modify",
                    "https://www.googleapis.com/auth/gmail.send"]);
$service = new Google_Service_Gmail($client);

// Main Process
try 
  $msg = createMessage($sender, $to, $subject, $messageText);
  sendMessage($service, $sender, $msg);
 catch (Exception $e) 
  print "An error occurred: " . $e->getMessage();


function sendMessage($service, $sender, $msg) 
  $service->users_messages->send($sender, $msg);


function createMessage($sender, $to, $subject, $messageText) 
  $rawMsgStr = "From: <$sender>\r\n";
  $rawMsgStr .= "To: <$to>\r\n";
  $rawMsgStr .= 'Subject: =?utf-8?B?' . base64_encode($subject) . "?=\r\n";
  $rawMsgStr .= "MIME-Version: 1.0\r\n";
  $rawMsgStr .= "Content-Type: text/html; charset=utf-8\r\n";
  $rawMsgStr .= 'Content-Transfer-Encoding: quoted-printable' . "\r\n\r\n";
  $rawMsgStr .= "$messageText\r\n";

  // The message needs to be encoded in Base64URL
  $mime = rtrim(strtr(base64_encode($rawMsgStr), '+/', '-_'), '=');
  $msg = new Google_Service_Gmail_Message();
  $msg->setRaw($mime);
  return $msg;

 ?>

【讨论】：

您将服务帐户凭据 JSON 文件放在哪里？高于public_html？我的意思是它是否需要受到保护，或者是否足以限制 Google 管理员对手头域的访问？