智简魔方文档

邮件接口开发

位置

邮件接口放在 public/plugins/mail/ 目录下

目录结构

以智简魔方官方邮件平台接口为例,其主要目录结构如下:

public/plugins/mail/idcsmartmail/
|--- Idcsmartmail.php (入口文件)
|--- config.php (配置项客户配置项,在插件设置中显示)

开发流程

以智简魔方官方邮件平台接口为例:

创建邮件接口目录 public/plugins/mail/idcsmartmail/

①目录名以小写字母+下划线形式,必须以字母开头,如idcsmartmail;

创建入口文件:Idcsmartmail.php

命名空间namespace mail\idcsmartmail(控制器下命名空间对应相应目录即可,其它同理);

②以目录名大驼峰 + .php,创建在邮件接口根目录下,如 idcsmartmail/Idcsmartmail.php

③文件中需要定义info属性,示例:

# 基础信息
public $info = array(
    'name'        => 'Idcsmartmail',//Demo插件英文名,改成你的插件英文就行了
    'title'       => '智简魔方',
    'description' => '智简魔方官方邮件平台接口',
    'status'      => 1,
    'author'      => '智简魔方',
    'version'     => '1.0.0',
    'help_url'     => 'https://my.idcsmart.com/goods.htm?id=337',//申请接口地址
);

④必须实现install()安装以及uninstall()卸载方法,没有额外操作,返回true即可;

⑤需要实现以下方法

方法名称描述参数返回
send发送邮件email:邮件地址;subject:邮件主题;content:邮件内容;config:自定义配置;attachments:邮件附件,使用逗号分隔,附件保存在 public/upload/common/email/status:状态,success 成功,error 失败;msg:消息

参数示例:

$param = [
    'email' => '1240@qq.com',
    'subject' => '测试主题',
    'content' => '测试内容',
    'attachents' => 'test.png,test1.jpg',
    'config' => [],
];

成功返回示例:

return ['status' => 'success'];

失败返回示例:

return [
    'status' => 'error',
    'msg' => '邮件配置错误',
];

到后台邮件通知管理,可以查看接口列表,安装、配置即可使用

示例

参考智简魔方官方邮件平台接口idcsmartmail

附表1、templateParam参数列表

参数名描述类型示例
system_website_name系统网站名系统智简魔方
system_website_url系统网站地址系统www.idcsmart.com
order_id订单ID订单125
order_create_time订单创建时间订单1707094285
order_amount订单金额订单1.00
product_name产品名称(包括商品名和主机名)产品测试-ser23142123
product_marker_name商品名称产品测试
product_first_payment_amount产品首付金额产品100.00
product_renew_amount产品续费金额产品100.00
product_binlly_cycle产品周期产品计费周期免费free,一次onetime,周期先付recurring_prepayment,周期后付recurring_postpaid
product_active_time产品激活时间产品1707094285
product_due_time产品到期时间产品1707094285
product_suspend_reason产品暂停原因产品到期暂停
renewal_first续费X天后到期第一次提醒产品1
renewal_second续费X天后到期第二次提醒产品2
client_register_time客户注册时间客户1707094285
client_username用户名客户test
client_email邮件客户135460@qq.com
client_phone手机号客户16548765643
client_company公司客户智简魔方
client_last_login_time最后登录时间客户1707094285
client_last_login_ip最后登录ip客户122.32.13.3
account账户名客户test