Gmail API 发送邮件时如何解决“权限不足（403）”错误？

通过 Gmail API 发送电子邮件时解决 HttpError 403 权限不足错误

在使用 Python 通过 Gmail API 发送电子邮件时，你可能会遇到 HttpError 403 权限不足错误。本指南将指导你解决此错误，并通过 Gmail API 顺利发送电子邮件。

错误原因

该错误表示，用于访问 Gmail API 的身份验证凭据或访问令牌缺乏执行操作（例如发送电子邮件）所需的必要权限或范围。

解决步骤

1. 检查 OAuth 2.0 凭据

• 确保已在 Google Cloud 控制台中启用了 Gmail API。
• 确认已将 https://www.googleapis.com/auth/gmail.send 范围添加到 OAuth 2.0 凭据中。
• 验证 OAuth 2.0 凭据是否有效且未过期。

2. 验证 OAuth 2.0 流

• 确保正在使用适用于已安装应用程序的正确 OAuth 2.0 流。
• 参考 Google 官方文档以了解正确的流。

3. 检查权限

• 确认已授予发送电子邮件所需的权限。
• 检查 OAuth 2.0 凭据是否有 https://mail.google.com/ 权限。

4. 检查凭据文件

• 重新生成凭据文件，确保已正确保存在 token.json 中。
• 验证 credentials.json 文件的路径和完整性。

5. 检查代码

• 验证 Python 脚本是否正确使用 googleapiclient 库。
• 确保使用正确的 Gmail API 端点和方法。

附加建议

• 使用 google-auth-oauthlib 库管理 OAuth 2.0 凭据。
• 参考 Google 提供的示例代码。
• 提交错误报告到 Gmail API GitHub 存储库。

具体实施步骤（代码示例）

import base64
from email.mime.text import MIMEText
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def send_email(sender_email, receiver_email, subject, message_text):
    """Sends an email using the Gmail API.

    Args:
        sender_email: The sender's email address.
        receiver_email: The receiver's email address.
        subject: The subject of the email.
        message_text: The body of the email.
    """

    # Get credentials
    _, credentials = google.auth.default(
        scopes=["https://www.googleapis.com/auth/gmail.send"]
    )

    # Build Gmail API service
    service = build("gmail", "v1", credentials=credentials)

    # Base64 encode the email message
    encoded_message = base64.urlsafe_b64encode(message_text.encode("utf-8")).decode("utf-8")

    # Create the email object
    message = MIMEText(message_text)
    message["to"] = receiver_email
    message["from"] = sender_email
    message["subject"] = subject

    # Send the email
    try:
        message = {"raw": encoded_message}
        sent_message = service.users().messages().send(userId="me", body=message).execute()
        print(f"Email sent: {sent_message['id']}")
    except HttpError as error:
        print(f"An error occurred: {error}")


# Example usage
send_email("sender@example.com", "receiver@example.com", "Test Email", "Hello from Python!")

常见问题解答

Q1. 如何解决 Insufficient Permission 错误？
A1. 确认已授予必要的权限，并在 OAuth 2.0 凭据中添加 https://www.googleapis.com/auth/gmail.send 范围。

Q2. 如何检查 OAuth 2.0 凭据的有效性？
A2. 在命令行中运行以下命令：

gcloud auth application-default print-access-token

Q3. 如何调试 Python 脚本？
A3. 使用 pdb 库设置断点，并逐行执行脚本。

Q4. 如何使用 google-auth-oauthlib 库？
A4. 参考官方文档：https://google-auth-oauthlib.readthedocs.io/en/latest/

Q5. 如何防止 HttpError 403 错误？
A5. 定期检查 OAuth 2.0 凭据的有效性，并确保请求具有必要的权限。