{"id":22622399,"url":"https://github.com/sageteamorg/python-sage-imap","last_synced_at":"2025-04-11T16:40:50.808Z","repository":{"id":247090878,"uuid":"824006562","full_name":"sageteamorg/python-sage-imap","owner":"sageteamorg","description":"Managing IMAP connections and performing various email operations.","archived":false,"fork":false,"pushed_at":"2024-10-26T08:09:39.000Z","size":320,"stargazers_count":5,"open_issues_count":16,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-30T11:52:18.917Z","etag":null,"topics":["email","imap","mailbox","python"],"latest_commit_sha":null,"homepage":"https://python-sage-imap.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sageteamorg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-04T07:20:26.000Z","updated_at":"2024-11-04T19:52:52.000Z","dependencies_parsed_at":"2024-08-01T08:29:39.175Z","dependency_job_id":"16bfab94-ef22-4a51-b4a9-0953320f9056","html_url":"https://github.com/sageteamorg/python-sage-imap","commit_stats":null,"previous_names":["sageteamorg/python-sage-imap"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sageteamorg%2Fpython-sage-imap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sageteamorg%2Fpython-sage-imap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sageteamorg%2Fpython-sage-imap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sageteamorg%2Fpython-sage-imap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sageteamorg","download_url":"https://codeload.github.com/sageteamorg/python-sage-imap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248442031,"owners_count":21104120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["email","imap","mailbox","python"],"created_at":"2024-12-08T23:14:57.458Z","updated_at":"2025-04-11T16:40:50.772Z","avatar_url":"https://github.com/sageteamorg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-sage-imap\n\n\n![Black](https://img.shields.io/badge/code%20style-black-000000.svg)\n![Pylint](https://img.shields.io/badge/pylint-9-brightgreen)\n[![codecov](https://codecov.io/gh/sageteamorg/python-sage-imap/graph/badge.svg?token=I10LGK910X)](https://codecov.io/gh/sageteamorg/python-sage-imap)\n\n![PyPI release](https://img.shields.io/pypi/v/python-sage-imap \"python-sage-imap\")\n![Supported Python versions](https://img.shields.io/pypi/pyversions/python-sage-imap \"python-sage-imap\")\n![Documentation](https://img.shields.io/readthedocs/python-sage-imap \"python-sage-imap\")\n![License](https://img.shields.io/badge/license-MIT-red)\n![GitHub last commit](https://img.shields.io/github/last-commit/sageteamorg/python-sage-imap)\n\n\n## Table of Contents\n- [python-sage-imap](#python-sage-imap)\n  - [Table of Contents](#table-of-contents)\n  - [Introduction](#introduction)\n  - [Features](#features)\n  - [Installation](#installation)\n  - [Configuration](#configuration)\n  - [Examples](#examples)\n    - [Example 1: Creating an IMAP Client](#example-1-creating-an-imap-client)\n      - [Explanation](#explanation)\n    - [Example 2: Working with Folder Service](#example-2-working-with-folder-service)\n    - [Example 3: Working with Mailbox Methods](#example-3-working-with-mailbox-methods)\n    - [IMAPMailboxService Example](#imapmailboxservice-example)\n      - [Example Usage with Nested Context Managers:](#example-usage-with-nested-context-managers)\n  - [License](#license)\n\n## Introduction\n`python-sage-imap` is a robust Python package designed for managing IMAP connections and performing various email operations. It provides easy-to-use interfaces for managing email folders, flags, searching emails, and sending emails using SMTP. This package is ideal for developers looking to integrate email functionalities into their applications seamlessly.\n\n## Features\n- Context manager for managing IMAP connections\n- Handling IMAP flags (add/remove)\n- Managing IMAP folders (create/rename/delete/list)\n- Searching emails with various criteria\n- Sending emails using SMTP with support for attachments and templates\n- Parsing and handling email messages\n\n## Installation\nTo install `python-sage-imap`, use pip:\n```bash\npip install python-sage-imap\n```\n\n## Configuration\nBefore using the package, you need to set up logging for better debugging and monitoring:\n```python\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\n```\n\n## Examples\n\n### Example 1: Creating an IMAP Client\n\nThis example demonstrates how to create an IMAP client using the `IMAPClient` class.\n\nThe `IMAPClient` class can also be used without a context manager; simply call `connect()` to establish the connection and `disconnect()` to close it\n\n```python\nfrom sage_imap.services import IMAPClient\n\nwith IMAPClient('imap.example.com', 'username', 'password') as client:\n    # Use the client for IMAP operations\n    capabilities = client.capability()\n    print(f\"Server capabilities: {capabilities}\")\n\n    status, messages = client.select(\"INBOX\")\n    print(f\"Selected INBOX with status: {status}\")\n```\n\n#### Explanation\n\nThis example illustrates a low-level approach to working with IMAP. If you want to use `imaplib` directly but need the added convenience of managing the connection lifecycle, the `IMAPClient` class is a perfect choice. It allows you to create a connection with the IMAP server and then use all the capabilities of `imaplib` to customize your workflow.\n\n1. **IMAPClient Context Manager**:\n   - The `IMAPClient` class is used within a context manager (`with` statement). This ensures that the connection to the IMAP server is properly opened and closed.\n   - When the `with` block is entered, the connection to the IMAP server is established, and the user is authenticated.\n   - When the `with` block is exited, the connection is automatically closed, ensuring that resources are cleaned up properly.\n\n2. **Why Use IMAPClient**:\n   - The `IMAPClient` exists to simplify the management of IMAP connections. By using it as a context manager, you don't have to worry about manually opening and closing the connection. This reduces the risk of resource leaks and makes your code cleaner and more maintainable.\n   - Within the context manager, you have access to the `imaplib` capabilities directly through the `client` object. This allows you to perform various IMAP operations seamlessly.\n\n3. **Capabilities and Select Methods**:\n   - The `.capability()` method is called to retrieve the server's capabilities, providing information about what commands and features the server supports.\n   - The `.select(\"INBOX\")` method is used to select the \"INBOX\" mailbox for further operations. It returns the status of the selection and the number of messages in the mailbox.\n\nBy using the `IMAPClient` class in this way, you can take advantage of the full power of `imaplib` while benefiting from the convenience and safety of automatic connection management.\n\n\n### Example 2: Working with Folder Service\nThis example demonstrates how to work with folders using the `IMAPFolderService`.\n\n```python\nfrom sage_imap.services.client import IMAPClient\nfrom sage_imap.services.folder import IMAPFolderService\n\nwith IMAPClient('imap.example.com', 'username', 'password') as client:\n    folder_service = IMAPFolderService(client)\n\n    # Create a new folder\n    folder_service.create_folder('NewFolder')\n\n    # Rename the folder\n    folder_service.rename_folder('NewFolder', 'RenamedFolder')\n\n    # List all folders\n    folders = folder_service.list_folders()\n    print(f\"Folders: {folders}\")\n\n    # Delete the folder\n    folder_service.delete_folder('RenamedFolder')\n```\n\n### Example 3: Working with Mailbox Methods\n\nBelow are usage examples of the `IMAPClient` and `IMAPMailboxService` classes, demonstrating their context manager capabilities and various methods:\n\n### IMAPMailboxService Example\n\nThe `IMAPMailboxService` class provides methods for managing mailbox operations such as selecting, closing, checking, deleting, moving, and getting status of mailboxes.\n\n**Purpose:** This class allows for performing various mailbox-related operations within the context of an IMAP connection, ensuring proper error handling and cleanup.\n\n#### Example Usage with Nested Context Managers:\n\n```python\nfrom sage_imap.services.client import IMAPClient\nfrom sage_imap.services.mailbox import IMAPMailboxService\nfrom sage_imap.helpers.mailbox import DefaultMailboxes\nfrom sage_imap.helpers.message import MessageSet\n\nfrom helpers.exceptions import IMAPClientError, IMAPMailboxCheckError, IMAPMailboxClosureError\n\nusername = 'username'\npassword = 'password'\n\ntry:\n    with IMAPClient('imap.example.com', username, password) as client:\n        with IMAPMailboxService(client) as mailbox:\n            # Select a mailbox\n            mailbox.select(DefaultMailboxes.INBOX)\n\n            # Delete messages temporarily (move to trash)\n            msg_set = MessageSet('1,2,3')\n            mailbox.trash(msg_set)\n\n            # Restore messages from trash to original folder\n            mailbox.restore(msg_set, DefaultMailboxes.INBOX)\n\n            # Permanently delete messages\n            mailbox.delete(msg_set)\n\nexcept IMAPClientError as e:\n    print(f\"An error occurred with the IMAP client: {e}\")\n```\n\n## License\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsageteamorg%2Fpython-sage-imap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsageteamorg%2Fpython-sage-imap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsageteamorg%2Fpython-sage-imap/lists"}