IMAPClient 2.0.0__tar.gz → 4.0.0__tar.gz

imapclient-4.0.0/AUTHORS.rst

@@ -0,0 +1,51 @@
+IMAPClient was created by Menno Finlay-Smits <inbox@menno.io>. The
+project is now maintained by Nicolas Le Manchet and Menno
+Finlay-Smits.
+
+Many thanks go to the following people for their help with this
+project:
+
+- Maxime Lorant
+- Mathieu Agopian
+- Chris Arndt
+- Jp Calderone
+- John Louis del Rosario
+- Dave Eckhardt
+- Eben Freeman
+- Helder Guerreiro
+- Mark Hammond
+- Johannes Heckel
+- Thomas Jost
+- Lukasz Mierzwa
+- Naveen Nathan
+- Brian Neal
+- Phil Peterson
+- Aviv Salem
+- Andrew Scheller
+- Thomas Steinacher
+- Zac Witte
+- Hans-Peter Jansen
+- Carson Ip
+- Jonny Hatch
+- Jasper Spaans
+- Fabio Manganiello
+- Samir M
+- Devin Bayer
+- Mantas Mikulėnas
+- @zrose584
+- Michał Górny
+- François Deppierraz
+- Jasper Spaans
+- Boni Lindsley
+- Tobias Kölling
+- @pinoatrome
+- Shoaib Ahmed
+- John Villalovos
+- Claude Paroz
+- Stefan Wójcik
+- Andrzej Bartosiński
+- @axoroll7
+- Sean Whalen
+- Peter Wienemann 
+- Arnout Engelen
+

