From 4d1f736948908ced2f8c9dc9c192e0adba96d760 Mon Sep 17 00:00:00 2001 From: Martin Rusev Date: Wed, 31 Jul 2013 08:47:59 +0300 Subject: [PATCH] Highlighted readme --- README.md | 122 +++++++++++++++++++++++++++--------------------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 90c6135..dfd1b66 100644 --- a/README.md +++ b/README.md @@ -18,76 +18,76 @@ or Usage ===== +```python +from imbox import Imbox - from imbox import Imbox +imbox = Imbox('imap.gmail.com', + username='username', + password='password', + ssl=True) - 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) + + +for message in all_messages: + ........ +# Every message is an object with the following keys - # Gets all messages - all_messages = imbox.messages() - - # Unread messages - unread_messages = imbox.messages(unread=True) + 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() - 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.body.plain - message.body.html - message.attachments +# To check the whole object, just write - # To check all available keys - print message.keys() - - - # To check the whole object, just write - - print message + print message + { + 'headers': + [{ + 'Name': 'Received-SPF', + 'Value': 'pass (google.com: domain of ......;' + }, { - 'headers': - [{ - 'Name': 'Received-SPF', - 'Value': 'pass (google.com: domain of ......;' - }, - { - 'Name': 'MIME-Version', - 'Value': '1.0' - }], - 'body': { - 'plain: ['ASCII'], - 'html': ['HTML BODY'] - }, - 'attachments': [{ - 'content': , - 'filename': "avatar.png", - 'content-type': 'image/png', - 'size': 80264 + 'Name': 'MIME-Version', + 'Value': '1.0' }], - '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' - } - + 'body': { + 'plain: ['ASCII'], + 'html': ['HTML BODY'] + }, + 'attachments': [{ + 'content': , + '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' + } +```