{"id":19686342,"url":"https://github.com/closeio/imapclient","last_synced_at":"2026-06-15T05:31:45.103Z","repository":{"id":29934148,"uuid":"33480353","full_name":"closeio/imapclient","owner":"closeio","description":"IMAPClient mirror","archived":false,"fork":false,"pushed_at":"2020-04-03T18:36:55.000Z","size":2356,"stargazers_count":0,"open_issues_count":1,"forks_count":4,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-02-27T08:59:35.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/closeio.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-06T12:13:10.000Z","updated_at":"2015-04-06T14:46:25.000Z","dependencies_parsed_at":"2022-09-10T16:50:37.483Z","dependency_job_id":null,"html_url":"https://github.com/closeio/imapclient","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/closeio/imapclient","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/closeio%2Fimapclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/closeio%2Fimapclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/closeio%2Fimapclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/closeio%2Fimapclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/closeio","download_url":"https://codeload.github.com/closeio/imapclient/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/closeio%2Fimapclient/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34349925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T18:27:36.445Z","updated_at":"2026-06-15T05:31:45.088Z","avatar_url":"https://github.com/closeio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Introduction\n------------\nIMAPClient is an easy-to-use, Pythonic and complete IMAP client\nlibrary.\n\nFeatures:\n\n- Arguments and return values are natural Python types.\n- IMAP server responses are fully parsed and readily usable.\n- IMAP unique message IDs (UIDs) are handled transparently. There is\n  no need to call different methods to use UIDs.\n- Escaping for internationalised mailbox names is transparently\n  handled.  Unicode mailbox names may be passed as input wherever a\n  folder name is accepted.\n- Time zones are transparently handled including when the server and\n  client are in different zones.\n- Convenience methods are provided for commonly used functionality.\n- Exceptions are raised when errors occur.\n\nPython versions 2.6, 2.7, 3.2, 3.3 and 3.4 are officially supported.\n\nThe current stable version of IMAPClient is 0.12. It is licensed under\nthe New BSD License.\n\nWhy IMAPClient?\n---------------\nYou may ask: \"why create another IMAP client library for Python?\nDoesn't the Python standard library already have imaplib?\".\n\nThe problem with imaplib is that it's very low-level. It expects\nstring values where lists or tuples would be more appropriate and\nreturns server responses almost unparsed. As IMAP server responses can\nbe quite complex this means everyone using imaplib ends up writing\ntheir own flimsy parsing routines which break easily.\n\nAlso, imaplib doesn't make good use of exceptions. This means you need\nto check the return value of each call to imaplib to see if what you\njust did was successful.\n\nIMAPClient actually uses imaplib internally. This may change at some\npoint in the future.\n\nInstalling IMAPClient\n---------------------\nIMAPClient is listed on the PyPI (Python Package Index). To install\nvia PyPI use the pip or easy_install tools::\n\n    pip install imapclient\n\n    easy_install IMAPClient\n\nThe source distributions of all IMAPClient versions are available at\nhttp://freshfoo.com/projects/IMAPClient/. Alternatively you can also\nuse the PyPI page at https://pypi.python.org/pypi/IMAPClient/.\n\nTo install from source run::\n\n    python setup.py install\n\nThe project is packaged using Distribute (mostly compatible with\nsetuptools) and all the usual setup.py installation options are\navailable. See http://packages.python.org/distribute/ for more info.\n\nDocumentation\n-------------\nIMAPClient's manual is available at http://imapclient.readthedocs.org/\n\nThe `NEWS \u003chttps://bitbucket.org/mjs0/imapclient/src/tip/NEWS.rst\u003e`_\nfile also has useful information.\n\nThe HTML manual can also be found at doc/html in the source\ndistribution. The Sphinx source is at doc/src. If Sphinx is installed,\nthe documentation can be rebuilt using::\n\n    python setup.py build_sphinx\n\nSee imapclient/examples/example.py for a sample of how to use\nIMAPClient. If the IMAPClient was installed from PyPI, the examples\nsubdirectory can be found under the imapclient package installation\ndirectory.\n\nCurrent Status\n--------------\nIMAPClient is currently under development but it is unlikely that\nthe existing API will change in backwards-incompatible ways. Changes\nplanned for the near future will only add extra functionality to the\nAPI.\n\nYou should feel confident using IMAPClient for production\npurposes. Any problems found will be fixed quickly once reported.\n\nThe project's home page is http://imapclient.freshfoo.com/ (this\ncurrently redirects to the IMAPClient Bitbucket site). Details about\nupcoming versions and planned features/fixes can be found in the issue\ntracker on Bitbucket. The maintainer also blogs about IMAPClient\nnews. Those articles can be found `here\n\u003chttp://freshfoo.com/blog/tags/imapclient\u003e`_.\n\nMailing List\n------------\nThe IMAPClient mailing list can be used to ask IMAPClient related\nquestions and report bugs.\n\n- To send to the list and subscribe send an email to imapclient@librelist.com\n- Archives of the list are available at http://librelist.com/browser/imapclient/\n- See http://librelist.com/help.html for more information about the mailing list\n\nWorking on IMAPClient\n---------------------\nThe HACKING.rst document contains information for those interested in\nimproving IMAPClient and contributing back to the project.\n\nIMAP Servers\n------------\nIMAPClient is heavily tested against Dovecot, Gmail, Fastmail.fm\n(who use a modified Cyrus implementation) and occasionally Microsoft\nExchange. Access to accounts on other IMAP servers/services for\ntesting would be greatly appreciated.\n\nInteractive Console\n-------------------\nThis script connects an IMAPClient instance using the command line\nargs given and starts an interactive session. This is useful for\nexploring the IMAPClient API and testing things out, avoiding the\nsteps required to set up an IMAPClient instance.\n\nThe IPython shell is used if it is installed. Otherwise the\ncode.interact() function from the standard library is used.\n\nThe interactive console functionality can be accessed running the\ninteract.py script in the root of the source tree or by invoking the\ninteract module like this::\n\n    python -m imapclient.interact ...\n\n\"Live\" Tests\n------------\nIMAPClient includes a series of functional tests which exercise\nit against a live IMAP account. It is useful for ensuring\ncompatibility with a given IMAP server implementation.\n\nThe livetest functionality can also be accessed like this::\n\n    python -m imapclient.livetest ...\n\nAlternatively you can run the ``livetest.py`` script included with the\nsource distribution.\n\nUse the --help option to see usage.\n\n**WARNING**: The operations used by livetest are destructive and could\ncause unintended loss of data. That said, as of version 0.9, livetest\nlimits its activity to a folder it creates and subfolders of that\nfolder. It *should* be safe to use with any IMAP account but please\ndon't run livetest against a truly important IMAP account.\n\nPlease send the output of livetest.py to the mailing list if it fails\nto run successfully against a particular IMAP server. Reports of\nsuccessful runs are also welcome.  Please include the type and version\nof the IMAP server, if known.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloseio%2Fimapclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloseio%2Fimapclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloseio%2Fimapclient/lists"}