diff --git a/README.md b/README.md index 1c14b5a..103e861 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Mailbox - Python IMAP for Humans +Imbox - Python IMAP for Humans ======= Python library for reading IMAP mailboxes and converting the email content to human readable data @@ -6,12 +6,12 @@ Python library for reading IMAP mailboxes and converting the email content to hu Installation ============ - pip install mailbox + pip install imbox or - git clone git@github.com:martinrusev/mailbox.git + git clone git@github.com:martinrusev/imbox.git python setup.py install @@ -19,18 +19,18 @@ Usage ===== - from mailbox import MailBox + from imbox import Imbox - mailbox = MailBox('imap.gmail.com', + imbox = Imbox('imap.gmail.com', username='username', password='password', ssl=True) # Gets all messages - all_messages = mailbox.messages() + all_messages = imbox.messages() # Unread messages - unread_messages = mailbox.messages(unread=True) + unread_messages = imbox.messages(unread=True) for message in all_messages: diff --git a/mailbox/__init__.py b/imbox/__init__.py similarity index 96% rename from mailbox/__init__.py rename to imbox/__init__.py index 74a03d0..a2ab2de 100644 --- a/mailbox/__init__.py +++ b/imbox/__init__.py @@ -1,8 +1,8 @@ import email import re import StringIO -from mailbox.imap import ImapTransport -from mailbox.parser import get_mail_addresses, decode_mail_header +from imbox.imap import ImapTransport +from imbox.parser import get_mail_addresses, decode_mail_header class Struct(object): @@ -16,7 +16,7 @@ class Struct(object): return str(self.__dict__) -class MailBox(object): +class Imbox(object): def __init__(self, hostname, username=None, password=None, ssl=True): diff --git a/mailbox/imap.py b/imbox/imap.py similarity index 100% rename from mailbox/imap.py rename to imbox/imap.py diff --git a/mailbox/parser.py b/imbox/parser.py similarity index 100% rename from mailbox/parser.py rename to imbox/parser.py diff --git a/setup.py b/setup.py index 0d384d4..7731b45 100644 --- a/setup.py +++ b/setup.py @@ -8,17 +8,17 @@ def read(filename): return open(os.path.join(os.path.dirname(__file__), filename)).read() setup( - name='mailbox', + name='imbox', version=version, - description="Python IMAP for Humans", + description="Python IMAP for Human beings", long_description= read('README.md'), keywords='email, IMAP, parsing emails', author='Martin Rusev', author_email='martinrusev@live.com', - url='https://github.com/martinrusev/mailbox', + url='https://github.com/martinrusev/imbox', license='MIT', - packages=['mailbox'], - package_dir={'mailbox':'mailbox'}, + packages=['imbox'], + package_dir={'imbox':'imbox'}, zip_safe=False, install_requires=[],