diff --git a/README.md b/README.md index cfac961..16870d3 100644 --- a/README.md +++ b/README.md @@ -121,3 +121,11 @@ We are grateful for the support of our sponsors. doras.to + + + anaclumos + + + + miguilimzero + diff --git a/apps/docs/community-sdk/python.mdx b/apps/docs/community-sdk/python.mdx deleted file mode 100644 index 369bb84..0000000 --- a/apps/docs/community-sdk/python.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: Python -description: "The Unsend Python package lets you interact with the Unsend API to send and manage emails as well as domains. This is a quick guide on using the package to send emails and retrieve email information." -icon: python ---- - - - This is a community-maintained package and not maintained by the Unsend. - - -**Shout out to [harshsbhat](https://x.com/HarshBhatX) for maintaining this package.** - -## Installation - -To install the Unsend package, you can use pip: - -```bash -pip install unsendcommunity -``` - -## Related Links - -GitHub Repository: [GitHub](https://github.com/harshsbhat/unsend_community.git) - -PyPI package: [PyPi](https://pypi.org/project/UnsendCommunity/) - -## Usage - -Below is an example of how to use the Unsend package to send an email and retrieve email information. - -### Initialize - -Change the URL accordingly if you are using self self-hosted version of Unsend. The default URL will be https://app.unsend.dev. - -```python - -from unsendcommunity import Unsend - -# Initialize the Unsend client -api_key = 'your-api-key' -client = Unsend(key=api_key, url='https://app.unsend.dev') - -``` - -### Sending Emails - -To send an email you will need to define the payload. After definition, you can use the `.send_emails` method to send emails with the payload as a parameter. - -```python -payload = { - "to": "youremail@gmail.com", - "from": "hello@domainname.com", - "subject": "Unsend test email", - "text": "hello,\n\nUnsend is the best open source sending platform", - "html": "

hello,

Unsend is the best open source sending platform

check out unsend.dev

", -} - -# Send the email -response = client.send_email(payload) -print("Send Email Response:", response) -``` - -### Retrieve Emails using the id - -The email will be retrieved using the ID you get after sending the mail. - -```python -email_id = 'email-id-from-unsend' -email_response = client.get_email(email_id) -print("Get Email Response:", email_response) -``` - -The sample response of `get_email` is shown below: - -```bash -{ - "data": { - "id": "your-email-id", - "teamId": 1, - "to": [ - "yourmail@example.com" - ], - "from": "hello@mail.example.com", - "subject": "Unsend test email", - "html": "

hello,

Unsend is the best open source sending platform

check out unsend.dev

", - "text": "hello,\n\nUnsend is the best open source sending platform", - "createdAt": "2024-07-29T05:04:21.498Z", - "updatedAt": "2024-07-29T05:04:27.130Z", - "emailEvents": [ - { - "emailId": "your-email-id", - "status": "FAILED", - "createdAt": "2024-07-29T05:04:27.124Z", - "data": { - "error": "MessageRejected: Email address is not verified. The following identities failed the check in region US-EAST-1: example@gmail.com" - } - } - ] - }, - "error": null -} -``` - -### Retrieve domain information - -Retrieves domain information -Domains that are associated with this account will be displayed with their detailed information. - -```python -domain_response = client.get_domain() -print("Get Domain Response:", domain_response) -``` - -Sample response of the `get_domain` method - -```bash -{ - "data": [ - { - "id": 1, - "name": "mail.domain.com", - "teamId": 1, - "status": "SUCCESS", - "region": "us-east-1", - "clickTracking": false, - "openTracking": false, - "publicKey": "your-public-key", - "dkimStatus": "SUCCESS", - "spfDetails": "SUCCESS", - "dmarcAdded": false, - "errorMessage": null, - "subdomain": "mail", - "isVerifying": false, - "createdAt": "2024-07-26T05:52:17.199Z", - "updatedAt": "2024-07-26T05:57:27.790Z" - } - ], - "error": null -} -``` diff --git a/apps/docs/guides/use-with-react-email.mdx b/apps/docs/guides/use-with-react-email.mdx index 1cf75c3..af075bc 100644 --- a/apps/docs/guides/use-with-react-email.mdx +++ b/apps/docs/guides/use-with-react-email.mdx @@ -11,19 +11,19 @@ description: "A guide on how to use useSend with React Email" ```sh npm - npm install usesend @react-email/render + npm install usesend-js @react-email/render ``` ```sh yarn -yarn add usesend @react-email/render +yarn add usesend-js @react-email/render ``` ```sh pnpm -pnpm add usesend @react-email/render +pnpm add usesend-js @react-email/render ``` ```sh bun -bun add usesend @react-email/render +bun add usesend-js @react-email/render ``` @@ -49,7 +49,7 @@ export function Email(props) { ## Send an email using useSend ```ts -import { UseSend } from "usesend"; +import { UseSend } from "usesend-js"; import { render } from "@react-email/render"; import { Email } from "./email";