simplegmail
v4.1.1
ไคลเอนต์ Gmail API อย่างง่ายใน Python สำหรับแอปพลิเคชัน
พฤติกรรมที่ได้รับการสนับสนุนในปัจจุบัน:
การตั้งค่าเพียงอย่างเดียวคือการดาวน์โหลดไฟล์รหัสไคลเอนต์ OAuth 2.0 จาก Google ที่จะอนุญาตแอปพลิเคชันของคุณ
สามารถทำได้ที่: https://console.developers.google.com/apis/credentials สำหรับผู้ที่ยังไม่ได้สร้างข้อมูลรับรองสำหรับ API ของ Google หลังจากคลิกลิงก์ด้านบน (และเข้าสู่ระบบในบัญชีที่เหมาะสม)
เลือก/สร้างโครงการที่การรับรองความถูกต้องนี้มีไว้สำหรับ (หากการสร้างโครงการใหม่ตรวจสอบให้แน่ใจว่าได้กำหนดค่าหน้าจอความยินยอม OAuth คุณต้องตั้งชื่อแอปพลิเคชันเท่านั้น)
คลิกที่แท็บ "แดชบอร์ด" จากนั้น "เปิดใช้งาน API และบริการ" ค้นหา Gmail และเปิดใช้งาน
คลิกที่แท็บข้อมูลรับรองจากนั้น "สร้างข้อมูลรับรอง"> "รหัสไคลเอนต์ OAuth"
เลือกประเภทของแอปพลิเคชันนี้และให้ชื่อที่น่าจดจำ กรอกข้อมูลที่จำเป็นทั้งหมดสำหรับข้อมูลประจำตัว (เช่นหากเลือก "เว็บแอปพลิเคชัน" ตรวจสอบให้แน่ใจว่าได้เพิ่ม URI ที่ได้รับอนุญาตให้ดูที่ https://developers.google.com/identity/protocols/oauth2 สำหรับการ infomation เพิ่มเติม)
ย้อนกลับไปที่หน้าจอข้อมูลรับรองคลิกไอคอนดาวน์โหลดถัดจากข้อมูลรับรองที่คุณเพิ่งสร้างขึ้นเพื่อดาวน์โหลดเป็นวัตถุ JSON
บันทึกไฟล์นี้เป็น "client_secret.json" และวางไว้ในไดเรกทอรีรูทของแอปพลิเคชันของคุณ (คลาส Gmail ใช้ในอาร์กิวเมนต์สำหรับชื่อของไฟล์นี้หากคุณเลือกที่จะตั้งชื่อเป็นอย่างอื่น)
ครั้งแรกที่คุณสร้างอินสแตนซ์ใหม่ของคลาส Gmail หน้าต่างเบราว์เซอร์จะเปิดขึ้นและคุณจะถูกขอให้อนุญาตให้ใช้แอปพลิเคชัน สิ่งนี้จะบันทึกโทเค็นการเข้าถึงในไฟล์ชื่อ "gmail-token.json" และจำเป็นต้องเกิดขึ้นเพียงครั้งเดียว
ตอนนี้คุณพร้อมแล้ว!
หมายเหตุเกี่ยวกับวิธีการตรวจสอบความถูกต้อง: ฉันเลือกที่จะไม่ใช้การรับรองความถูกต้องของชื่อผู้ใช้ Password (ผ่าน IMAP/SMTP) เนื่องจากการใช้การอนุญาตของ Google นั้นปลอดภัยกว่าและหลีกเลี่ยงการปะทะกับมาตรการรักษาความปลอดภัยมากมายของ Google
ติดตั้งโดยใช้ pip (Python3)
pip3 install simplegmail from simplegmail import Gmail
gmail = Gmail () # will open a browser window to ask you to log in and authenticate
params = {
"to" : "[email protected]" ,
"sender" : "[email protected]" ,
"subject" : "My first email" ,
"msg_html" : "<h1>Woah, my first email!</h1><br />This is an HTML email." ,
"msg_plain" : "Hi n This is a plain text email." ,
"signature" : True # use my account signature
}
message = gmail . send_message ( ** params ) # equivalent to send_message(to="[email protected]", sender=...) from simplegmail import Gmail
gmail = Gmail ()
params = {
"to" : "[email protected]" ,
"sender" : "[email protected]" ,
"cc" : [ "[email protected]" ],
"bcc" : [ "[email protected]" , "[email protected]" ],
"subject" : "My first email" ,
"msg_html" : "<h1>Woah, my first email!</h1><br />This is an HTML email." ,
"msg_plain" : "Hi n This is a plain text email." ,
"attachments" : [ "path/to/something/cool.pdf" , "path/to/image.jpg" , "path/to/script.py" ],
"signature" : True # use my account signature
}
message = gmail . send_message ( ** params ) # equivalent to send_message(to="[email protected]", sender=...)มันไม่ง่ายกว่านี้!
from simplegmail import Gmail
gmail = Gmail ()
# Unread messages in your inbox
messages = gmail . get_unread_inbox ()
# Starred messages
messages = gmail . get_starred_messages ()
# ...and many more easy to use functions can be found in gmail.py!
# Print them out!
for message in messages :
print ( "To: " + message . recipient )
print ( "From: " + message . sender )
print ( "Subject: " + message . subject )
print ( "Date: " + message . date )
print ( "Preview: " + message . snippet )
print ( "Message Body: " + message . plain ) # or message.html from simplegmail import Gmail
gmail = Gmail ()
messages = gmail . get_unread_inbox ()
message_to_read = messages [ 0 ]
message_to_read . mark_as_read ()
# Oops, I want to mark as unread now
message_to_read . mark_as_unread ()
message_to_star = messages [ 1 ]
message_to_star . star ()
message_to_trash = messages [ 2 ]
message_to_trash . trash ()
# ...and many more functions can be found in message.py! from simplegmail import Gmail
gmail = Gmail ()
# Get the label objects for your account. Each label has a specific ID that
# you need, not just the name!
labels = gmail . list_labels ()
# To find a label by the name that you know (just an example):
finance_label = list ( filter ( lambda x : x . name == 'Finance' , labels ))[ 0 ]
messages = gmail . get_unread_inbox ()
# We can add/remove a label
message = messages [ 0 ]
message . add_label ( finance_label )
# We can "move" a message from one label to another
message . modify_labels ( to_add = labels [ 10 ], to_remove = finance_label )
# ...check out the code in message.py for more! from simplegmail import Gmail
gmail = Gmail ()
messages = gmail . get_unread_inbox ()
message = messages [ 0 ]
if message . attachments :
for attm in message . attachments :
print ( 'File: ' + attm . filename )
attm . save () # downloads and saves each attachment under it's stored
# filename. You can download without saving with `attm.download()` from simplegmail import Gmail
from simplegmail . query import construct_query
gmail = Gmail ()
# Unread messages in inbox with label "Work"
labels = gmail . list_labels ()
work_label = list ( filter ( lambda x : x . name == 'Work' , labels ))[ 0 ]
messages = gmail . get_unread_inbox ( labels = [ work_label ])
# For even more control use queries:
# Messages that are: newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
query_params = {
"newer_than" : ( 2 , "day" ),
"unread" : True ,
"labels" :[[ "Work" ], [ "Homework" , "CS" ]]
}
messages = gmail . get_messages ( query = construct_query ( query_params ))
# We could have also accomplished this with
# messages = gmail.get_unread_messages(query=construct_query(newer_than=(2, "day"), labels=[["Work"], ["Homework", "CS"]]))
# There are many, many different ways of achieving the same result with search. from simplegmail import Gmail
from simplegmail . query import construct_query
gmail = Gmail ()
# For even more control use queries:
# Messages that are either:
# newer than 2 days old, unread, labeled "Finance" or both "Homework" and "CS"
# or
# newer than 1 month old, unread, labeled "Top Secret", but not starred.
labels = gmail . list_labels ()
# Construct our two queries separately
query_params_1 = {
"newer_than" : ( 2 , "day" ),
"unread" : True ,
"labels" :[[ "Finance" ], [ "Homework" , "CS" ]]
}
query_params_2 = {
"newer_than" : ( 1 , "month" ),
"unread" : True ,
"labels" : [ "Top Secret" ],
"exclude_starred" : True
}
# construct_query() will create both query strings and "or" them together.
messages = gmail . get_messages ( query = construct_query ( query_params_1 , query_params_2 )) สำหรับข้อมูลเพิ่มเติมเกี่ยวกับสิ่งที่คุณสามารถทำได้กับการสืบค้นอ่านเอกสารสำหรับ construct_query() ใน query.py
หากมีฟังก์ชั่นที่คุณต้องการดูเพิ่มเติมหรือข้อบกพร่องใด ๆ ในโครงการนี้โปรดแจ้งให้เราทราบโดยการโพสต์ปัญหาหรือส่งคำขอดึง!
