zev/imbox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imbox() usable as with statement

Browse Source
This commit is contained in:
Stephane Blondon
2017-09-17 22:57:05 +02:00
parent 64df2be0b5
commit 568dcb028a
2 changed files with 67 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
README.rst
View File

@@ -30,88 +30,88 @@ Usage
# SSL Context docs https://docs.python.org/3/library/ssl.html#ssl.create_default_context # SSL Context docs https://docs.python.org/3/library/ssl.html#ssl.create_default_context
imbox = Imbox('imap.gmail.com', with Imbox('imap.gmail.com',
username='username', username='username',
password='password', password='password',
ssl=True, ssl=True,
ssl_context=None) ssl_context=None) as imbox:
# Gets all messages # Gets all messages
all_messages = imbox.messages() all_messages = imbox.messages()
# Unread messages # Unread messages
unread_messages = imbox.messages(unread=True) unread_messages = imbox.messages(unread=True)
# Messages sent FROM # Messages sent FROM
messages_from = imbox.messages(sent_from='martin@amon.cx') messages_from = imbox.messages(sent_from='martin@amon.cx')
# Messages sent TO # Messages sent TO
messages_from = imbox.messages(sent_to='martin@amon.cx') messages_from = imbox.messages(sent_to='martin@amon.cx')
# Messages received before specific date # Messages received before specific date
messages_from = imbox.messages(date__lt='31-July-2013') messages_from = imbox.messages(date__lt='31-July-2013')
# Messages received after specific date # Messages received after specific date
messages_from = imbox.messages(date__gt='30-July-2013') messages_from = imbox.messages(date__gt='30-July-2013')
# Messages from a specific folder # Messages from a specific folder
messages_folder = imbox.messages(folder='Social') messages_folder = imbox.messages(folder='Social')
for uid, message in all_messages: for uid, message in all_messages:
# Every message is an object with the following keys # Every message is an object with the following keys
message.sent_from message.sent_from
message.sent_to message.sent_to
message.subject message.subject
message.headers message.headers
message.message_id message.message_id
message.date message.date
message.body.plain message.body.plain
message.body.html message.body.html
message.attachments message.attachments
# To check all available keys # To check all available keys
print(message.keys()) print(message.keys())
# To check the whole object, just write # To check the whole object, just write
print(message) print(message)
{
'headers':
[{
'Name': 'Received-SPF',
'Value': 'pass (google.com: domain of ......;'
},
{ {
'Name': 'MIME-Version', 'headers':
'Value': '1.0' [{
'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
}], }],
'body': { 'date': u 'Fri, 26 Jul 2013 10:56:26 +0300',
'plain': ['ASCII'], 'message_id': u '51F22BAA.1040606',
'html': ['HTML BODY'] 'sent_from': [{
}, 'name': u 'Martin Rusev',
'attachments': [{ 'email': 'martin@amon.cx'
'content': <StringIO.StringIO instance at 0x7f8e8445fa70>, }],
'filename': "avatar.png", 'sent_to': [{
'content-type': 'image/png', 'name': u 'John Doe',
'size': 80264 'email': 'john@gmail.com'
}], }],
'date': u 'Fri, 26 Jul 2013 10:56:26 +0300', 'subject': u 'Hello John, How are you today'
'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'
}
`Changelog <https://github.com/martinrusev/imbox/blob/master/CHANGELOG.md>`_ `Changelog <https://github.com/martinrusev/imbox/blob/master/CHANGELOG.md>`_

6
imbox/__init__.py
View File

@@ -21,6 +21,12 @@ class Imbox:
logger.info("Connected to IMAP Server with user {username} on {hostname}{ssl}".format( logger.info("Connected to IMAP Server with user {username} on {hostname}{ssl}".format(
hostname=hostname, username=username, ssl=(" over SSL" if ssl else ""))) hostname=hostname, username=username, ssl=(" over SSL" if ssl else "")))
def __enter__(self):
return self
def __exit__(self, type, value, traceback):
self.logout()
def logout(self): def logout(self):
self.connection.close() self.connection.close()
self.connection.logout() self.connection.logout()