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 Redirect. См. Https://developers.google.com/identity/protocols/oauth2 для получения дополнительной информации).
Вернувшись на экран учетных данных, нажмите значок загрузки рядом с только что созданными учетными данными, чтобы загрузить его как объект JSON.
Сохраните этот файл как «client_secret.json» и поместите его в корневой каталог вашего приложения. (Класс Gmail принимает аргумент для имени этого файла, если вы решите назвать его иначе.)
В первый раз, когда вы создаете новый экземпляр класса Gmail , откроется окно браузера, и вам будет предложено дать разрешения для приложения. Это сохранит токен доступа в файле с именем "gmail-token.json", и ему нужно произойти только один раз.
Теперь ты хорошо ходишь!
Примечание о методе аутентификации: я решил не использовать аутентификацию имени пользователя (через 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 )) Для получения дополнительной информации о том, что вы можете сделать с запросами, прочитайте Docstring для construct_query() в query.py .
Если есть функциональность, которую вы хотели бы увидеть добавленными, или любые ошибки в этом проекте, пожалуйста, дайте мне знать, опубликуя проблему или отправив запрос на вытягивание!
