Update README.rst

This commit is contained in:
Martin Rusev
2018-07-26 14:45:34 +02:00
committed by GitHub
parent 34149efed5
commit 63bddbd73c

View File

@@ -36,32 +36,33 @@ Usage
ssl=True,
ssl_context=None,
starttls=False) as imbox:
# Get all folders
status, folders_with_additional_info = imbox.folders()
# Gets all messages
# Gets all messages from the inbox
all_messages = imbox.messages()
# Unread messages
unread_messages = imbox.messages(unread=True)
# Messages sent FROM
messages_from = imbox.messages(sent_from='martin@amon.cx')
messages_from = imbox.messages(sent_from='sender@example.org')
# Messages sent TO
messages_from = imbox.messages(sent_to='martin@amon.cx')
messages_to = imbox.messages(sent_to='receiver@example.org')
# Messages received before specific date
messages_from = imbox.messages(date__lt=datetime.date(2013, 7, 31))
messages_received_before = imbox.messages(date__lt=datetime.date(2018, 7, 31))
# Messages received after specific date
messages_from = imbox.messages(date__gt=datetime.date(2013, 7, 30))
messages_received_after = imbox.messages(date__gt=datetime.date(2018, 7, 30))
# Messages received on a specific date
messages_from = imbox.messages(date__on=datetime.date(2013, 7, 30))
messages_received_on_date = imbox.messages(date__on=datetime.date(2018, 7, 30))
# Messages from a specific folder
messages_folder = imbox.messages(folder='Social')
messages_from_folder = imbox.messages(folder='Social')