Package: simplegmail
simplegmailA simple Gmail API client in Python for applications.Currently Supported Behavior:Sending html messagesSending messages with attachmentsSending messages with your Gmail account signatureRetrieving messages with the full suite of Gmail's search capabilitiesRetrieving messages with attachments, and downloading attachmentsModifying message labels (includes marking as read/unread, important/not
important, starred/unstarred, trash/untrash, inbox/archive)Table of ContentsGetting StartedInstallationUsageSend a simple messageSend a message with attachments, cc, bcc fieldsRetrieving messagesMarking messagesChanging message labelsDownloading attachmentsRetrieving messages with queriesRetrieving messages with more advanced queriesFeedbackGetting StartedThe only setup required is to download an OAuth 2.0 Client ID file from Google
that will authorize your application.This can be done at:https://console.developers.google.com/apis/credentials.
For those who haven't created a credential for Google's API, after clicking the
link above (and logging in to the appropriate account),Select/create the project that this authentication is for (if creating a new
project make sure to configure the OAuth consent screen; you only need to set
an Application name)Click on the "Dashboard" tab, then "Enable APIs and Services". Search for
Gmail and enable.Click on the Credentials tab, then "Create Credentials" > "OAuth client ID".Select what kind of application this is for, and give it a memorable name.
Fill out all necessary information for the credential (e.g., if choosing
"Web Application" make sure to add an Authorized Redirect URI. Seehttps://developers.google.com/identity/protocols/oauth2for more infomation).Back on the credentials screen, click the download icon next to the
credential you just created to download it as a JSON object.Save this file as "client_secret.json" and place it in the root directory of
your application. (TheGmailclass takes in an argument for the name of this
file if you choose to name it otherwise.)The first time you create a new instance of theGmailclass, a browser window
will open, and you'll be asked to give permissions to the application. This
will save an access token in a file named "gmail-token.json", and only needs to
occur once.You are now good to go!Note about authentication method: I have opted not to use a username-password
authentication (through imap/smtp), since using Google's authorization is both
significantly safer and avoids clashing with Google's many security measures.InstallationInstall usingpip(Python3).pip3installsimplegmailUsageSend a simple message:fromsimplegmailimportGmailgmail=Gmail()# will open a browser window to ask you to log in and authenticateparams={"to":"you@youremail.com","sender":"me@myemail.com","subject":"My first email","msg_html":"<h1>Woah, my first email!</h1><br />This is an HTML email.","msg_plain":"Hi\nThis is a plain text email.","signature":True# use my account signature}message=gmail.send_message(**params)# equivalent to send_message(to="you@youremail.com", sender=...)Send a message with attachments, cc, bcc fields:fromsimplegmailimportGmailgmail=Gmail()params={"to":"you@youremail.com","sender":"me@myemail.com","cc":["bob@bobsemail.com"],"bcc":["marie@gossip.com","hidden@whereami.com"],"subject":"My first email","msg_html":"<h1>Woah, my first email!</h1><br />This is an HTML email.","msg_plain":"Hi\nThis 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="you@youremail.com", sender=...)It couldn't be easier!Retrieving messages:fromsimplegmailimportGmailgmail=Gmail()# Unread messages in your inboxmessages=gmail.get_unread_inbox()# Starred messagesmessages=gmail.get_starred_messages()# ...and many more easy to use functions can be found in gmail.py!# Print them out!formessageinmessages: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.htmlMarking messages:fromsimplegmailimportGmailgmail=Gmail()messages=gmail.get_unread_inbox()message_to_read=messages[0]message_to_read.mark_as_read()# Oops, I want to mark as unread nowmessage_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!Changing message labels:fromsimplegmailimportGmailgmail=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(lambdax:x.name=='Finance',labels))[0]messages=gmail.get_unread_inbox()# We can add/remove a labelmessage=messages[0]message.add_label(finance_label)# We can "move" a message from one label to anothermessage.modify_labels(to_add=labels[10],to_remove=finance_label)# ...check out the code in message.py for more!Downloading attachments:fromsimplegmailimportGmailgmail=Gmail()messages=gmail.get_unread_inbox()message=messages[0]ifmessage.attachments:forattminmessage.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()`Retrieving messages (advanced, with queries!):fromsimplegmailimportGmailfromsimplegmail.queryimportconstruct_querygmail=Gmail()# Unread messages in inbox with label "Work"labels=gmail.list_labels()work_label=list(filter(lambdax: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.Retrieving messages (more advanced, with more queries!):fromsimplegmailimportGmailfromsimplegmail.queryimportconstruct_querygmail=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 separatelyquery_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))For more on what you can do with queries, read the docstring forconstruct_query()inquery.py.FeedbackIf there is functionality you'd like to see added, or any bugs in this project,
please let me know by posting an issue or submitting a pull request!