imapclient-4.0.0/IMAPClient.egg-info/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: IMAPClient
+Version: 4.0.0
+Summary: Easy-to-use, Pythonic and complete IMAP client library
+Author-email: Menno Finlay-Smits <hello@menno.io>
+Maintainer-email: IMAPClient Maintainers <imapclient@groups.io>
+Project-URL: Homepage, https://github.com/mjs/imapclient/
+Keywords: imap,client,email,mail
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Email :: Post-Office :: IMAP
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8.0
+Description-Content-Type: text/x-rst
+License-File: COPYING
+License-File: AUTHORS.rst
+Dynamic: license-file
+
+Essentials
+----------
+IMAPClient is an easy-to-use, Pythonic and complete IMAP client
+library.
+
+=========================  ========================================
+Current version            3.0.1
+Supported Python versions  3.8 - 3.14
+License                    New BSD
+Project home               https://github.com/mjs/imapclient/
+PyPI                       https://pypi.python.org/pypi/IMAPClient
+Documentation              https://imapclient.readthedocs.io/
+Discussions                https://github.com/mjs/imapclient/discussions
+Test Status                |build master|
+=========================  ========================================
+
+.. |build master| image:: https://github.com/mjs/imapclient/actions/workflows/main.yml/badge.svg
+   :target: https://github.com/mjs/imapclient/actions
+   :alt: master branch
+
+Features
+--------
+- Arguments and return values are natural Python types.
+- IMAP server responses are fully parsed and readily usable.
+- IMAP unique message IDs (UIDs) are handled transparently. There is
+  no need to call different methods to use UIDs.
+- Escaping for internationalised mailbox names is transparently
+  handled.  Unicode mailbox names may be passed as input wherever a
+  folder name is accepted.
+- Time zones are transparently handled including when the server and
+  client are in different zones.
+- Convenience methods are provided for commonly used functionality.
+- Exceptions are raised when errors occur.
+
+Example
+-------
+
+.. code-block:: python
+
+    from imapclient import IMAPClient
+
+    # context manager ensures the session is cleaned up
+    with IMAPClient(host="imap.host.org") as client:
+        client.login('someone', 'secret')
+        client.select_folder('INBOX')
+
+        # search criteria are passed in a straightforward way
+        # (nesting is supported)
+        messages = client.search(['NOT', 'DELETED'])
+
+        # fetch selectors are passed as a simple list of strings.
+        response = client.fetch(messages, ['FLAGS', 'RFC822.SIZE'])
+
+        # `response` is keyed by message id and contains parsed,
+        # converted response items.
+        for message_id, data in response.items():
+            print('{id}: {size} bytes, flags={flags}'.format(
+                id=message_id,
+                size=data[b'RFC822.SIZE'],
+                flags=data[b'FLAGS']))
+
+Why IMAPClient?
+---------------
+You may ask: "why create another IMAP client library for Python?
+Doesn't the Python standard library already have imaplib?".
+
+The problem with imaplib is that it's very low-level. It expects
+string values where lists or tuples would be more appropriate and
+returns server responses almost unparsed. As IMAP server responses can
+be quite complex this means everyone using imaplib ends up writing
+their own fragile parsing routines.
+
+Also, imaplib doesn't make good use of exceptions. This means you need
+to check the return value of each call to imaplib to see if what you
+just did was successful.
+
+IMAPClient actually uses imaplib internally. This may change at some
+point in the future.
+
+Installing IMAPClient
+---------------------
+IMAPClient is listed on PyPI and can be installed with `uv
+<https://docs.astral.sh/uv/>`_::
+
+    uv add imapclient
+
+More installation methods are described in the documentation.
+
+Documentation
+-------------
+IMAPClient's manual is available at http://imapclient.readthedocs.io/.
+Release notes can be found at
+http://imapclient.readthedocs.io/#release-history.
+
+See the `examples` directory in the root of project source for
+examples of how to use IMAPClient.
+
+Current Status
+--------------
+You should feel confident using IMAPClient for production purposes. 
+
+In order to clearly communicate version compatibility, IMAPClient
+will strictly adhere to the `Semantic Versioning <http://semver.org>`_
+scheme from version 1.0 onwards.
+
+The project's home page is https://github.com/mjs/imapclient/ (this
+currently redirects to the IMAPClient Github site). Details about
+upcoming versions and planned features/fixes can be found in the issue
+tracker on Github. The maintainers also blog about IMAPClient
+news. Those articles can be found `here
+<http://menno.io/tags/imapclient>`_.
+
+Discussions
+-----------
+`Github Discussions`_ can be used to ask questions, propose changes or praise
+the project maintainers :)
+
+.. _`Github Discussions`: https://github.com/mjs/imapclient/discussions
+
+Working on IMAPClient
+---------------------
+The `contributing documentation
+<http://imapclient.rtfd.io/en/master/contributing.html>`_ contains
+information for those interested in improving IMAPClient.
+
+IMAP Servers
+------------
+IMAPClient is heavily tested against Dovecot, Gmail, Fastmail.fm
+(who use a modified Cyrus implementation), Office365 and Yahoo. Access
+to accounts on other IMAP servers/services for testing would be
+greatly appreciated.
+
+Interactive Console
+-------------------
+This script connects an IMAPClient instance using the command line
+args given and starts an interactive session. This is useful for
+exploring the IMAPClient API and testing things out, avoiding the
+steps required to set up an IMAPClient instance.
+
+The IPython shell is used if it is installed. Otherwise the
+code.interact() function from the standard library is used.
+
+The interactive console functionality can be accessed by running the
+``imapclient-interact`` script that is installed alongside IMAPClient,
+or by invoking the interact module like this::
+
+    uv run python -m imapclient.interact ...
+
+"Live" Tests
+------------
+IMAPClient includes a series of live, functional tests which exercise
+it against a live IMAP account. These are useful for ensuring
+compatibility with a given IMAP server implementation.
+
+The livetest functionality is run using the ``imapclient-livetest``
+script that is installed alongside IMAPClient::
+
+    uv run imapclient-livetest <livetest.ini> [ optional unittest arguments ]
+
+The configuration file format is
+`described in the main documentation <http://imapclient.rtfd.io/#configuration-file-format>`_.
+
+**WARNING**: The operations used by livetest are destructive and could
+cause unintended loss of data. That said, as of version 0.9, livetest
+limits its activity to a folder it creates and subfolders of that
+folder. It *should* be safe to use with any IMAP account but please
+don't run livetest against a truly important IMAP account.
+
+Please include the output of imapclient-livetest with an issue if it
+fails to run successfully against a particular IMAP server. Reports of
+successful runs are also welcome.  Please include the type and version
+of the IMAP server, if known.

imapclient-4.0.0/IMAPClient.egg-info/SOURCES.txt

