simplegmail
v4.1.1
Um cliente simples da API do Gmail em Python para aplicativos.
Comportamento atualmente suportado:
A única configuração necessária é baixar um arquivo de identificação de cliente OAuth 2.0 do Google que autorizará seu aplicativo.
Isso pode ser feito em: https://console.developers.google.com/apis/credentials. Para aqueles que não criaram uma credencial para a API do Google, depois de clicar no link acima (e fazer login na conta apropriada),
Selecione/Crie o projeto para o qual essa autenticação seja (se criar um novo projeto, certifique -se de configurar a tela de consentimento do OAuth; você só precisará definir um nome de aplicativo)
Clique na guia "Painel" e, em seguida, "Ative APIs e serviços". Procure por Gmail e habilite.
Clique na guia Credenciais e "Crie credenciais"> "ID do cliente OAuth".
Selecione para que tipo de aplicação é e dê um nome memorável. Preencha todas as informações necessárias para a credencial (por exemplo, se escolher o "aplicativo da web", adicione um URI de redirecionamento autorizado. Consulte https://developers.google.com/identity/protocols/oauth2 para obter mais informações).
De volta à tela Credenciais, clique no ícone Download próximo à credencial que você acabou de criar para baixá -lo como um objeto JSON.
Salve este arquivo como "client_secret.json" e coloque -o no diretório raiz do seu aplicativo. (A classe Gmail recebe um argumento para o nome deste arquivo, se você optar por nomeá -lo de outra forma.)
Na primeira vez em que você cria uma nova instância da classe Gmail , uma janela do navegador será aberta e você será solicitado a fornecer permissões ao aplicativo. Isso salvará um token de acesso em um arquivo chamado "gmail-token.json" e só precisa ocorrer uma vez.
Agora você está pronto para ir!
Observe sobre o método de autenticação: optei por não usar uma autenticação de nome de usuário-passa-palavra (através do IMAP/SMTP), pois usar a autorização do Google é significativamente mais seguro e evita conflitos com as muitas medidas de segurança do Google.
Instale usando 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=...)Não poderia ser mais fácil!
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 )) Para saber mais sobre o que você pode fazer com as consultas, leia o Docstring para construct_query() em query.py .
Se houver funcionalidade que você gostaria de ver adicionada ou qualquer bug neste projeto, informe -me postando um problema ou enviando uma solicitação de tração!
