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

Added missing documentation for all supported query keyword arguments. Fixes #124.

Browse Source
This commit is contained in:
zevav
2018-07-25 08:22:04 -04:00
parent a1801af56e
commit b53a1e6837
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.rst
View File

@@ -45,6 +45,12 @@ Usage
# Unread messages
unread_messages = imbox.messages(unread=True)
# Flagged messages
unread_messages = imbox.messages(flagged=True)
# Un-flagged messages
unread_messages = imbox.messages(unflagged=True)
# Messages sent FROM
messages_from = imbox.messages(sent_from='martin@amon.cx')
@@ -60,11 +66,12 @@ Usage
# Messages received on a specific date
messages_from = imbox.messages(date__on=datetime.date(2013, 7, 30))
# Messages whose subjects contain a string
messages_from = imbox.messages(subject='Christmas')
# 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