@@ -0,0 +1,43 @@
+AUTHORS.rst
+COPYING
+README.rst
+pyproject.toml
+IMAPClient.egg-info/PKG-INFO
+IMAPClient.egg-info/SOURCES.txt
+IMAPClient.egg-info/dependency_links.txt
+IMAPClient.egg-info/entry_points.txt
+IMAPClient.egg-info/top_level.txt
+imapclient/__init__.py
+imapclient/config.py
+imapclient/datetime_util.py
+imapclient/exceptions.py
+imapclient/fixed_offset.py
+imapclient/imap4.py
+imapclient/imap_utf7.py
+imapclient/imapclient.py
+imapclient/interact.py
+imapclient/livetest.py
+imapclient/response_lexer.py
+imapclient/response_parser.py
+imapclient/response_types.py
+imapclient/testable_imapclient.py
+imapclient/tls.py
+imapclient/typing_imapclient.py
+imapclient/util.py
+imapclient/version.py
+tests/test_auth.py
+tests/test_datetime_util.py
+tests/test_enable.py
+tests/test_fixed_offset.py
+tests/test_folder_status.py
+tests/test_imap_utf7.py
+tests/test_imapclient.py
+tests/test_init.py
+tests/test_response_lexer.py
+tests/test_response_parser.py
+tests/test_search.py
+tests/test_sort.py
+tests/test_starttls.py
+tests/test_store.py
+tests/test_thread.py
+tests/test_util_functions.py

imapclient-4.0.0/IMAPClient.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+imapclient-interact = imapclient.interact:main
+imapclient-livetest = imapclient.livetest:main

imapclient-4.0.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: IMAPClient
+Version: 4.0.0
+Summary: Easy-to-use, Pythonic and complete IMAP client library
+Author-email: Menno Finlay-Smits <hello@menno.io>
+Maintainer-email: IMAPClient Maintainers <imapclient@groups.io>
+Project-URL: Homepage, https://github.com/mjs/imapclient/
+Keywords: imap,client,email,mail
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Email :: Post-Office :: IMAP
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8.0
+Description-Content-Type: text/x-rst
+License-File: COPYING
+License-File: AUTHORS.rst
+Dynamic: license-file
+
+Essentials
+----------
+IMAPClient is an easy-to-use, Pythonic and complete IMAP client
+library.
+
+=========================  ========================================
+Current version            3.0.1
+Supported Python versions  3.8 - 3.14
+License                    New BSD
+Project home               https://github.com/mjs/imapclient/
+PyPI                       https://pypi.python.org/pypi/IMAPClient
+Documentation              https://imapclient.readthedocs.io/
+Discussions                https://github.com/mjs/imapclient/discussions
+Test Status                |build master|
+=========================  ========================================
+
+.. |build master| image:: https://github.com/mjs/imapclient/actions/workflows/main.yml/badge.svg
+   :target: https://github.com/mjs/imapclient/actions
+   :alt: master branch
+
+Features
+--------
+- Arguments and return values are natural Python types.
+- IMAP server responses are fully parsed and readily usable.
+- IMAP unique message IDs (UIDs) are handled transparently. There is
+  no need to call different methods to use UIDs.
+- Escaping for internationalised mailbox names is transparently
+  handled.  Unicode mailbox names may be passed as input wherever a
+  folder name is accepted.
+- Time zones are transparently handled including when the server and
+  client are in different zones.
+- Convenience methods are provided for commonly used functionality.
+- Exceptions are raised when errors occur.
+
+Example
+-------
+
+.. code-block:: python
+
+    from imapclient import IMAPClient
+
+    # context manager ensures the session is cleaned up
+    with IMAPClient(host="imap.host.org") as client:
+        client.login('someone', 'secret')
+        client.select_folder('INBOX')
+
+        # search criteria are passed in a straightforward way
+        # (nesting is supported)
+        messages = client.search(['NOT', 'DELETED'])
+
+        # fetch selectors are passed as a simple list of strings.
+        response = client.fetch(messages, ['FLAGS', 'RFC822.SIZE'])
+
+        # `response` is keyed by message id and contains parsed,
+        # converted response items.
+        for message_id, data in response.items():
+            print('{id}: {size} bytes, flags={flags}'.format(
+                id=message_id,
+                size=data[b'RFC822.SIZE'],
+                flags=data[b'FLAGS']))
+
+Why IMAPClient?
+---------------
+You may ask: "why create another IMAP client library for Python?
+Doesn't the Python standard library already have imaplib?".
+
+The problem with imaplib is that it's very low-level. It expects
+string values where lists or tuples would be more appropriate and
+returns server responses almost unparsed. As IMAP server responses can
+be quite complex this means everyone using imaplib ends up writing
+their own fragile parsing routines.
+
+Also, imaplib doesn't make good use of exceptions. This means you need
+to check the return value of each call to imaplib to see if what you
+just did was successful.
+
+IMAPClient actually uses imaplib internally. This may change at some
+point in the future.
+
+Installing IMAPClient
+---------------------
+IMAPClient is listed on PyPI and can be installed with `uv
+<https://docs.astral.sh/uv/>`_::
+
+    uv add imapclient
+
+More installation methods are described in the documentation.
+
+Documentation
+-------------
+IMAPClient's manual is available at http://imapclient.readthedocs.io/.
+Release notes can be found at
+http://imapclient.readthedocs.io/#release-history.
+
+See the `examples` directory in the root of project source for
+examples of how to use IMAPClient.
+
+Current Status
+--------------
+You should feel confident using IMAPClient for production purposes. 
+
+In order to clearly communicate version compatibility, IMAPClient
+will strictly adhere to the `Semantic Versioning <http://semver.org>`_
+scheme from version 1.0 onwards.
+
+The project's home page is https://github.com/mjs/imapclient/ (this
+currently redirects to the IMAPClient Github site). Details about
+upcoming versions and planned features/fixes can be found in the issue
+tracker on Github. The maintainers also blog about IMAPClient
+news. Those articles can be found `here
+<http://menno.io/tags/imapclient>`_.
+
+Discussions
+-----------
+`Github Discussions`_ can be used to ask questions, propose changes or praise
+the project maintainers :)
+
+.. _`Github Discussions`: https://github.com/mjs/imapclient/discussions
+
+Working on IMAPClient
+---------------------
+The `contributing documentation
+<http://imapclient.rtfd.io/en/master/contributing.html>`_ contains
+information for those interested in improving IMAPClient.
+
+IMAP Servers
+------------
+IMAPClient is heavily tested against Dovecot, Gmail, Fastmail.fm
+(who use a modified Cyrus implementation), Office365 and Yahoo. Access
+to accounts on other IMAP servers/services for testing would be
+greatly appreciated.
+
+Interactive Console
+-------------------
+This script connects an IMAPClient instance using the command line
+args given and starts an interactive session. This is useful for
+exploring the IMAPClient API and testing things out, avoiding the
+steps required to set up an IMAPClient instance.
+
+The IPython shell is used if it is installed. Otherwise the
+code.interact() function from the standard library is used.
+
+The interactive console functionality can be accessed by running the
+``imapclient-interact`` script that is installed alongside IMAPClient,
+or by invoking the interact module like this::
+
+    uv run python -m imapclient.interact ...
+
+"Live" Tests
+------------
+IMAPClient includes a series of live, functional tests which exercise
+it against a live IMAP account. These are useful for ensuring
+compatibility with a given IMAP server implementation.
+
+The livetest functionality is run using the ``imapclient-livetest``
+script that is installed alongside IMAPClient::
+
+    uv run imapclient-livetest <livetest.ini> [ optional unittest arguments ]
+
+The configuration file format is
+`described in the main documentation <http://imapclient.rtfd.io/#configuration-file-format>`_.
+
+**WARNING**: The operations used by livetest are destructive and could
+cause unintended loss of data. That said, as of version 0.9, livetest
+limits its activity to a folder it creates and subfolders of that
+folder. It *should* be safe to use with any IMAP account but please
+don't run livetest against a truly important IMAP account.
+
+Please include the output of imapclient-livetest with an issue if it
+fails to run successfully against a particular IMAP server. Reports of
+successful runs are also welcome.  Please include the type and version
+of the IMAP server, if known.

