Python中的Gmail API

2025 年 8 月 28 日 | 阅读 9 分钟

在本教程中，我们将学习 Python 中的 Gmail API，还将学习如何在 Python 中使用 Gmail API 来执行许多 Gmail 操作，例如发送电子邮件、搜索电子邮件、删除电子邮件等。为此，我们将学习在 Python 脚本中设置 Gmail API。首先，让我们简要介绍一下 Gmail API 及其基本概念。

Gmail API

Gmail 是当今世界上最流行的邮件服务，几乎我们所有人以及许多组织都在使用它。过去几年，许多 Gmail 功能通过使用 AI 得到了增强，包括撰写电子邮件时的建议和安全功能（检测欺诈和垃圾邮件）。

Gmail API 是基于 RESTful API 的 API，它允许用户与我们的 Gmail 帐户进行交互，并帮助我们使用 Python 脚本使用其功能。

在 Python 中使用 Gmail API 的先决条件

要在我们的 Python 脚本中使用 Gmail API，我们必须满足以下要求：

我们的 Python 版本应高于或等于 2.6。
我们必须拥有一个已启用 Gmail 服务的 Google 帐户。
系统中必须安装 BeautifulSoup 库（如果未安装，则应在命令行终端中使用“pip install bsp”命令将其安装在我们的设备上）。
我们应该具备 Google OAuth 库和 Google API 客户端的基本知识。

安装必需的库

在启用 Gmail API 以在我们的 Python 脚本中使用它们之前，让我们先在系统中安装预先需要的库。要安装启用 Gmail API 的预先需要的库，我们应遵循以下步骤：

步骤 1：打开系统的命令提示符终端，并确保我们的设备具有有效的 Internet 连接。

步骤 2：在终端中输入以下命令：

pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

现在，按 Enter 键开始安装库。

正如我们所见，启用 Gmail API 的预先需要的库已成功安装在我们的系统中。现在，我们可以继续本教程中启用 Gmail API 的部分。

在我们的设备上启用 Gmail API

我们必须遵循以下步骤在我们的设备上启用 Gmail API，以便我们可以在 Python 脚本中使用这些 API：

步骤 1：在 Google Cloud 控制台中创建新项目

