Skip to content

Commit

Permalink
clarified in documentation and Imbox.messages logging that, unless a …
Browse files Browse the repository at this point in the history
…folder is specified in the kwargs to Imbox.messages, the returned messages will be from the inbox. In the documentation this is accomplished exclusively by the var names. fixes martinrusev#128.
  • Loading branch information
zevaverbach committed Jul 25, 2018
1 parent bd61f8e commit 8df7d7c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,38 +39,38 @@ Usage
# Get all folders
status, folders_with_additional_info = imbox.folders()
# Gets all messages
all_messages = imbox.messages()
# Gets all messages in the inbox
inbox_messages = imbox.messages()
# Unread messages
unread_messages = imbox.messages(unread=True)
inbox_unread_messages = imbox.messages(unread=True)
# Flagged messages
flagged_messages = imbox.messages(flagged=True)
inbox_flagged_messages = imbox.messages(flagged=True)
# Un-flagged messages
unflagged_messages = imbox.messages(unflagged=True)
inbox_unflagged_messages = imbox.messages(unflagged=True)
# Messages sent FROM
messages_from_martin = imbox.messages(sent_from='martin@amon.cx')
inbox_messages_from_martin = imbox.messages(sent_from='martin@amon.cx')
# Messages sent TO
messages_to_martin = imbox.messages(sent_to='martin@amon.cx')
inbox_messages_to_martin = imbox.messages(sent_to='martin@amon.cx')
# Messages received before specific date
messages_received_before_20130731 = imbox.messages(date__lt=datetime.date(2013, 7, 31))
inbox_messages_received_before_20130731 = imbox.messages(date__lt=datetime.date(2013, 7, 31))
# Messages received after specific date
messages_received_after_20130730 = imbox.messages(date__gt=datetime.date(2013, 7, 30))
inbox_messages_received_after_20130730 = imbox.messages(date__gt=datetime.date(2013, 7, 30))
# Messages received on a specific date
messages_received_20130730 = imbox.messages(date__on=datetime.date(2013, 7, 30))
inbox_messages_received_20130730 = imbox.messages(date__on=datetime.date(2013, 7, 30))
# Messages whose subjects contain a string
messages_subject_christmas = imbox.messages(subject='Christmas')
inbox_messages_subject_christmas = imbox.messages(subject='Christmas')
# Messages from a specific folder
messages_in_folder_social = imbox.messages(folder='Social')
social_messages = imbox.messages(folder='Social')
for uid, message in all_messages:
# Every message is an object with the following keys
Expand Down
3 changes: 2 additions & 1 deletion imbox/imbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@ def move(self, uid, destination_folder):

def messages(self, **kwargs):
folder = kwargs.get('folder', False)
msg = ""

if folder:
self.connection.select(folder)
msg = " from folder '{}'".format(folder)
else:
msg = " from inbox"

logger.info("Fetch list of messages{}".format(msg))
return Messages(connection=self.connection,
Expand Down

0 comments on commit 8df7d7c

Please sign in to comment.