{IMAPClient-2.0.0 → imapclient-4.0.0}/README.rst

@@ -4,32 +4,20 @@ IMAPClient is an easy-to-use, Pythonic and complete IMAP client
 library.
 
 =========================  ========================================
-Current version            2.0.0
-Supported Python versions  2.7, 3.4, 3.5 and 3.6
+Current version            3.0.1
+Supported Python versions  3.8 - 3.14
 License                    New BSD
 Project home               https://github.com/mjs/imapclient/
 PyPI                       https://pypi.python.org/pypi/IMAPClient
 Documentation              https://imapclient.readthedocs.io/
-Mailing list               https://groups.io/g/imapclient
+Discussions                https://github.com/mjs/imapclient/discussions
+Test Status                |build master|
 =========================  ========================================
 
-Test Status
-~~~~~~~~~~~
-
-===================== ==============
-``1.x`` unit tests    |build 1.x|
-``master`` unit tests |build master|
-===================== ==============
-
-.. |build 1.x| image:: https://travis-ci.org/mjs/imapclient.svg?branch=1.x
-    :target: https://travis-ci.org/mjs/imapclient/branches
-    :alt: 1.x branch
-
-.. |build master| image:: https://travis-ci.org/mjs/imapclient.svg?branch=master
-   :target: https://travis-ci.org/mjs/imapclient/branches
+.. |build master| image:: https://github.com/mjs/imapclient/actions/workflows/main.yml/badge.svg
+   :target: https://github.com/mjs/imapclient/actions
    :alt: master branch
 
