Pythonic Gmail client
Project description
Pythonic Gmail client (WIP)
Features
[x] Clean API
[x] No other dependencies than standard libraries
[x] Supports all of the SEARCH criteria
[-] Supports access to all of the HEADER fields via attributes
[ ] Lazy loading for contents
Example
import sys
import getpass
import datetime
from gmaily import Gmaily
g = Gmaily()
user_email = input('Email: ')
user_pw = getpass.getpass()
if not g.login(user_email, user_pw):
print('Cannot login')
sys.exit(1)
msgs = g.inbox().after(datetime.date.today() - datetime.timedelta(weeks=2))
for msg in msgs.all():
print('\n' + (' Mail UID: %d ' % msg.uid).center(80, '=') + '\n')
print('Subject:', msg.subject)
print('From:', msg.sender)
print('Date:', msg.date)
print('Attachments:', msg.attachments)
print('-' * 10)
print(msg.text)
g.logout()
Usage
Searching Mailbox
SearchQuery, which is returned by some methods like Gmaily.inbox supports method chaining and you can easily mix search criterias together:
two_weeks_ago = datetime.date.today() - datetime.timedelta(weeks=2)
msgs = g.inbox().by('john@example.com').before(two_weeks_ago)
Alternatively, you can use other mailboxes than INBOX in the above example using Gmaily.mailbox method:
msgs = g.mailbox('URGENT').on(datetime.date.today())
You can then execute the query and fetch the results using SearchQuery.all:
print(msgs.all())
You can find the full list of supported criterias and their description at here. Note that ALL criteria is not present because it’s the default criteria and SearchQuery.all stands for executing the query. Any other names like .fetch(), .do() could be taken the place, but I chose the .all() because it looks similar than famous ORMs’.
And some other criterias are omitted too:
NOT
OR
UID
Installation
Currently it requires Python 3.
$ pip install gmaily
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.