imapy 1.0.1

Imap for humans

Imapy is an MIT Licensed IMAP library, written in Python. It makes processing emails in your email box easy.

Most existing Python modules for dealing with IMAP are extremely low-level. They require the programmer to know the intricacies of IMAP protocol and differences in IMAP server behaviour so that even simple tasks require writing hundred lines of code.

Imapy changes that.

>>> box = imapy.connect(
              host='imap.gmail.com',
              username='[e-mail]',
              password='secret',
              ssl=True)

Get all folder names:

>>> names = box.folders()

Get last 5 emails in ‘Inbox’ folder:

>>> emails = box.folder('Inbox').emails(-5)

Get unseen emails with Awesome in subject:

>>> q = Q()
>>> emails = box.folder('Inbox').emails(
>>>     q.subject('Awesome').unseen()
>>> )

Move messages sent by your boss to “Important” folder and mark them ‘Flagged’ and ‘Unseen’:

>>> q = Q()
>>> emails = box.folder('Inbox').emails(
>>>     q.sender('[e-mail]').unseen()
>>> )
>>> for email in emails:
>>>     email.move('Important').mark(['Flagged', 'Unseen'])
>>>

Print some email details:

>>> for email in emails:
>>>    print(email['from'], email['subject'])

Process all emails in ‘Inbox’ folder:

>>> status = box.folder('Inbox').info()
>>> total = status['total']
>>> for t in range(1, total + 1):
>>>     email = box.folder('Inbox').email(t)
>>>     print(email['subject'])

Logout

>>> box.logout()

Installation

To install Imapy, simply:

$ pip install imapy

TO-DO

• Create examples in separate folder

• Better documentation