sendbyte 0.2.1__tar.gz → 0.3.0__tar.gz

{sendbyte-0.2.1/sendbyte.egg-info → sendbyte-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sendbyte
-Version: 0.2.1
+Version: 0.3.0
 Summary: SendByte Python SDK: the email API for Africa.
 Author: Echospectra Technology Limited
 License: MIT
@@ -85,6 +85,7 @@ asyncio.run(main())
 sendbyte.emails.send(from_=..., to=..., subject=..., html=...)
 sendbyte.emails.get("em_123")
 sendbyte.emails.list(limit=20, status="delivered")
+sendbyte.emails.conversation("em_123")
 ```
 
 `to`, `cc`, `bcc`, and `reply_to` accept a single address or a list. Pass `idempotency_key` to make retries safe, `scheduled_at` for future sends, and `template_id` with `variables` to render a server side template.
@@ -112,6 +113,38 @@ sendbyte.webhooks.disable(endpoint["id"])
 sendbyte.webhooks.replay("evt_123")
 ```
 
+### Receiving email
+
+Receive mail on a subdomain of a verified domain, read it, and reply in the same thread. Received emails count toward your monthly email quota, the same as sent emails; `enable()` acknowledges that for you. Spam and virus emails never count.
+
+```python
+sendbyte.receiving.enable()
+setup = sendbyte.receiving.enable_domain("dom_123", subdomain="inbound")
+# publish setup["mx_record"], then confirm it is live
+sendbyte.receiving.check_domain("dom_123")
+
+page = sendbyte.received.list(status="received,delivered", limit=20)
+email = sendbyte.received.get(page["data"][0]["id"])
+print(email["from"], email["subject"], email["text"])
+
+sendbyte.received.reply(email["id"], text="Thanks, we are on it.")
+```
+
+Routes decide what happens to mail arriving at matching addresses: send it to your webhooks, forward it, or drop it.
+
+```python
+sendbyte.inbound_routes.create(
+    "exact",
+    domain_id="dom_123",
+    match_value="support",
+    action="forward",
+    forward_to=["team@paylink.ng"],
+)
+sendbyte.inbound_routes.list("dom_123")
+```
+
+Subscribe a webhook to `email.received` to get the whole email, bodies included, as it arrives. On the async client the same methods are awaitable under `sendbyte.receiving`, `sendbyte.received` and `sendbyte.inbound_routes`. See the [receiving guide](https://docs.sendbyte.africa/guides/receiving).
+
 ## Verifying webhook signatures
 
 Every webhook request carries a `sendbyte-signature` header. Verify it against the raw request body before trusting the payload.

{sendbyte-0.2.1 → sendbyte-0.3.0}/README.md

@@ -64,6 +64,7 @@ asyncio.run(main())
 sendbyte.emails.send(from_=..., to=..., subject=..., html=...)
 sendbyte.emails.get("em_123")
 sendbyte.emails.list(limit=20, status="delivered")
+sendbyte.emails.conversation("em_123")
 ```
 
 `to`, `cc`, `bcc`, and `reply_to` accept a single address or a list. Pass `idempotency_key` to make retries safe, `scheduled_at` for future sends, and `template_id` with `variables` to render a server side template.
@@ -91,6 +92,38 @@ sendbyte.webhooks.disable(endpoint["id"])
 sendbyte.webhooks.replay("evt_123")
 ```
 
+### Receiving email
+
+Receive mail on a subdomain of a verified domain, read it, and reply in the same thread. Received emails count toward your monthly email quota, the same as sent emails; `enable()` acknowledges that for you. Spam and virus emails never count.
+
+```python
+sendbyte.receiving.enable()
+setup = sendbyte.receiving.enable_domain("dom_123", subdomain="inbound")
+# publish setup["mx_record"], then confirm it is live
+sendbyte.receiving.check_domain("dom_123")
+
+page = sendbyte.received.list(status="received,delivered", limit=20)
+email = sendbyte.received.get(page["data"][0]["id"])
+print(email["from"], email["subject"], email["text"])
+
+sendbyte.received.reply(email["id"], text="Thanks, we are on it.")
+```
+
+Routes decide what happens to mail arriving at matching addresses: send it to your webhooks, forward it, or drop it.
+
+```python
+sendbyte.inbound_routes.create(
+    "exact",
+    domain_id="dom_123",
+    match_value="support",
+    action="forward",
+    forward_to=["team@paylink.ng"],
+)
+sendbyte.inbound_routes.list("dom_123")
+```
+
+Subscribe a webhook to `email.received` to get the whole email, bodies included, as it arrives. On the async client the same methods are awaitable under `sendbyte.receiving`, `sendbyte.received` and `sendbyte.inbound_routes`. See the [receiving guide](https://docs.sendbyte.africa/guides/receiving).
+
 ## Verifying webhook signatures
 
 Every webhook request carries a `sendbyte-signature` header. Verify it against the raw request body before trusting the payload.

{sendbyte-0.2.1 → sendbyte-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sendbyte"
-version = "0.2.1"
+version = "0.3.0"
 description = "SendByte Python SDK: the email API for Africa."
 readme = "README.md"
 license = { text = "MIT" }