Skip to main content

Python IMAP for Human beings

Project description

Imbox - Python IMAP for Humans
=======

[![Build Status](https://travis-ci.org/martinrusev/imbox.svg?branch=master)](https://travis-ci.org/martinrusev/imbox)


Python library for reading IMAP mailboxes and converting email content to machine readable data

Installation
============

pip install imbox


Usage
=====

```python
from imbox import Imbox

imbox = Imbox('imap.gmail.com',
username='username',
password='password',
ssl=True)

# Gets all messages
all_messages = imbox.messages()

# Unread messages
unread_messages = imbox.messages(unread=True)

# Messages sent FROM
messages_from = imbox.messages(sent_from='martin@amon.cx')

# Messages sent TO
messages_from = imbox.messages(sent_to='martin@amon.cx')

# Messages received before specific date
messages_from = imbox.messages(date__lt='31-July-2013')

# Messages received after specific date
messages_from = imbox.messages(date__gt='30-July-2013')

# Messages from a specific folder
messages_folder = imbox.messages(folder='Social')



for uid, message in all_messages:
........
# Every message is an object with the following keys

message.sent_from
message.sent_to
message.subject
message.headers
message.message_id
message.date
message.body.plain
message.body.html
message.attachments

# To check all available keys
print message.keys()


# To check the whole object, just write

print message

{
'headers':
[{
'Name': 'Received-SPF',
'Value': 'pass (google.com: domain of ......;'
},
{
'Name': 'MIME-Version',
'Value': '1.0'
}],
'body': {
'plain: ['ASCII'],
'html': ['HTML BODY']
},
'attachments': [{
'content': <StringIO.StringIO instance at 0x7f8e8445fa70>,
'filename': "avatar.png",
'content-type': 'image/png',
'size': 80264
}],
'date': u 'Fri, 26 Jul 2013 10:56:26 +0300',
'message_id': u '51F22BAA.1040606',
'sent_from': [{
'name': u 'Martin Rusev',
'email': 'martin@amon.cx'
}],
'sent_to': [{
'name': u 'John Doe',
'email': 'john@gmail.com'
}],
'subject': u 'Hello John, How are you today'
}
```

Roadmap
========
* Lazy email fetching
* Improved attachement handling
* Search mailboxes
* Manage labels
* Delete emails
* Compose emails

Project details


Download files

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

Source Distribution

imbox-0.7.tar.gz (7.0 kB view details)

Uploaded Source

File details

Details for the file imbox-0.7.tar.gz.

File metadata

  • Download URL: imbox-0.7.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for imbox-0.7.tar.gz
Algorithm Hash digest
SHA256 cfbb6e2ba463952cbc2588646217d20ed928cde59c1302225b8a4284cdc1b0c9
MD5 c32f51b721c84c51cc876982aec6d194
BLAKE2b-256 0b284210d4ad7f7d7a41d8558426008bcc6c9e8f098aece029987130bc2f860e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page