IMAPClient 4.0.0__py3-none-any.whl

imapclient/util.py

@@ -0,0 +1,63 @@
+# Copyright (c) 2015, Menno Smits
+# Released subject to the New BSD License
+# Please see http://en.wikipedia.org/wiki/BSD_licenses
+
+import logging
+from typing import Iterator, Optional, Sequence, Tuple, Union
+
+from . import exceptions
+
+logger = logging.getLogger(__name__)
+
+
+def to_unicode(s: Union[bytes, str]) -> str:
+    if isinstance(s, bytes):
+        try:
+            return s.decode("ascii")
+        except UnicodeDecodeError:
+            logger.warning(
+                "An error occurred while decoding %s in ASCII 'strict' mode. Fallback to "
+                "'ignore' errors handling, some characters might have been stripped",
+                s,
+            )
+            return s.decode("ascii", "ignore")
+    return s
+
+
+def to_ints(
+    messages: Union[bytes, str, int, Sequence[Union[bytes, str, int]]],
+) -> Sequence[int]:
+    """Convert a sequence of values (such as messages)
+    or a single integer value into an sequence of ints
+    """
+    if not messages:
+        return []
+    if isinstance(messages, (int, str, bytes)):
+        return [int(messages)]
+    return [int(i) for i in messages]
+
+
+def to_bytes(s: Union[bytes, str], charset: str = "ascii") -> bytes:
+    if isinstance(s, str):
+        return s.encode(charset)
+    return s
+
+
+def assert_imap_protocol(condition: bool, message: Optional[bytes] = None) -> None:
+    if not condition:
+        msg = "Server replied with a response that violates the IMAP protocol"
+        if message:
+            # FIXME(jlvillal): This looks wrong as it repeats `msg` twice
+            msg += "{}: {}".format(
+                msg, message.decode(encoding="ascii", errors="ignore")
+            )
+        raise exceptions.ProtocolError(msg)
+
+
+_TupleAtomPart = Union[None, int, bytes]
+_TupleAtom = Tuple[Union[_TupleAtomPart, "_TupleAtom"], ...]
+
+
+def chunk(lst: _TupleAtom, size: int) -> Iterator[_TupleAtom]:
+    for i in range(0, len(lst), size):
+        yield lst[i : i + size]

imapclient/version.py

@@ -0,0 +1,17 @@
+# Copyright (c) 2025, Menno Smits
+# Released subject to the New BSD License
+# Please see http://en.wikipedia.org/wiki/BSD_licenses
+
+from importlib import metadata
+from typing import Tuple
+
+version = metadata.version("imapclient")
+
+
+def _make_version_info() -> Tuple[int, int, int, str]:
+    major, minor, micro = version.split(".")
+    return (int(major), int(minor), int(micro), "final")
+
+
+# This is for backwards compatibility with older versions of IMAPClient only
+version_info = _make_version_info()

imapclient-4.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,25 @@
+imapclient/__init__.py,sha256=N96_430nCNSDk-WYpZ9Yboh6myie1GtSnTBFGRC96YM,495
+imapclient/config.py,sha256=qqWOvPRG5FzoNkYzQ_aqE0xKCGRpOkhbAxccB3xMdHE,6611
+imapclient/datetime_util.py,sha256=ag3fmKcDbVvFMPQqKdwR8S1qgLOoIMIrEhV4qFNUKqs,2284
+imapclient/exceptions.py,sha256=okd1TpswEsKv05pLXwC9Dvjq-lPOS7T0FlKW_7KeBXo,1193
+imapclient/fixed_offset.py,sha256=fkfjpEIOYl_BDbA81g8xuY_tAZzBGnsqccx-szpPW1s,1298
+imapclient/imap4.py,sha256=VVC0D07WulqG2MYYFrKE-O5l_zk8JTlZ88astlqkHjI,620
+imapclient/imap_utf7.py,sha256=7ldAI_4rK6EOkkPJV14NIZl45mQyO64aTzcIxQ3si9E,3703
+imapclient/imapclient.py,sha256=OPxW5QBz1rZwq43lRG6XB2TgD-0t87Ho4yiKRxW8Lus,74702
+imapclient/interact.py,sha256=uXgm79QF3cxhyVNqdn7Zbn0JKRPLOtYvZ46EpzzJ_xM,4037
+imapclient/livetest.py,sha256=fUj7hNroPyNNY935A78toFRqWzwE6zsZubu6h51GbYc,43220
+imapclient/response_lexer.py,sha256=gBBSlqIHv_C9bHMFE9aXrqPqJRdXERjEDRVfyc0dF9E,5845
+imapclient/response_parser.py,sha256=smOMV0R9U_T1hOmnZJGFuSa1Mp6eFFARKerAQTJl4Z0,9025
+imapclient/response_types.py,sha256=rKw-PzqzGGRw7PSAwiUPMSHSnY3vLy8hI9HHFTtexPc,5476
+imapclient/testable_imapclient.py,sha256=CPJ2BuNJfiAyWcZ5DecsJoi_o6wnfePhLCTDBc6s7P0,1191
+imapclient/tls.py,sha256=nJFS1WVMw9gNnNuybPn9xU3QH92pcTK_BXs0deHrkWI,1233
+imapclient/typing_imapclient.py,sha256=PTj6q6SAcJeEwwV9UdVbLV-5XxdPG6ezQ7_kCUiwKBs,115
+imapclient/util.py,sha256=82tRZAq0IgcjOnE2I39k151-cYM1COh3T9D5djxiMRo,1943
+imapclient/version.py,sha256=PIpDJHwOJ6SrPYsK0yhmaR_FvuzQVWJTmJ68PMLPjT8,504
+imapclient-4.0.0.dist-info/licenses/AUTHORS.rst,sha256=IDCbsOmsmvoRu7du6xjwrU5t5I-OoNavwt6q9IWJY8E,917
+imapclient-4.0.0.dist-info/licenses/COPYING,sha256=NHLfcEugl9DSTplK0wgKxQS2ZAK6uJf6N06zG-mk7Js,1484
+imapclient-4.0.0.dist-info/METADATA,sha256=zbzCIZotECVbVdZjW2Ey9A0GMoYa-pIBDhcdhDMDxqQ,7525
+imapclient-4.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+imapclient-4.0.0.dist-info/entry_points.txt,sha256=d2Wo2nDiKrERIYpyUCQQheLqezUsBeIGW_i7LXH6Byc,112
+imapclient-4.0.0.dist-info/top_level.txt,sha256=pf_BiuslDCnFXY3K-jy6peSBOfJWXGH17SDmDGcBqMI,11
+imapclient-4.0.0.dist-info/RECORD,,

imapclient-4.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

imapclient-4.0.0.dist-info/entry_points.txt

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

imapclient-4.0.0.dist-info/licenses/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.dist-info/licenses/COPYING

@@ -0,0 +1,24 @@
+Copyright (c) 2014, Menno Smits
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Menno Smits nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL MENNO SMITS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

imapclient-4.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+imapclient