yunmail 0.1.0__tar.gz

yunmail-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Yunmail
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yunmail-0.1.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: yunmail
+Version: 0.1.0
+Summary: Official Python SDK for the Yunmail cloud communications API — email, SMS, voice verification and push notifications through one unified API.
+Author: Yunmail Maintainers
+License: Apache-2.0
+Project-URL: Homepage, https://www.yunmail.cc.cd
+Project-URL: Documentation, https://www.yunmail.cc.cd
+Project-URL: Issues, https://github.com/tanxi281-sketch/yunmail-sdk/issues
+Keywords: yunmail,email-api,sms-api,voice-otp,push-notifications,cloud-communications
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Yunmail Python SDK
+
+Official Python SDK for the [Yunmail](https://www.yunmail.cc.cd) cloud
+communications platform — **email, SMS, voice verification and push
+notifications through one unified API**, with a single API key.
+
+- 📧 Transactional & marketing email with template support
+- 💬 SMS verification codes, alerts and campaigns (200+ countries/regions)
+- 📞 Voice OTP as a reliable fallback where SMS can't reach
+- 🔔 App & web push notifications
+- 🔐 HMAC-SHA256 webhook signature verification built in
+- 🚀 Zero dependencies — Python standard library only
+
+> Status: **0.1.0 (alpha)**. The API surface covers the four core send
+> channels plus delivery-status lookup. See [ROADMAP.md](ROADMAP.md).
+
+## Installation
+
+```bash
+pip install yunmail
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/tanxi281-sketch/yunmail-sdk.git
+cd yunmail-sdk
+pip install -e .
+```
+
+## Quickstart
+
+```python
+from yunmail import YunmailClient
+
+client = YunmailClient(api_key="YOUR_YUNMAIL_API_KEY")
+
+# Email
+client.send_email(
+    to="user@example.com",
+    subject="Welcome to Yunmail",
+    html="<p>Thanks for signing up!</p>",
+)
+
+# SMS verification code (template based)
+client.send_sms(
+    to="+8613800000000",
+    template_id="verify_code",
+    params={"code": "123456"},
+)
+
+# Voice OTP fallback
+client.send_voice_code(to="+8613800000000", code="123456")
+
+# Push notification
+client.send_push(
+    device_tokens=["device-token-1"],
+    title="Order shipped",
+    body="Your order is on its way.",
+)
+
+# Delivery status of any message
+status = client.get_message_status("MESSAGE_ID")
+```
+
+## Webhook verification
+
+Verify that a webhook really came from Yunmail before trusting it:
+
+```python
+from yunmail import YunmailClient
+
+ok = YunmailClient.verify_webhook(
+    payload=request_body_bytes,        # raw request body
+    signature=request.headers["X-Yunmail-Signature"],
+    secret="YOUR_WEBHOOK_SECRET",
+)
+```
+
+## Error handling
+
+```python
+from yunmail import AuthenticationError, RateLimitError, APIError
+
+try:
+    client.send_email(...)
+except AuthenticationError:
+    ...  # bad or under-scoped API key (HTTP 401/403)
+except RateLimitError:
+    ...  # HTTP 429 — the client already retried with backoff
+except APIError as exc:
+    print(exc.status, exc.payload)
+```
+
+HTTP 429 and 5xx responses are retried automatically with exponential
+backoff (`max_retries=2` by default).
+
+## Development
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

yunmail-0.1.0/README.md

@@ -0,0 +1,108 @@
+# Yunmail Python SDK
+
+Official Python SDK for the [Yunmail](https://www.yunmail.cc.cd) cloud
+communications platform — **email, SMS, voice verification and push
+notifications through one unified API**, with a single API key.
+
+- 📧 Transactional & marketing email with template support
+- 💬 SMS verification codes, alerts and campaigns (200+ countries/regions)
+- 📞 Voice OTP as a reliable fallback where SMS can't reach
+- 🔔 App & web push notifications
+- 🔐 HMAC-SHA256 webhook signature verification built in
+- 🚀 Zero dependencies — Python standard library only
+
+> Status: **0.1.0 (alpha)**. The API surface covers the four core send
+> channels plus delivery-status lookup. See [ROADMAP.md](ROADMAP.md).
+
+## Installation
+
+```bash
+pip install yunmail
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/tanxi281-sketch/yunmail-sdk.git
+cd yunmail-sdk
+pip install -e .
+```
+
+## Quickstart
+
+```python
+from yunmail import YunmailClient
+
+client = YunmailClient(api_key="YOUR_YUNMAIL_API_KEY")
+
+# Email
+client.send_email(
+    to="user@example.com",
+    subject="Welcome to Yunmail",
+    html="<p>Thanks for signing up!</p>",
+)
+
+# SMS verification code (template based)
+client.send_sms(
+    to="+8613800000000",
+    template_id="verify_code",
+    params={"code": "123456"},
+)
+
+# Voice OTP fallback
+client.send_voice_code(to="+8613800000000", code="123456")
+
+# Push notification
+client.send_push(
+    device_tokens=["device-token-1"],
+    title="Order shipped",
+    body="Your order is on its way.",
+)
+
+# Delivery status of any message
+status = client.get_message_status("MESSAGE_ID")
+```
+
+## Webhook verification
+
+Verify that a webhook really came from Yunmail before trusting it:
+
+```python
+from yunmail import YunmailClient
+
+ok = YunmailClient.verify_webhook(
+    payload=request_body_bytes,        # raw request body
+    signature=request.headers["X-Yunmail-Signature"],
+    secret="YOUR_WEBHOOK_SECRET",
+)
+```
+
+## Error handling
+
+```python
+from yunmail import AuthenticationError, RateLimitError, APIError
+
+try:
+    client.send_email(...)
+except AuthenticationError:
+    ...  # bad or under-scoped API key (HTTP 401/403)
+except RateLimitError:
+    ...  # HTTP 429 — the client already retried with backoff
+except APIError as exc:
+    print(exc.status, exc.payload)
+```
+
+HTTP 429 and 5xx responses are retried automatically with exponential
+backoff (`max_retries=2` by default).
+
+## Development
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

yunmail-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yunmail"
+version = "0.1.0"
+description = "Official Python SDK for the Yunmail cloud communications API — email, SMS, voice verification and push notifications through one unified API."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Yunmail Maintainers" }]
+keywords = ["yunmail", "email-api", "sms-api", "voice-otp", "push-notifications", "cloud-communications"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Topic :: Communications :: Email",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://www.yunmail.cc.cd"
+Documentation = "https://www.yunmail.cc.cd"
+Issues = "https://github.com/tanxi281-sketch/yunmail-sdk/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]

yunmail-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yunmail-0.1.0/src/yunmail/__init__.py

@@ -0,0 +1,26 @@
+"""Yunmail Python SDK.
+
+One unified client for Yunmail's cloud communications API:
+transactional & marketing email, SMS, voice verification and push.
+"""
+
+from .client import YunmailClient
+from .errors import (
+    APIError,
+    AuthenticationError,
+    RateLimitError,
+    YunmailError,
+)
+from .models import MessageResult
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "YunmailClient",
+    "MessageResult",
+    "YunmailError",
+    "APIError",
+    "AuthenticationError",
+    "RateLimitError",
+    "__version__",
+]

yunmail-0.1.0/src/yunmail/client.py

@@ -0,0 +1,204 @@
+"""Yunmail API client.
+
+Covers the four Yunmail channels — email, SMS, voice verification and
+push notifications — through one REST client with a single API key.
+
+The transport is injectable, which keeps the SDK dependency-free
+(standard library only) and easy to test: pass any callable with the
+signature ``transport(method, url, headers, body) -> (status, headers,
+body)``.
+"""
+
+import hashlib
+import hmac
+import json
+import time
+import urllib.error
+import urllib.request
+from typing import Any, Callable, Dict, Iterable, Optional, Sequence, Tuple
+
+from .errors import APIError, AuthenticationError, RateLimitError
+from .models import MessageResult
+
+DEFAULT_BASE_URL = "https://api.yunmail.cc.cd/v1"
+
+Transport = Callable[
+    [str, str, Dict[str, str], Optional[bytes]],
+    Tuple[int, Dict[str, str], bytes],
+]
+
+
+def _urllib_transport(method, url, headers, body):
+    req = urllib.request.Request(url, data=body, headers=headers, method=method)
+    try:
+        with urllib.request.urlopen(req, timeout=30) as resp:
+            return resp.status, dict(resp.headers), resp.read()
+    except urllib.error.HTTPError as exc:  # non-2xx still carries a body
+        return exc.code, dict(exc.headers or {}), exc.read()
+    except urllib.error.URLError as exc:
+        raise APIError(0, f"Network error calling Yunmail API: {exc.reason}") from exc
+
+
+class YunmailClient:
+    """Client for the Yunmail cloud communications API.
+
+    Args:
+        api_key: Your Yunmail API key (sent as a Bearer token).
+        base_url: API base URL; override for staging or self-hosted use.
+        timeout: Per-request timeout in seconds (default transport only).
+        max_retries: Retries on HTTP 429 / 5xx with exponential backoff.
+        transport: Custom transport callable (mainly for testing).
+        sleeper: Sleep function used between retries (mainly for testing).
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: int = 30,
+        max_retries: int = 2,
+        transport: Optional[Transport] = None,
+        sleeper: Callable[[float], None] = time.sleep,
+    ):
+        if not api_key:
+            raise ValueError("api_key is required")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.max_retries = max_retries
+        self._transport = transport or _urllib_transport
+        self._sleeper = sleeper
+
+    # ------------------------------------------------------------------
+    # Channels
+    # ------------------------------------------------------------------
+    def send_email(
+        self,
+        to: str,
+        subject: str,
+        html: Optional[str] = None,
+        text: Optional[str] = None,
+        from_addr: Optional[str] = None,
+        tags: Optional[Sequence[str]] = None,
+    ) -> MessageResult:
+        """Send a transactional or marketing email."""
+        if html is None and text is None:
+            raise ValueError("either html or text content is required")
+        payload: Dict[str, Any] = {"to": to, "subject": subject}
+        if html is not None:
+            payload["html"] = html
+        if text is not None:
+            payload["text"] = text
+        if from_addr is not None:
+            payload["from"] = from_addr
+        if tags:
+            payload["tags"] = list(tags)
+        return self._send("/email/send", payload, channel="email")
+
+    def send_sms(
+        self,
+        to: str,
+        content: Optional[str] = None,
+        template_id: Optional[str] = None,
+        params: Optional[Dict[str, Any]] = None,
+    ) -> MessageResult:
+        """Send an SMS (verification code, alert or marketing message)."""
+        if content is None and template_id is None:
+            raise ValueError("either content or template_id is required")
+        payload: Dict[str, Any] = {"to": to}
+        if content is not None:
+            payload["content"] = content
+        if template_id is not None:
+            payload["template_id"] = template_id
+        if params:
+            payload["params"] = params
+        return self._send("/sms/send", payload, channel="sms")
+
+    def send_voice_code(
+        self,
+        to: str,
+        code: str,
+        lang: str = "en-US",
+    ) -> MessageResult:
+        """Deliver a one-time passcode by voice call (SMS fallback)."""
+        payload = {"to": to, "code": code, "lang": lang}
+        return self._send("/voice/send", payload, channel="voice")
+
+    def send_push(
+        self,
+        device_tokens: Iterable[str],
+        title: str,
+        body: str,
+        data: Optional[Dict[str, Any]] = None,
+    ) -> MessageResult:
+        """Send an app/web push notification to one or more devices."""
+        payload: Dict[str, Any] = {
+            "device_tokens": list(device_tokens),
+            "title": title,
+            "body": body,
+        }
+        if data:
+            payload["data"] = data
+        return self._send("/push/send", payload, channel="push")
+
+    def get_message_status(self, message_id: str) -> Dict[str, Any]:
+        """Fetch the delivery status of a previously sent message."""
+        return self._request("GET", f"/messages/{message_id}")
+
+    # ------------------------------------------------------------------
+    # Webhooks
+    # ------------------------------------------------------------------
+    @staticmethod
+    def verify_webhook(payload: bytes, signature: str, secret: str) -> bool:
+        """Verify an HMAC-SHA256 webhook signature in constant time."""
+        expected = hmac.new(
+            secret.encode("utf-8"), payload, hashlib.sha256
+        ).hexdigest()
+        return hmac.compare_digest(expected, signature.strip())
+
+    # ------------------------------------------------------------------
+    # Internals
+    # ------------------------------------------------------------------
+    def _send(self, path: str, payload: Dict[str, Any], channel: str) -> MessageResult:
+        data = self._request("POST", path, payload)
+        return MessageResult.from_payload(data, channel=channel)
+
+    def _request(
+        self, method: str, path: str, payload: Optional[Dict[str, Any]] = None
+    ) -> Dict[str, Any]:
+        url = f"{self.base_url}{path}"
+        headers = {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "User-Agent": "yunmail-python/0.1.0",
+        }
+        body = json.dumps(payload).encode("utf-8") if payload is not None else None
+
+        attempt = 0
+        while True:
+            status, _resp_headers, raw = self._transport(method, url, headers, body)
+            if 200 <= status < 300:
+                return json.loads(raw.decode("utf-8")) if raw else {}
+            retryable = status == 429 or status >= 500
+            if retryable and attempt < self.max_retries:
+                self._sleeper(0.5 * (2**attempt))
+                attempt += 1
+                continue
+            self._raise_for_status(status, raw)
+
+    @staticmethod
+    def _raise_for_status(status: int, raw: bytes):
+        payload = None
+        message = ""
+        if raw:
+            try:
+                payload = json.loads(raw.decode("utf-8"))
+                message = payload.get("message") or payload.get("error") or ""
+            except (ValueError, UnicodeDecodeError):
+                message = raw.decode("utf-8", errors="replace")[:200]
+        if status in (401, 403):
+            raise AuthenticationError(status, message, payload)
+        if status == 429:
+            raise RateLimitError(status, message, payload)
+        raise APIError(status, message, payload)

yunmail-0.1.0/src/yunmail/errors.py

@@ -0,0 +1,22 @@
+"""Exception types raised by the Yunmail SDK."""
+
+
+class YunmailError(Exception):
+    """Base class for all Yunmail SDK errors."""
+
+
+class APIError(YunmailError):
+    """The API returned a non-2xx response."""
+
+    def __init__(self, status: int, message: str = "", payload=None):
+        self.status = status
+        self.payload = payload
+        super().__init__(message or f"Yunmail API error (HTTP {status})")
+
+
+class AuthenticationError(APIError):
+    """HTTP 401/403 — the API key is missing, invalid or lacks scope."""
+
+
+class RateLimitError(APIError):
+    """HTTP 429 — too many requests; back off and retry."""

yunmail-0.1.0/src/yunmail/models.py

@@ -0,0 +1,23 @@
+"""Response models returned by the Yunmail SDK."""
+
+from dataclasses import dataclass, field
+from typing import Any, Dict, Optional
+
+
+@dataclass
+class MessageResult:
+    """Result of a send request (email / SMS / voice / push)."""
+
+    id: Optional[str] = None
+    status: Optional[str] = None
+    channel: Optional[str] = None
+    raw: Dict[str, Any] = field(default_factory=dict)
+
+    @classmethod
+    def from_payload(cls, payload: Dict[str, Any], channel: str) -> "MessageResult":
+        return cls(
+            id=payload.get("id") or payload.get("message_id"),
+            status=payload.get("status"),
+            channel=channel,
+            raw=payload,
+        )

yunmail-0.1.0/src/yunmail.egg-info/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: yunmail
+Version: 0.1.0
+Summary: Official Python SDK for the Yunmail cloud communications API — email, SMS, voice verification and push notifications through one unified API.
+Author: Yunmail Maintainers
+License: Apache-2.0
+Project-URL: Homepage, https://www.yunmail.cc.cd
+Project-URL: Documentation, https://www.yunmail.cc.cd
+Project-URL: Issues, https://github.com/tanxi281-sketch/yunmail-sdk/issues
+Keywords: yunmail,email-api,sms-api,voice-otp,push-notifications,cloud-communications
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Communications :: Email
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Yunmail Python SDK
+
+Official Python SDK for the [Yunmail](https://www.yunmail.cc.cd) cloud
+communications platform — **email, SMS, voice verification and push
+notifications through one unified API**, with a single API key.
+
+- 📧 Transactional & marketing email with template support
+- 💬 SMS verification codes, alerts and campaigns (200+ countries/regions)
+- 📞 Voice OTP as a reliable fallback where SMS can't reach
+- 🔔 App & web push notifications
+- 🔐 HMAC-SHA256 webhook signature verification built in
+- 🚀 Zero dependencies — Python standard library only
+
+> Status: **0.1.0 (alpha)**. The API surface covers the four core send
+> channels plus delivery-status lookup. See [ROADMAP.md](ROADMAP.md).
+
+## Installation
+
+```bash
+pip install yunmail
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/tanxi281-sketch/yunmail-sdk.git
+cd yunmail-sdk
+pip install -e .
+```
+
+## Quickstart
+
+```python
+from yunmail import YunmailClient
+
+client = YunmailClient(api_key="YOUR_YUNMAIL_API_KEY")
+
+# Email
+client.send_email(
+    to="user@example.com",
+    subject="Welcome to Yunmail",
+    html="<p>Thanks for signing up!</p>",
+)
+
+# SMS verification code (template based)
+client.send_sms(
+    to="+8613800000000",
+    template_id="verify_code",
+    params={"code": "123456"},
+)
+
+# Voice OTP fallback
+client.send_voice_code(to="+8613800000000", code="123456")
+
+# Push notification
+client.send_push(
+    device_tokens=["device-token-1"],
+    title="Order shipped",
+    body="Your order is on its way.",
+)
+
+# Delivery status of any message
+status = client.get_message_status("MESSAGE_ID")
+```
+
+## Webhook verification
+
+Verify that a webhook really came from Yunmail before trusting it:
+
+```python
+from yunmail import YunmailClient
+
+ok = YunmailClient.verify_webhook(
+    payload=request_body_bytes,        # raw request body
+    signature=request.headers["X-Yunmail-Signature"],
+    secret="YOUR_WEBHOOK_SECRET",
+)
+```
+
+## Error handling
+
+```python
+from yunmail import AuthenticationError, RateLimitError, APIError
+
+try:
+    client.send_email(...)
+except AuthenticationError:
+    ...  # bad or under-scoped API key (HTTP 401/403)
+except RateLimitError:
+    ...  # HTTP 429 — the client already retried with backoff
+except APIError as exc:
+    print(exc.status, exc.payload)
+```
+
+HTTP 429 and 5xx responses are retried automatically with exponential
+backoff (`max_retries=2` by default).
+
+## Development
+
+```bash
+python -m unittest discover -s tests -v
+```
+
+Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

yunmail-0.1.0/src/yunmail.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/yunmail/__init__.py
+src/yunmail/client.py
+src/yunmail/errors.py
+src/yunmail/models.py
+src/yunmail.egg-info/PKG-INFO
+src/yunmail.egg-info/SOURCES.txt
+src/yunmail.egg-info/dependency_links.txt
+src/yunmail.egg-info/top_level.txt
+tests/test_client.py

yunmail-0.1.0/src/yunmail.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

yunmail-0.1.0/src/yunmail.egg-info/top_level.txt

@@ -0,0 +1 @@
+yunmail

yunmail-0.1.0/tests/test_client.py

@@ -0,0 +1,100 @@
+import json
+import unittest
+
+from yunmail import (
+    AuthenticationError,
+    RateLimitError,
+    YunmailClient,
+)
+from yunmail.client import YunmailClient as Client
+
+
+class FakeTransport:
+    """Records requests and replays queued (status, payload) responses."""
+
+    def __init__(self, responses):
+        self.responses = list(responses)
+        self.requests = []
+
+    def __call__(self, method, url, headers, body):
+        self.requests.append((method, url, headers, body))
+        status, payload = self.responses.pop(0)
+        return status, {}, json.dumps(payload).encode("utf-8")
+
+
+def make_client(responses):
+    transport = FakeTransport(responses)
+    client = Client(
+        "test-key", transport=transport, sleeper=lambda _s: None
+    )
+    return client, transport
+
+
+class SendEmailTest(unittest.TestCase):
+    def test_send_email_posts_expected_payload(self):
+        client, transport = make_client([(200, {"id": "m1", "status": "queued"})])
+        result = client.send_email(
+            "user@example.com", "Welcome", html="<p>Hi</p>", tags=["onboarding"]
+        )
+        self.assertEqual(result.id, "m1")
+        self.assertEqual(result.channel, "email")
+        method, url, headers, body = transport.requests[0]
+        self.assertEqual(method, "POST")
+        self.assertTrue(url.endswith("/email/send"))
+        self.assertEqual(headers["Authorization"], "Bearer test-key")
+        payload = json.loads(body.decode("utf-8"))
+        self.assertEqual(payload["to"], "user@example.com")
+        self.assertEqual(payload["tags"], ["onboarding"])
+
+    def test_send_email_requires_content(self):
+        client, _ = make_client([])
+        with self.assertRaises(ValueError):
+            client.send_email("user@example.com", "No body")
+
+
+class SendSmsTest(unittest.TestCase):
+    def test_send_sms_with_template(self):
+        client, transport = make_client([(200, {"id": "s1", "status": "sent"})])
+        result = client.send_sms(
+            "+8613800000000", template_id="verify", params={"code": "123456"}
+        )
+        self.assertEqual(result.id, "s1")
+        payload = json.loads(transport.requests[0][3].decode("utf-8"))
+        self.assertEqual(payload["template_id"], "verify")
+        self.assertEqual(payload["params"]["code"], "123456")
+
+
+class ErrorMappingTest(unittest.TestCase):
+    def test_401_raises_authentication_error(self):
+        client, _ = make_client([(401, {"message": "invalid key"})])
+        with self.assertRaises(AuthenticationError):
+            client.get_message_status("m1")
+
+    def test_429_retries_then_raises_rate_limit(self):
+        client, transport = make_client([(429, {}), (429, {}), (429, {})])
+        with self.assertRaises(RateLimitError):
+            client.send_sms("+10000000000", content="hi")
+        self.assertEqual(len(transport.requests), 3)  # 1 try + 2 retries
+
+    def test_500_retries_then_succeeds(self):
+        client, _ = make_client([(500, {}), (200, {"id": "v1", "status": "calling"})])
+        result = client.send_voice_code("+10000000000", "123456")
+        self.assertEqual(result.id, "v1")
+
+
+class WebhookTest(unittest.TestCase):
+    def test_verify_webhook(self):
+        import hashlib
+        import hmac
+
+        payload = b'{"event":"delivered","id":"m1"}'
+        secret = "whsec_test"
+        signature = hmac.new(
+            secret.encode(), payload, hashlib.sha256
+        ).hexdigest()
+        self.assertTrue(YunmailClient.verify_webhook(payload, signature, secret))
+        self.assertFalse(YunmailClient.verify_webhook(payload, "0" * 64, secret))
+
+
+if __name__ == "__main__":
+    unittest.main()