AsyncMsgCenter

class deepfos.lib.msg.AsyncMsgCenter

消息中心

async publish(template_code, receiver_users=None, receiver_groups=None, sender=None, title_param=None, content_param=None, attachments=None)

推送指定消息模版的消息

参数

• template_code (str) – 模板编码

• sender (Optional[str]) – 可选，发送人userid，默认为当前用户id

• receiver_users (Optional[List[str]]) – 可选，收件人userid列表

• receiver_groups (Optional[List[str]]) – 可选，收件人groupid列表

• title_param (Optional[Dict[str, str]]) – 可选，标题变量

• content_param (Optional[Dict[str, str]]) – 可选，内容变量

• attachments (Optional[Dict[str, Union[str, bytes]]]) – 可选，站内消息或邮箱的消息附件，以 文件名: 文件(字符串/bytes) 的字典形式提供

示例

from deepfos.lib.msg import MsgCenter
msg = MsgCenter()

1. 推送带附件的站内消息

   # demo_station标题如下:
   # 标题【{var1}】
   # 内容如下:
   # 内容【{var1}】
   #
   # 发送至1个用户和1个用户组, 并附上2个文件附件
   
   msg.publish(
       'demo_station',
       receiver_users=['00000000-0000-0000-0000-000000000000'],
       receiver_groups=['00000000-0000-0000-0000-000000000001'],
       title_param={'var1': 'a'},
       content_param={'var1': 'b'},
       attachments={
           'file1.txt': 'Some text...',
           'file2.txt': 'More text...',
       }
   )
   

参见

send_mail send_sms

返回类型

List

async send_mail(template_code, receivers, sender=None, title_param=None, content_param=None, attachments=None, cc_email=None)

发送指定消息模版的邮件

参数

• template_code (str) – 模板编码

• receivers (List[str]) – 收件人邮箱列表

• sender (Optional[str]) – 可选，发送人userid，默认为当前用户id

• title_param (Optional[Dict[str, str]]) – 可选，标题变量

• content_param (Optional[Dict[str, str]]) – 可选，内容变量

• attachments (Optional[Dict[str, Union[str, bytes]]]) – 可选，附件，以 文件名: 文件(字符串/bytes) 的字典形式提供

• cc_email (Optional[List[str]]) – 可选，抄送人列表

示例

from deepfos.lib.msg import MsgCenter
msg = MsgCenter()

1. 发送邮件

   # demo_mail标题如下:
   # 邮件标题【{var2}】
   # 内容如下:
   # 邮件内容【{var2}】
   #
   # 发送至一个邮箱并抄送另一个邮箱, 并附上2个文件附件
   
   msg.send_mail(
       'demo_mail',
       receivers=['xxx@a.com'],
       cc_email=['yyy@b.com'],
       title_param={'var2': '42'},
       content_param={'var2': '24'},
       attachments={
           'file1.txt': 'Some text...',
           'file2.txt': 'More text...',
       }
   )
   

参见

publish send_sms

返回类型

List

async send_sms(template_code, receivers, sender=None, title_param=None, content_param=None)

发送指定消息模版的短信

参数

• template_code (str) – 模板编码

• receivers (List[str]) – 收件人手机号列表

• sender (Optional[str]) – 可选，发送人userid，默认为当前用户id

• title_param (Optional[Dict[str, str]]) – 可选，标题变量

• content_param (Optional[Dict[str, str]]) – 可选，内容变量

示例

from deepfos.lib.msg import MsgCenter
msg = MsgCenter()

1. 发送短信

   # demo_sms标题如下:
   # 短信标题【{var3}】
   # 内容如下:
   # 短信内容【{var3}】
   #
   # 发送至2个手机号
   
   msg.send_mail(
       'demo_sms',
       receivers=['15000000000', '13000000000'],
       title_param={'var3': 'Hello'},
       content_param={'var3': 'World'}
   )
   

参见

publish send_mail

返回类型

List

templates

当前有效的空间消息模板