Laravel 5.xのMailupクライアントクラス
このクラスは、Laravel 5.Xフレームワークを使用して、MailUpプラットフォームの郵送機能を使用するのに役立ちます。
インストール
Composer.jsonにComposer Insertに挿入して、次のコードブロックを使用してください。
"repositories": [
{
"url": "https://github.com/caereservices/mailup.git",
"type": "git"
}
], ...
"require": {
"caereservices/mailup": "dev-master", ...
次に、 Composer Updateを実行します
始めましょう
次の例は、コードでこのクラスを使用するための基本的な手順を示しています。
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>]);
パラメーター：
- ユーザー：Mailupプラットフォームのユーザー名（通常はMXXXXX ）
- パスワード：MailUpプラットフォームのパスワード
- ListName ：（オプション）使用する受信者のリストの名前、指定されていない場合、Mailupのデフォルトリストが使用されています
返品値：
- MailUpStatus :: OK-正しくログインしました
- MailUpStatus :: err_not_logged_in-ユーザー名またはパスワードは間違っています
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターar nivalidまたはempt
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_list_not_found -listNameが指定されているが、mailupプラットフォームには存在しない場合
createList
$result = $mailUp->createList(<LISTNAME>, <LISTDATA>);
パラメーター：
- リスト名：使用する受信者のリストの名前
- ListData ：リストデータのフィールド付き配列
ListDataフィールド
- 名前- リストの名前
- main_mail-リストにリンクされたメインのメールアドレス
- REPLY_TO-ユーザーからの返信のメールアドレス
- sender_name-メールを受信したときにユーザーに表示される送信者名
- company_name-あなたの会社名
- contact_name-会社の連絡先名（不必要なマッチmain_mailまたはresply_to owner）
- 住所- あなたの会社アドレス
- 都市- あなたの会社の都市
- country_code-あなたの国コード（例：それ）
- perm_remind-許可リマインダー（デフォルト ""）情報についてはこちらをご覧ください
- web_site-あなたのウェブサイトURL
すべてのフィールドは必須です
返品値：
- MailUpStatus :: ok-正しく作成されたリスト
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターar nivalidまたはempt
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_list_not_created-リスト名はmailupプラットフォームに存在し、作成できません
- MailUpStatus :: err_no_list_data -listDataアレイは空またはnullです
- MailUpstatus :: err_invalid_list_data -listDataアレイには、1つまたは多くのフィールドが空またはnullがあります
チェンジリスト
$result = $mailUp->changeList(<LISTNAME> [, <LISTDATA>]);
listNameが存在しない場合、 listDataアレイは指定されていますメソッドを作成してみてください
パラメーター：
- リスト名：使用する受信者のリストの名前
- ListData ：（オプション）リストデータのフィールドを使用した配列（配列構造については、 createListを参照）
返品値：
- MailUpStatus :: ok-リストが正しく変更されました
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターar nivalidまたはempt
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_list_not_created-リスト名はmailupプラットフォームに存在し、作成できません
- mailupstatus :: err_list_not_changed-リスト名は無効であり、現在のリストは変更されていません
追加グループ
$result = $mailUp->addGroup(<GROUPNAME>);
パラメーター：
返品値：
- （number> 0） -グループが作成し、IDが返されます。グループが存在する場合、メソッドはIDを返します。
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターが無効または空です
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_creating_groups-グループ名はmailupプラットフォームに存在し、作成できません
addusertogroup
$result = $mailUp->addUserToGroup(<USERDATA>, <GROUPNAME>);
パラメーター：
- userData ：グループに追加するユーザーデータを備えた配列
- GroupName ：グループの名前（グループIDにもなることができます）
userDataフィールド
- メール- ユーザーメール（必須）
- 名前- ユーザーfirstName
- surname -user lastname
- モバイル- 国際プレフィックスのないユーザー携帯電話（例：39xxxxxxx）
- 会社- ユーザーカンパニー名（利用可能な場合）
返品値：
- mailupstatus :: ok-作成されたユーザーが作成またはユーザーがプラットフォームに存在する
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターが無効または空です
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_getting_fieldsこのエラーは、mailupの動的フィールドに問題がある場合に返されます（詳細についてはこちらを参照）
- mailupstatus :: err_invalid_userdata-ユーザーダタには無効なデータまたは誤ったフィールドが含まれています
- mailupstatus :: err_adding_user-ユーザーを作成できません（追加）
sendmessage
$result = $mailUp->sendMessage(<SUBJECT>, <MESSAGE>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);
パラメーター：
- 件名- メッセージの件名
- メッセージ- メッセージのテキスト（プレーンテキストまたはHTMLにすることができます）
- グループ名- メッセージを送信するグループの名前
- usermails-メッセージを送信するためのユーザーのメールは、単一のメールアドレスまたはメールアドレスの配列にすることができます
- 添付ファイル- ファイル/イメージ/その他へのパスメッセージに添付する（存在する場合は、サーバーにとどまる場合、またはURLにとどまる場合、ファイルへの絶対パスが必要です）。クラスが添付ファイルが見つからない場合
GroupNameおよび/またはUsermailsが指定されていない場合（ ""またはnullが渡されます）、現在のリストに存在するすべての受信者（ユーザー）にメッセージが送信されます。
返品値：
- mailupstatus :: message_sended-メッセージは正しくキューに登録され、できるだけ早く送信されます
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- mailupstatus :: err_invalid_parameter- 1つまたは多くのパラメーターar nivalidまたはempt
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- mailupstatus :: err_message_not_sended-メッセージは送信できません
- mailupstatus :: err_cant_create_message-システムは、送信する前にメッセージを作成（準備）できません
- MailUpStatus :: err_message_text_empty-メッセージパラメーターは空またはnullです
getTemplateList
$result = $mailUp->getTemplateList();
この方法とメソッドを使用する前に、ほぼ1つのメールテンプレートを作成する必要があります。
返品値：
- TemplateListStructure-メールアッププラットフォームに存在するテンプレートリスト
- MailUpStatus :: ERR_NO_TEMPLATES -MailUpプラットフォームにはテンプレートがありません
- MailUpStatus :: err_not_logged_in-メソッドはログインせずに呼び出されます
- MailUpStatus :: err_mailup_exception-メールプラットフォームの例外
- MailUpstatus :: err_unknow_list-現在のリストに問題があります
sendfromtemplate
$result = $mailUp->sendFromTemplate(<TEMPLATEID>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);
主題とメッセージは明らかに不要です:)
ほとんどのパラメーターと戻り値のsendmessageを参照してください。
パラメーター：
- TemplateID -GetTemPlateListの選択されたアイテムから取得したテンプレートのID返品リスト
返品値：
- MailUpStatus :: err_no_templates-テンプレートIDが正しくないか無効です
参照
APIのすべての参照と仕様については、MailUpプラットフォームの呼び出しを参照してください。
ここからの例コードに基づいています
著者
Massimo Villalta- （c）2017 -Caereservices.it
