Skip to main content
Mailbox - Python IMAP for Humans
=======

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

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

pip install mailbox


or

git clone git@github.com:martinrusev/mailbox.git
python setup.py install


Usage
=====


from mailbox import MailBox

mailbox = MailBox('imap.gmail.com',
username='username',
password='password',
ssl=True)

# Gets all messages
all_messages = mailbox.messages()

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


for 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.text_body

# 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'
}],
'text_body': ['ASCII'],
'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'
}

TODO
======

- Replace the dictionaries with objects and generators
- Add logging and exceptions
- Implement smarter header parsing

Metadata

Release files for mailbox 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mailbox 0.4
File Size Uploaded
mailbox-0.4.tar.gz 4.1 kB Details

Release files / mailbox-0.4.tar.gz

Download URL mailbox-0.4.tar.gz
Size 4.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f9bf9679932f7a245902d33924dff11485bcf49cac0526f1a5eb9550bc510d73
BLAKE2b-256 checksum
How to use checksums
8d8ca5fc222a2fc8a915b572b14a59b7939f08b011f7f2118f61a3fd15cc0655
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.4 This release

1 release file

0.3.3

0.3.2

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page