-
 Features
 --------
 - Arguments and return values are natural Python types.
@@ -91,9 +79,10 @@ point in the future.
 
 Installing IMAPClient
 ---------------------
-IMAPClient is listed on PyPI and can be installed with pip::
+IMAPClient is listed on PyPI and can be installed with `uv
+<https://docs.astral.sh/uv/>`_::
 
-    pip install imapclient
+    uv add imapclient
 
 More installation methods are described in the documentation.
 
@@ -108,8 +97,7 @@ examples of how to use IMAPClient.
 
 Current Status
 --------------
-You should feel confident using IMAPClient for production
-purposes. Any problems found will be fixed quickly once reported.
+You should feel confident using IMAPClient for production purposes. 
 
 In order to clearly communicate version compatibility, IMAPClient
 will strictly adhere to the `Semantic Versioning <http://semver.org>`_
@@ -122,26 +110,12 @@ tracker on Github. The maintainers also blog about IMAPClient
 news. Those articles can be found `here
 <http://menno.io/tags/imapclient>`_.
 
-Mailing List
-------------
-The IMAPClient mailing list can be used to ask IMAPClient related
-questions and report bugs. Details of new releases and project changes
-will also be announced there.
-
-The mailing list is hosted at `Groups.io
-<http://groups.io>`_. Interaction via both email and the web is
-supported. To join the list, see the list archives or just find out
-more, visit https://groups.io/g/imapclient. The key details of the
-list are:
-
-* Post: imapclient@groups.io
-* Subscribe: imapclient+subscribe@groups.io
-* Unsubscribe: imapclient+unsubscribe@groups.io
-* Web: https://groups.io/g/imapclient
-* Web archives: https://groups.io/g/imapclient/messages
+Discussions
+-----------
+`Github Discussions`_ can be used to ask questions, propose changes or praise
+the project maintainers :)
 
-If you're having trouble using the mailing list, please email
-inbox@menno.io.
+.. _`Github Discussions`: https://github.com/mjs/imapclient/discussions
 
 Working on IMAPClient
 ---------------------
@@ -166,11 +140,11 @@ steps required to set up an IMAPClient instance.
 The IPython shell is used if it is installed. Otherwise the
 code.interact() function from the standard library is used.
 
-The interactive console functionality can be accessed running the
-interact.py script in the root of the source tree or by invoking the
-interact module like this::
+The interactive console functionality can be accessed by running the
+``imapclient-interact`` script that is installed alongside IMAPClient,
+or by invoking the interact module like this::
 
-    python -m imapclient.interact ...
+    uv run python -m imapclient.interact ...
 
 "Live" Tests
 ------------
@@ -178,10 +152,10 @@ IMAPClient includes a series of live, functional tests which exercise
 it against a live IMAP account. These are useful for ensuring
 compatibility with a given IMAP server implementation.
 
-The livetest functionality are run from the root of the project source
-like this::
+The livetest functionality is run using the ``imapclient-livetest``
+script that is installed alongside IMAPClient::
 
-    python livetest.py <livetest.ini> [ optional unittest arguments ]
+    uv run imapclient-livetest <livetest.ini> [ optional unittest arguments ]
 
 The configuration file format is
 `described in the main documentation <http://imapclient.rtfd.io/#configuration-file-format>`_.
@@ -192,7 +166,7 @@ limits its activity to a folder it creates and subfolders of that
 folder. It *should* be safe to use with any IMAP account but please
 don't run livetest against a truly important IMAP account.
 
-Please send the output of livetest.py to the mailing list if it fails
-to run successfully against a particular IMAP server. Reports of
+Please include the output of imapclient-livetest with an issue if it
+fails to run successfully against a particular IMAP server. Reports of
 successful runs are also welcome.  Please include the type and version
 of the IMAP server, if known.

{IMAPClient-2.0.0 → imapclient-4.0.0}/imapclient/__init__.py

@@ -5,9 +5,8 @@
 # version_info provides the version number in programmer friendly way.
 # The 4th part will be either alpha, beta or final.
 
-from __future__ import unicode_literals
-
-from .imapclient import *
-from .response_parser import *
-from .tls import *
-from .version import author as __author__, version as __version__, version_info
+from .imapclient import *  # noqa: F401,F403
+from .response_parser import *  # noqa: F401,F403
+from .tls import *  # noqa: F401,F403
+from .version import version as __version__  # noqa: F401
+from .version import version_info  # noqa: F401