Skip to main content

No project description provided

Project description

Imbox - Python IMAP for Humans

workflow

Python library for reading IMAP mailboxes and converting email content to machine readable data

Requirements

Python (3.6, 3.7, 3.8, 3.9)

Installation

pip install imbox-sis

Usage

from imbox_sis import Imbox

# SSL Context docs https://docs.python.org/3/library/ssl.html#ssl.create_default_context

with Imbox('imap.gmail.com',
        username='username',
        password='password',
        ssl=True,
        ssl_context=None,
        starttls=False) as imbox:

    # Get all folders
    status, folders_with_additional_info = imbox.folders()

    # Gets all messages from the inbox
    all_inbox_messages = imbox.messages()

    # Unread messages
    unread_inbox_messages = imbox.messages(unread=True)

    # Flagged messages
    inbox_flagged_messages = imbox.messages(flagged=True)

    # Un-flagged messages
    inbox_unflagged_messages = imbox.messages(unflagged=True)

    # Flagged messages
    flagged_messages = imbox.messages(flagged=True)

    # Un-flagged messages
    unflagged_messages = imbox.messages(unflagged=True)

    # Messages sent FROM
    inbox_messages_from = imbox.messages(sent_from='sender@example.org')

    # Messages sent TO
    inbox_messages_to = imbox.messages(sent_to='receiver@example.org')

    # Messages received before specific date
    inbox_messages_received_before = imbox.messages(date__lt=datetime.date(2018, 7, 31))

    # Messages received after specific date
    inbox_messages_received_after = imbox.messages(date__gt=datetime.date(2018, 7, 30))

    # Messages received on a specific date
    inbox_messages_received_on_date = imbox.messages(date__on=datetime.date(2018, 7, 30))

    # Messages whose subjects contain a string
    inbox_messages_subject_christmas = imbox.messages(subject='Christmas')

    # Messages whose UID is greater than 1050
    inbox_messages_uids_greater_than_1050 = imbox.messages(uid__range='1050:*')

    # Messages from a specific folder
    messages_in_folder_social = imbox.messages(folder='Social')

    # Some of Gmail's IMAP Extensions are supported (label and raw):
    all_messages_with_an_attachment_from_martin = imbox.messages(folder='all', raw='from:martin@amon.cx has:attachment')
    all_messages_labeled_finance = imbox.messages(folder='all', label='finance')

    for uid, message in all_inbox_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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imbox_sis-0.9.11.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

imbox_sis-0.9.11-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file imbox_sis-0.9.11.tar.gz.

File metadata

  • Download URL: imbox_sis-0.9.11.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.8.3 Linux/3.10.0-1160.71.1.el7.x86_64

File hashes

Hashes for imbox_sis-0.9.11.tar.gz
Algorithm Hash digest
SHA256 eab5ebce5fbb8ac0715aa6afc2af500506742534b8d33748a8447d8794edc6c3
MD5 b7fd6c9f76ebd96ce57da2a145543460
BLAKE2b-256 8312b14718b4ed307f8dbc23026f044185c4b557b3f293c6a19164020c9b6f21

See more details on using hashes here.

File details

Details for the file imbox_sis-0.9.11-py3-none-any.whl.

File metadata

  • Download URL: imbox_sis-0.9.11-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.8.3 Linux/3.10.0-1160.71.1.el7.x86_64

File hashes

Hashes for imbox_sis-0.9.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5b0b0f5374f1e5131a44f50b29127bb7af0a6567723b8bd51f82ece9c68a2192
MD5 74d5da6c68ed6fb5a4bae868bdeb47c3
BLAKE2b-256 3d1d47c33be726799b11fa3de4420bd0ac1373980bbf7b6b1366b19c3c12a82a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page