Laravel 5.x的Mailup客户班
该课程可帮助您使用Laravel 5.X框架使用Mailup平台的邮件功能。
安装
将作曲家插入到Composer.json以下代码块：
"repositories": [
{
"url": "https://github.com/caereservices/mailup.git",
"type": "git"
}
], ...
"require": {
"caereservices/mailup": "dev-master", ...
然后运行作曲家更新
开始
下面的示例显示了在代码中使用此类的基本步骤。
use CaereservicesMailupMailupStatus;
use CaereservicesMailupMailupException;
use CaereservicesMailupMailupClient;
$CLIENT_ID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
$CLIENT_SECRET = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
$CALLBACK_URI = "http://localhost/callback_uri";
$USER = "mXXXXXX";
$PASSWORD = "xxxxxxxxx";
$mailUp = null;
try {
$mailUp = new MailupClient($CLIENT_ID, $CLIENT_SECRET, $CALLBACK_URI);
if( $mailUp ) {
$result = $mailUp->login($USER, $PASSWORD);
if( $result == MailupStatus::OK ) {
...
}
}
} catch (MailupException $e) {
...
}
$ client_id和$ client_secret可以遵循这些指南
可用方法
登录
$result = $mailUp->login(<USER>, <PASSWORD> [, <LISTNAME>]);
参数：
- 用户：邮件平台的用户名（通常是mxxxxx ）
- 密码：邮件平台的密码
- listName ：（可选）使用的收件人列表使用的名称，如果未指定的默认邮件列表，则使用
返回值：
- mailupstatus :: OK-正确登录
- mailupstatus :: err_not_logged_in-用户名或密码不正确
- mailupstatus :: err_invalid_parameter-一个或多个参数ar无效或空
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_list_not_found-如果指定了listName ，但在mailup平台中不存在
造物主义者
$result = $mailUp->createList(<LISTNAME>, <LISTDATA>);
范围：
- listName ：要使用的收件人列表的名称
- ListData ：带有填充列表数据字段的数组
ListData字段
- 名称- 列表的名称
- main_mail-链接到列表的主电子邮件地址
- 回复_TO-用户回复的邮件地址
- sender_name-接收邮件时出现给用户的发件人名称
- Company_name-您的公司名称
- Contact_name-公司中的联系人名称（不必要的匹配main_mail或回复_到所有者）
- 地址- 您的公司地址
- 城市- 您的公司城市
- country_code-您的国家代码（例如）
- perm_remind-权限提醒（默认“”）请参阅此处的信息
- Web_Site-您的网站URL
所有领域都是强制性的
返回值：
- MailUpstatus :: OK-列表正确创建了
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_invalid_parameter-一个或多个参数ar无效或空
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_list_not_created- listName不存在于mailup平台中，无法创建
- mailupstatus :: err_no_list_data- listData阵列为空或null
- mailupstatus :: err_invalid_list_data- listData阵列有一个或多个字段为空或null
变革主义者
$result = $mailUp->changeList(<LISTNAME> [, <LISTDATA>]);
如果listName不存在，指定的方法和listData数组尝试创建它
范围：
- listName ：要使用的收件人列表的名称
- listData ：（可选）带有填充列表数据字段的数组
返回值：
- mailupstatus :: OK-列表正确更改了
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_invalid_parameter-一个或多个参数ar无效或空
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_list_not_created- listName不存在于mailup平台中，无法创建
- mailupstatus :: err_list_not_changed-列表名称无效，当前列表保持不变
addGroup
$result = $mailUp->addGroup(<GROUPNAME>);
范围：
返回值：
- （数字> 0） - 创建的组并将其ID返回，如果组存在，则方法返回其ID。
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_invalid_parameter-一个或多个参数是无效的或空的
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_creating_groups- groupName不存在于mailup平台中，无法创建
addusertroup
$result = $mailUp->addUserToGroup(<USERDATA>, <GROUPNAME>);
参数：
- USERDATA ：与要添加到组的用户数据的数组
- groupName ：组的名称（也可以是组ID）
USERDATA字段
- 邮件- 用户电子邮件（强制性）
- 名称- 用户名称
- 姓氏- 用户姓氏
- 手机- 没有国际前缀的用户手机号码（例如 +39xxxxxxx）
- 公司- 用户公司名称（如果有）
返回值：
- mailupstatus :: ok-创建或创建的用户存在于平台中
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_invalid_parameter-一个或多个参数是无效的或空的
- mailupstatus :: err_mailup_exception- mailup平台异常
- MailUpStatus :: Err_getting_fields当我们有动态邮件字段的问题时，返回此错误（有关详细信息，请参见此处）
- mailupstatus :: err_invalid_userdata -userData包含无效的数据或错误字段
- mailupstatus :: err_adding_user-无法创建用户（添加）
sendmessage
$result = $mailUp->sendMessage(<SUBJECT>, <MESSAGE>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);
参数：
- 主题- 消息的主题
- 消息- 消息的文字（可以是纯文本或HTML）
- GroupName-发送消息的组名称
- Usermails-用户发送消息的邮件可以是一个邮件地址或邮件地址的数组
- 附件- 通往消息上附件的文件/映像/其他路径（如果存在，则必须是绝对的文件路径，如果该类别保留在服务器上或URL），则如果类别未找到附件，则不会将附件附加到消息上
如果未指定groupName和/或usermails （“”或null），则将消息发送给当前列表中存在的所有收件人（用户）。
返回值：
- mailupstatus :: message_sended-消息已正确排队并尽快发送
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_invalid_parameter-一个或多个参数ar无效或空
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_message_not_sended-无法发送该消息
- mailupstatus :: err_cant_create_message-系统在发送消息之前无法创建（准备）该消息
- mailupstatus :: err_message_text_empty-消息参数为空或null
getTemplateList
$result = $mailUp->getTemplateList();
在使用此方法和链接的方法之前，必须创建几乎一个邮件模板属于Mailup平台，您可以在此处找到所有信息和指南
返回值：
- Templateliststructure-邮件平台上存在的模板列表
- mailupstatus :: err_no_templates-邮件平台中没有模板
- mailupstatus :: err_not_logged_in-该方法无需登录即可调用
- mailupstatus :: err_mailup_exception- mailup平台异常
- mailupstatus :: err_unknow_list-当前列表有问题
sendfromtemplate
$result = $mailUp->sendFromTemplate(<TEMPLATEID>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);
主题和消息显然是不必要的:)
有关大多数参数和返回值，请参阅sendmessage ，除了以下
范围：
- TemplateID-模板的ID从getTemplatelist返回列表的选定项目中获得
返回值：
- mailupstatus :: err_no_templates-模板ID不正确或无效
参考
有关API Call for Mailup平台的所有参考和规范，请参阅此处
基于此处的示例代码
作者
Massimo Villalta- （C）2017 -Caereservices.it
