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
