智简魔方文档

邮件接口

本文整理智简魔方财务系统中“邮件接口”相关的配置、操作或问题处理内容,供管理员和运维人员按原文步骤查阅与执行。

邮件插件开发规范

【魔方开发者交流群:682866869】


1、文件命名

在以下目录中新建邮件插件目录:

public/plugins/mail/

例如开发 smtp 邮件插件时,目录和文件为:

public/plugins/mail/smtp/
public/plugins/mail/smtp/SmtpPlugin.php
public/plugins/mail/smtp/config.php

2、文件规范(以 smtp 邮件插件为例)

namespace mail\smtp;

use app\admin\lib\Plugin;

class SmtpPlugin extends Plugin

类中规定的接口函数名不能修改或缺失,其他功能可以自行增加函数。

3、类中参数和基本函数

基础信息不能为空:

public $info = array(
    'name' => 'Smtp', // 插件类名不带 Plugin
    'title' => 'Smtp',
    'description' => '智简魔方官方邮件平台接口',
    'status' => 1,
    'author' => '魔方财务',
    'version' => '1.0',
    'help_url' => 'https://www.idcsmat.com/', // 申请接口地址
);

install 为安装插件函数,没有安装逻辑时返回:

return true;

uninstall 为卸载插件函数,没有卸载逻辑时返回:

return true;

4、邮件发送接口

系统传入的插件配置:

$params['config'] // config.php 中的配置项在安装插件后设置得到的数组

邮件发送函数及参数:

Send($params)
$params['email']       // 收件地址
$params['subject']     // 邮件标题
$params['content']     // 邮件内容
$params['attachments'] // 邮件附件

5、返回格式

成功:

['status' => 'success']

失败:

['status' => 'error', 'msg' => $errorMsg]