在此步骤中，首先，我们必须使用我们的 Google 帐户登录 Google Cloud 控制台 (https://console.cloud.google.com/?pli=1)，然后单击“新建项目”来创建新项目。

如果我们已经有一个现有项目，那么我们也可以继续使用该现有项目。

步骤 2：现在，我们必须从我们创建的项目菜单中转到 API 和服务选项。

步骤 3：现在，我们可以看到“启用 Gmail API 和服务”选项，我们必须选择此选项来为项目启用 Gmail API。

步骤 4：配置同意屏幕

现在，在此步骤中，我们将通过单击菜单中提供的 “OAuth 同意屏幕” 选项来配置我们创建的项目同意屏幕。仅当同意屏幕尚未配置时，我们才能看到此选项。

步骤 5：现在，我们必须输入我们选择的应用程序名称并保存项目。

步骤 6：现在，单击凭据选项并转到凭据。

步骤 7：创建 OAuth Client ID

现在，我们单击 “创建凭据” 选项并转到 OAuth Client ID 来创建它。

我们通过遵循以下顺序程序来创建新 OAuth Client ID 以用于我们的项目：

首先，我们将应用程序类型选择为项目桌面应用程序。
之后，我们输入应用程序名称（可以是我们在上述步骤中设置的相同名称，也可以是不同的名称）并单击创建按钮。
现在，将为我们的项目创建 OAuth 客户端 ID，我们将其下载并以“credentials.json”的名称和格式保存以备将来参考。

现在，我们已经完成了启用 Gmail API 的所有步骤，并且可以开始在我们的 Python 脚本中使用 Gmail API 了。

注意：我们必须保存客户端 ID 和密码，以便在将来需要时使用它们。

导入必要的模块

现在，我们已经设置了所有必要的 API，应该继续导入所有必要的模块。让我们看下面的导入模块示例。

示例 -

# Importing os and pickle module in program
import os
import pickle
# Creating utils for Gmail APIs
from googleapiclient.discovery import build
from google_auth_oauthlib.flow import InstalledAppFlow
from google.auth.transport.requests import Request
# Importing libraries for encoding/decoding messages in base64
from base64 import urlsafe_b64decode, urlsafe_b64encode
# Importing libraries for dealing with the attachment of MIME types in Gmail
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
from email.mime.image import MIMEImage
from email.mime.audio import MIMEAudio
from email.mime.base import MIMEBase
from email.mime.multipart import MIMEMultipart
from mimetypes import guess_type as guess_mime_type

# Request all access from Gmail APIs and project
SCOPES = ['https://mail.google.com/']
OurEmailID = 'OurMail@gmail.com' # giving our Gmail Id

# using a default function to authenticate Gmail APIs
def authenticateGmailAPIs():
    creds = None
    # Authorizing the Gmail APIs with tokens of pickles
    if os.path.exists("token.pickle"): # using if else statement
        with open("token.pickle", "rb") as token:
            creds = pickle.load(token)
    # If there are no valid credentials available in device, we will let the user sign in manually
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file('client_secret_107196167488-dh4b2pmpivffe011kic4em9a4ugrcooi.apps.googleusercontent.com.json', SCOPES) # downloaded credential name
            creds = flow.run_local_server(port=0) # running credentials
        # Save the credentials for the next run
        with open("token.pickle", "wb") as token:
            pickle.dump(creds, token)
    return build('Gmail', 'v1', credentials=creds) # using Gmail to authenticate

# Get the Gmail API service by calling the function
service = authenticateGmailAPIs()

输出

Please visit this URL to authorize this application: https://#/o/oauth2/auth?response_type=code&client_id=107196167488-dh4b2pmpivffe011kic4em9a4ugrcooi.apps.googleusercontent.com&redirect_uri=http%3A%2F%2Flocalhost%3A55991%2F&scope=https%3A%2F%2Fmail.google.com%2F&state=kfXlNyjvbKetyUK0op7OF9WY7shrKS&access_type=offline

解释 -

当我们运行上面给出的程序时，我们会看到一个选择浏览器的选项，就像我们在上面的图片中看到的那样，如果我们没有看到这样的选项，我们需要单击输出中给出的链接。然后，我们可以选择我们选择的浏览器或系统的默认浏览器来继续该过程。现在，当我们选择浏览器时，我们将被重定向到我们的浏览器，并在其中看到以下选项卡：

现在，我们勾选对话框中显示的复选框以授予所需的权限，然后单击继续选项。单击继续后，我们将在同一选项卡中看到以下窗口：

正如窗口所示，用于启用 Gmail API 的身份验证部分已完成，并且我们已将我们的 Gmail 帐户与为我们创建的 Gmail API 项目相关联。

注意：当然，我们必须在 '[email protected]' 的位置放入我们可以连接到 Gmail API 并用于将来引用的邮件，如上面程序中提供的。

使用 Python 中的 Gmail API 执行操作

现在，我们已经完全设置并启用了我们的项目中的 Gmail API 以及 Python 脚本。现在，我们可以通过 Python 程序执行许多 Gmail 帐户的操作。

我们可以使用 Python 脚本通过其中的 Gmail API 执行以下 Gmail 操作：

发送电子邮件
搜索电子邮件
删除电子邮件或整个电子邮件历史记录
读取电子邮件
将电子邮件标记为已读/未读等。

在本教程中，我们将只介绍如何使用 Python 程序中的 Gmail API 发送电子邮件，并将学习如何编写代码来执行此操作。

发送电子邮件

我们可以通过编写一个 Python 程序并使用其中启用的 Gmail API 来简单地编写和发送电子邮件。在这里，在本节中，我们将编写一个 Python 程序，通过该程序，我们只需运行该程序就可以从我们的 Gmail 帐户发送电子邮件。

请看以下 Python 程序以更好地理解：

示例 -

# importing os and pickle module in program
import os
import pickle
# Creating utils for Gmail APIs
from googleapiclient.discovery import build
from google_auth_oauthlib.flow import InstalledAppFlow
from google.auth.transport.requests import Request
# Importing libraries for encoding/decoding messages in base64
from base64 import urlsafe_b64decode, urlsafe_b64encode
# Importing libraries for dealing with the attachment of MIME types in Gmail
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
from email.mime.image import MIMEImage
from email.mime.audio import MIMEAudio
from email.mime.base import MIMEBase
from email.mime.multipart import MIMEMultipart
from mimetypes import guess_type as guess_mime_type

# Request all access from Gmail APIs and project
SCOPES = ['https://mail.google.com/'] # providing the scope for Gmail APIs
OurEmailID = 'OurMail@gmail.com' # giving our Gmail Id

# using a default function to authenticate Gmail APIs
def authenticateGmailAPIs():
    creds = None
    # authorizing the Gmail APIs with tokens of pickles
    if os.path.exists("token.pickle"): # using if else statement
        with open("token.pickle", "rb") as token:
            creds = pickle.load(token)
    # if there are no valid credentials available in device, we will let the user sign in manually
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file('client_secret_107196167488-dh4b2pmpivffe011kic4em9a4ugrcooi.apps.googleusercontent.com.json', SCOPES) # downloaded credential name
            creds = flow.run_local_server(port=0) # running credentials
        # save the credentials for the next run
        with open("token.pickle", "wb") as token:
            pickle.dump(creds, token)
    return build('gmail', 'v1', credentials=creds) # using Gmail to authenticate

# Get the Gmail API service by calling the function
ServicesGA = authenticateGmailAPIs()

# Using a default funnction to add attachments in Mail
def AddAttachment(mail, NameofFile):
    content_type, encoding = guess_mime_type(NameofFile)
    if content_type is None or encoding is not None: # defining none file type attachment
        content_type = 'application/octet-stream'
    main_type, sub_type = content_type.split('/', 1)
    if main_type == 'text': # defining text file type attachment
        fp = open(NameofFile, 'rb') # opening file
        msg = MIMEText(fp.read().decode(), _subtype = sub_type)
        fp.close() 
    elif main_type == 'image': # defining image file type attachment
        fp = open(NameofFile, 'rb')
        msg = MIMEImage(fp.read(), _subtype = sub_type)
        fp.close()
    elif main_type == 'audio': # defining audio file type attachment
        fp = open(NameofFile, 'rb')
        msg = MIMEAudio(fp.read(), _subtype = sub_type) # reading file
        fp.close()
    else:
        fp = open(NameofFile, 'rb')
        msg = MIMEBase(main_type, sub_type)
        msg.set_payload(fp.read())
        fp.close() # closing file
    NameofFile = os.path.basename(NameofFile)
    msg.add_header('Content-Disposition', 'attachment', NameofFile = NameofFile)
    mail.attach(msg) # composing the mail with given attachment

# Creating mail with a default function
def CreateMail(RecieverMail, SubofMail, BodyofMail, attachments=[]): # various import content of mail as function's parameter
    # Using if else to check if there is any attachment in mail or not
    if not attachments: # no attachment is given in the mail
        mail = MIMEText(BodyofMail) # Body of Mail
        mail['to'] = RecieverMail # mail ID of Reciever
        mail['from'] = OurEmailID # our mail ID
        mail['subject'] = SubofMail # Subject of Mail
    else: # attachment is given in the mail
        mail = MIMEMultipart()
        mail['to'] = RecieverMail
        mail['from'] = OurEmailID
        mail['subject'] = SubofMail
        mail.attach(MIMEText(BodyofMail))
        for NameofFile in attachments:
            AddAttachment(mail, NameofFile)
    return {'raw': urlsafe_b64encode(mail.as_bytes()).decode()}

# Creating a default function to send a mail
def SendMail(ServicesGA, RecieverMail, SubofMail, BodyofMail, attachments=[]):
    return ServicesGA.users().messages().send(
      userId = "me",
      body = CreateMail(RecieverMail, SubofMail, BodyofMail, attachments)
    ).execute() # Body of the mail with execute() function

# Sending an email by adding important content, i.e., Reciever's mail, Subject, Body, etc.
SendMail(ServicesGA, "Reciever@gmail.com", "Python Project i.e., This is the subject of Mail we are sendimg!", 
            "Now, this is the body of the email we are writing and we can add only written text here!", ["test.txt", "client_secret_107196167488-dh4b2pmpivffe011kic4em9a4ugrcooi.apps.googleusercontent.com.json"]) # calling out default SendMail() function

输出

如果我们把我们的邮件放在收件人邮件的位置，即 [email protected]，当我们运行程序时，我们会发现邮件已实际发送到我们输入的收件人邮件，就像我们在上面的输出图像中所看到的。

结论

要使用 Gmail API 和我们的 Python 脚本，或者简单地在 Python 中使用，我们首先需要启用它们，并使用我们的 Gmail 帐户在 Google Cloud 中创建一个项目。

我们还可以使用 Python 程序中的 Gmail API 执行许多其他操作，例如读取、删除等，就像发送电子邮件一样。我们还可以通过运行我们的 Python 脚本（已启用 Gmail API）来修改我们通过 Gmail API 项目进行身份验证的 Gmail 帐户中的许多内容。

下一主题如何在 Python 中使用 folium 包绘制 Google 地图

Python中的Gmail API

Gmail API

在 Python 中使用 Gmail API 的先决条件

安装必需的库

在我们的设备上启用 Gmail API

注意：我们必须保存客户端 ID 和密码，以便在将来需要时使用它们。

注意：当然，我们必须在 '[email protected]' 的位置放入我们可以连接到 Gmail API 并用于将来引用的邮件，如上面程序中提供的。

使用 Python 中的 Gmail API 执行操作

发送电子邮件

结论

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Python教程

Python变量和数据类型

Python控制语句

Python数据结构

Python函数

Python模块

Python OOP

Python异常处理

Python文件处理

Python搜索和排序

Python高级主题

Python MySQL

Python MongoDB

Python SQLite

Python MCQ

Python Tkinter (GUI)

Python Web Blocker

Python内置函数

Python字符串函数

Python列表

Python字典

Plotly

相关教程

Python中的Gmail API

Gmail API

在 Python 中使用 Gmail API 的先决条件

安装必需的库

在我们的设备上启用 Gmail API

注意：我们必须保存客户端 ID 和密码，以便在将来需要时使用它们。

注意：当然，我们必须在 '[email protected]' 的位置放入我们可以连接到 Gmail API 并用于将来引用的邮件，如上面程序中提供的。

使用 Python 中的 Gmail API 执行操作

发送电子邮件

结论

相关帖子

Python正则表达式

Python日期

Python魔术方法

Python中的nsetools

如何使用GEOPY计算两点之间的距离

Python多处理

Python IDE

Python堆栈和队列

如何使用Python中的folium包绘制Google地图

Python Itertools

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器