# unimal-py-sdk
This is a Python SDK for Unimail. Quickly integrate into your project
[github](https://github.com/i-curve/unimail-py-sdk) [中文文档](README_zh.md)
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
- [unimal-py-sdk](#unimal-py-sdk)
- [simple usage](#simple-usage)
- [api docs](#api-docs)
- [support language](#support-language)
<!-- /code_chunk_output -->
## simple usage
- init a unimail client
you need a authorization key.
main.py
```python
from unimail-py-sdk import Client, Result
# please input your key here
key: str = ""
client: Client = Client(key)
client.check_connect()
```
- send email
example
receiver: aaa@gmail.com
email subject: email subject
email content: this is a email content
```python
result: Result := client.send_email("aaa@gmail.com", "email subject", "this is a email content")
if result.is_success:
print("send email success")
else:
print(f"send email fail, error: {result.msg}")
```
- batch send email
example
receivers: aaa@gmail.com,bbb@gmail.com
email subject: email subject
email content: this is a email content
```python
result: Result := client.batch_send_email("aaa@gmail.com", "email subject", "this is a email content")
if result.is_success:
print("send email success")
else:
print(f"send email fail, error: {result.msg}")
```
## api docs
1. Client(key: str, host: str, data: str, obj: json): Client
init a client by key
2. client.set_language(language :str) -> bool
set language for the client,default is zh
3. client.check_connect() -> bool
check the host and key is ok
4. client.send_email(receiver :str, subject :str, content :str) -> Result
send email to receiver. if you have many receiver, you can concat the receiver by ";" or use BatchSendEmail
5. client.batch_send_email(receivers :list, subject :str, content :str) -> Result
like SendEmail, but receivers is a slice
## support language
chinese is the default language for the sdk.
- [x] english (en)
- [x] simple chinese (zh)
- [x] vietnamese (vi)
- [x] idonesian (id)
- [x] thai (th)
- [x] gujarati (gu)
if you want to support other language, please open a issue.
# unimal-py-sdk
unimail 的 python 语言 sdk, 快速集成到你的项目
[github](https://github.com/i-curve/unimail-py-sdk) [英文文档](README.md)
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
<!-- code_chunk_output -->
- [unimal-py-sdk](#unimal-py-sdk)
- [简单使用](#简单使用)
- [api docs](#api-docs)
- [支持的语言](#支持的语言)
<!-- /code_chunk_output -->
## 简单使用
- 初始化客户端
你需要申请一个 key
main.py
```python
from unimail-py-sdk import Client, Result
# please input your key here
key: str = ""
client: Client = Client(key)
client.check_connect()
```
- 发邮件
例如
收件人: aaa@gmail.com
邮件标题: email subject
邮件正文: this is a email content
```python
result: Result := client.send_email("aaa@gmail.com", "email subject", "this is a email content")
if result.is_success:
print("send email success")
else:
print(f"send email fail, error: {result.msg}")
```
- 批量发送邮件
例如
收件人: aaa@gmail.com,bbb@gmail.com
邮件标题: email subject
邮件正文: this is a email content
```python
result: Result := client.batch_send_email("aaa@gmail.com", "email subject", "this is a email content")
if result.is_success:
print("send email success")
else:
print(f"send email fail, error: {result.msg}")
```
## api docs
1. Client(key: str, host: str, data: str, obj: json): Client
init a client by key
2. client.set_language(language :str) -> bool
set language for the client,default is zh
3. client.check_connect() -> bool
check the host and key is ok
4. client.send_email(receiver :str, subject :str, content :str) -> Result
send email to receiver. if you have many receiver, you can concat the receiver by ";" or use BatchSendEmail
5. client.batch_send_email(receivers :list, subject :str, content :str) -> Result
like SendEmail, but receivers is a slice
## 支持的语言
sdk 默认返回的 msg 为中文
- [x] english (en)
- [x] simple chinese (zh)
- [x] vietnamese (vi)
- [x] idonesian (id)
- [x] thai (th)
- [x] gujarati (gu)
如果你需要添加了更多语言，欢迎提 issue
Raw data
{
"_id": null,
"home_page": "https://github.com/i-curve/unimail-py-sdk",
"name": "unimail-py-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "unimail, unimail-py-sdk",
"author": "i-curve",
"author_email": "i-curve@qq.com",
"download_url": "https://files.pythonhosted.org/packages/ec/e9/3b440e57e8754a3e3cf8f33882c27b27deaf4d7d40917a91cb5c436085e8/unimail_py_sdk-0.0.4.tar.gz",
"platform": null,
"description": "# unimal-py-sdk\n\nThis is a Python SDK for Unimail. Quickly integrate into your project\n\n[github](https://github.com/i-curve/unimail-py-sdk) [\u4e2d\u6587\u6587\u6863](README_zh.md)\n\n<!-- @import \"[TOC]\" {cmd=\"toc\" depthFrom=1 depthTo=6 orderedList=false} -->\n\n<!-- code_chunk_output -->\n\n- [unimal-py-sdk](#unimal-py-sdk)\n - [simple usage](#simple-usage)\n - [api docs](#api-docs)\n - [support language](#support-language)\n\n<!-- /code_chunk_output -->\n\n## simple usage\n\n- init a unimail client\n\nyou need a authorization key.\n\nmain.py\n\n```python\nfrom unimail-py-sdk import Client, Result\n\n# please input your key here\nkey: str = \"\"\n\nclient: Client = Client(key)\n\nclient.check_connect()\n```\n\n- send email\n\nexample\nreceiver: aaa@gmail.com \nemail subject: email subject \nemail content: this is a email content\n\n```python\n result: Result := client.send_email(\"aaa@gmail.com\", \"email subject\", \"this is a email content\")\n\n if result.is_success:\n print(\"send email success\")\n else:\n print(f\"send email fail, error: {result.msg}\")\n```\n\n- batch send email\n\nexample\nreceivers: aaa@gmail.com,bbb@gmail.com \nemail subject: email subject \nemail content: this is a email content\n\n```python\n result: Result := client.batch_send_email(\"aaa@gmail.com\", \"email subject\", \"this is a email content\")\n\n if result.is_success:\n print(\"send email success\")\n else:\n print(f\"send email fail, error: {result.msg}\")\n```\n\n## api docs\n\n1. Client(key: str, host: str, data: str, obj: json): Client\n\ninit a client by key\n\n2. client.set_language(language :str) -> bool\n\nset language for the client,default is zh\n\n3. client.check_connect() -> bool\n\ncheck the host and key is ok\n\n4. client.send_email(receiver :str, subject :str, content :str) -> Result\n\nsend email to receiver. if you have many receiver, you can concat the receiver by \";\" or use BatchSendEmail\n\n5. client.batch_send_email(receivers :list, subject :str, content :str) -> Result\n\nlike SendEmail, but receivers is a slice\n\n## support language\n\nchinese is the default language for the sdk.\n\n- [x] english (en)\n- [x] simple chinese (zh)\n- [x] vietnamese (vi)\n- [x] idonesian (id)\n- [x] thai (th)\n- [x] gujarati (gu)\n\nif you want to support other language, please open a issue.\n\n# unimal-py-sdk\n\nunimail \u7684 python \u8bed\u8a00 sdk, \u5feb\u901f\u96c6\u6210\u5230\u4f60\u7684\u9879\u76ee\n\n[github](https://github.com/i-curve/unimail-py-sdk) [\u82f1\u6587\u6587\u6863](README.md)\n\n<!-- @import \"[TOC]\" {cmd=\"toc\" depthFrom=1 depthTo=6 orderedList=false} -->\n\n<!-- code_chunk_output -->\n\n- [unimal-py-sdk](#unimal-py-sdk)\n - [\u7b80\u5355\u4f7f\u7528](#\u7b80\u5355\u4f7f\u7528)\n - [api docs](#api-docs)\n - [\u652f\u6301\u7684\u8bed\u8a00](#\u652f\u6301\u7684\u8bed\u8a00)\n\n<!-- /code_chunk_output -->\n\n## \u7b80\u5355\u4f7f\u7528\n\n- \u521d\u59cb\u5316\u5ba2\u6237\u7aef\n\n\u4f60\u9700\u8981\u7533\u8bf7\u4e00\u4e2a key\n\nmain.py\n\n```python\nfrom unimail-py-sdk import Client, Result\n\n# please input your key here\nkey: str = \"\"\n\nclient: Client = Client(key)\n\nclient.check_connect()\n```\n\n- \u53d1\u90ae\u4ef6\n\n\u4f8b\u5982\n\u6536\u4ef6\u4eba: aaa@gmail.com \n\u90ae\u4ef6\u6807\u9898: email subject \n\u90ae\u4ef6\u6b63\u6587: this is a email content\n\n```python\n result: Result := client.send_email(\"aaa@gmail.com\", \"email subject\", \"this is a email content\")\n\n if result.is_success:\n print(\"send email success\")\n else:\n print(f\"send email fail, error: {result.msg}\")\n```\n\n- \u6279\u91cf\u53d1\u9001\u90ae\u4ef6\n\n\u4f8b\u5982\n\u6536\u4ef6\u4eba: aaa@gmail.com,bbb@gmail.com \n\u90ae\u4ef6\u6807\u9898: email subject \n\u90ae\u4ef6\u6b63\u6587: this is a email content\n\n```python\n result: Result := client.batch_send_email(\"aaa@gmail.com\", \"email subject\", \"this is a email content\")\n\n if result.is_success:\n print(\"send email success\")\n else:\n print(f\"send email fail, error: {result.msg}\")\n```\n\n## api docs\n\n1. Client(key: str, host: str, data: str, obj: json): Client\n\ninit a client by key\n\n2. client.set_language(language :str) -> bool\n\nset language for the client,default is zh\n\n3. client.check_connect() -> bool\n\ncheck the host and key is ok\n\n4. client.send_email(receiver :str, subject :str, content :str) -> Result\n\nsend email to receiver. if you have many receiver, you can concat the receiver by \";\" or use BatchSendEmail\n\n5. client.batch_send_email(receivers :list, subject :str, content :str) -> Result\n\nlike SendEmail, but receivers is a slice\n\n## \u652f\u6301\u7684\u8bed\u8a00\n\nsdk \u9ed8\u8ba4\u8fd4\u56de\u7684 msg \u4e3a\u4e2d\u6587\n\n- [x] english (en)\n- [x] simple chinese (zh)\n- [x] vietnamese (vi)\n- [x] idonesian (id)\n- [x] thai (th)\n- [x] gujarati (gu)\n\n\u5982\u679c\u4f60\u9700\u8981\u6dfb\u52a0\u4e86\u66f4\u591a\u8bed\u8a00\uff0c\u6b22\u8fce\u63d0 issue\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "This is a Python SDK for Unimail. Quickly integrate into your project",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/i-curve/unimail-py-sdk/issues",
"Documentation": "https://github.com/i-curve/unimail-py-sdk",
"Homepage": "https://github.com/i-curve/unimail-py-sdk",
"Repository": "https://github.com/i-curve/unimail-py-sdk"
},
"split_keywords": [
"unimail",
" unimail-py-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20d38da859ae4eaab19622f37d2736ab5239c579e7e3e0e0cfa4699eeaf01150",
"md5": "b4fe7774a1230d2c88a1a9a0b9dee2cb",
"sha256": "bb442ea50032a88ecf0084c0e21e8f9660f6246a71a0b73c272d6bd2f14d4d0e"
},
"downloads": -1,
"filename": "unimail_py_sdk-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4fe7774a1230d2c88a1a9a0b9dee2cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 4573,
"upload_time": "2025-01-06T06:24:24",
"upload_time_iso_8601": "2025-01-06T06:24:24.136000Z",
"url": "https://files.pythonhosted.org/packages/20/d3/8da859ae4eaab19622f37d2736ab5239c579e7e3e0e0cfa4699eeaf01150/unimail_py_sdk-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ece93b440e57e8754a3e3cf8f33882c27b27deaf4d7d40917a91cb5c436085e8",
"md5": "be9a3f3c4ed884c74df9402f60f7e012",
"sha256": "bbebcdcd34cfd111028ae0fd784cb41e4220b1642c02db269d26ce503ac549ee"
},
"downloads": -1,
"filename": "unimail_py_sdk-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "be9a3f3c4ed884c74df9402f60f7e012",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 4220,
"upload_time": "2025-01-06T06:24:26",
"upload_time_iso_8601": "2025-01-06T06:24:26.935598Z",
"url": "https://files.pythonhosted.org/packages/ec/e9/3b440e57e8754a3e3cf8f33882c27b27deaf4d7d40917a91cb5c436085e8/unimail_py_sdk-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 06:24:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "i-curve",
"github_project": "unimail-py-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "unimail-py-sdk"
}
JSON
