unimail-py-sdk 0.3.0

This is a Python SDK for Unimail. Quickly integrate into your project

unimal-py-sdk

This is a Python SDK for Unimail. Quickly integrate into your project

github 中文文档

• unimal-py-sdk
  • simple usage
  • api docs
  • support language

simple usage

• pip install

pip install unimail-py-sdk

• init a unimail client

you need a authorization key.

main.py

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: [e-mail]
email subject: email subject
email content: this is a email content

    result: Result := client.send_email("[e-mail]", "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: [e-mail],[e-mail]
email subject: email subject
email content: this is a email content

    result: Result := client.batch_send_email("[e-mail]", "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.

• english (en)
• simple chinese (zh)
• vietnamese (vi)
• idonesian (id)
• thai (th)
• gujarati (gu)

if you want to support other language, please open a issue.

• tips

If you want to use this SDK, please contact the author via [e-mail].

unimal-py-sdk

unimail 的 python 语言 sdk, 快速集成到你的项目

github 英文文档

• unimal-py-sdk
  • 简单使用
  • api docs
  • 支持的语言

简单使用

• pip 安装包

pip install unimail-py-sdk

• 初始化客户端

你需要申请一个 key

main.py

from unimail-py-sdk import Client, Result

# please input your key here
key: str = ""

client: Client = Client(key)

client.check_connect()

• 发邮件

例如 收件人: [e-mail]
邮件标题: email subject
邮件正文: this is a email content

    result: Result := client.send_email("[e-mail]", "email subject", "this is a email content")

    if result.is_success:
        print("send email success")
    else:
        print(f"send email fail, error: {result.msg}")

• 批量发送邮件

例如 收件人: [e-mail],[e-mail]
邮件标题: email subject
邮件正文: this is a email content

    result: Result := client.batch_send_email("[e-mail]", "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 为中文

• english (en)
• simple chinese (zh)
• vietnamese (vi)
• idonesian (id)
• thai (th)
• gujarati (gu)

如果你需要添加了更多语言，欢迎提 issue

• 提示

如果想要使用 unimail sdk, 请通过邮件联系作者 [e-mail]