Skip to main content

Unofficial Gmail python client with pythonic API.

Project description

gmaily

Unofficial Gmail python client with pythonic API.

Features

  • [x] Clean API
  • [x] No other dependencies than standard library
  • [ ] Lazy loading for content

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 famous ORMs use it too.

Some other criterias are omitted too:

  • NOT
  • OR
  • UID

Installation

It requires Python>=3.5.

$ pip3 install -U gmaily

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gmaily, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size gmaily-0.0.3-py3-none-any.whl (4.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size gmaily-0.0.3.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page