mailup rest clientダウンロードmailup rest clientソースコードダウンロード

mailup rest client

その他のカテゴリー

1.0.0

ダウンロード

Mailup RESTクライアント

FazlandのMailup Rest Clientは、電子メールおよびSMS GatewayProvider Mailup用の非公式のPHP RESTクライアントです。

要件

php> = 7.0
php-http/client-implementation> = 1.0
php-http/discovery> = 1.0
php-http/message> = 1.0
php-http/message-factory> = 1.0
psr/http-message> = 1.0
PSR/HTTP-Message-Implementation> = 1.0
Symfony/Options-Resolver> = 2.7

インストール

推奨されるインストール方法は、作曲家経由です。

$ composer require fazland/mailup-rest-client

MailUp RESTクライアントを使用します

それは本当に簡単です。まず、構成！

構成

必須の構成パラメーターは次のとおりです。

username
password
client_id
client_secret

唯一のオプションのパラメーターはcache_dirです。設定すると、アクセストークンがそのパスに保存されます。

コンストラクターにパラメーターを配列として渡すContextオブジェクトを作成するだけです。

 use Fazland  MailUpRestClient  Context ;

$ config = [
    ' username ' => ' your_username ' ,
    ' password ' => ' your_password ' ,
    ' client_id ' => ' your_client_id ' ,
    ' client_secret ' => ' your_client_secret ' ,
    ' cache_dir ' => ' path_to_your_cache_dir ' , // Optional
];

$ httpClient = new HttpClientImplementation ();

$ context = new Context ( $ config , $ httpClient );

メーリングリスト

MailingListを作成するには、この例に従うことができます。 $paramsアレイについては、mailupの公式APIドキュメントを参照してください。

 use Fazland  MailUpRestClient  MailingList ;

$ email = " [email protected] " ;
$ listName = " list_name " ;
$ params = [
    // your params...
];

$ list = MailingList:: create ( $ context , $ listName , $ email , $ params );

Static Method MailingList::getAll()を呼び出すことにより、メールアカウントのすべての既存のリストを取得することもできます。

 use Fazland  MailUpRestClient  MailingList ;

$ lists = MailingList:: getAll ( $ context );

MailingListのインスタンスを取得したら、次の操作を行うことができます。

Recipientを追加します

 use Fazland  MailUpRestClient  Recipient ;

$ list -> addRecipient ( new Recipient ( ' Aragorn ' , ' [email protected] ' , ' 3333333333 ' , ' +39 ' ));

Recipientを更新します

 use Fazland  MailUpRestClient  Recipient ;

$ list -> updateRecipient ( new Recipient ( ' Aragorn ' , ' [email protected] ' , ' 3334444444 ' , ' +39 ' ));

Recipientを削除します

 use Fazland  MailUpRestClient  Recipient ;

$ list -> removeRecipient ( new Recipient ( ' Aragorn ' , ' [email protected] ' , ' 3333333333 ' , ' +39 ' ));

そのemailでRecipientを見つけます

 $ recipient = $ list -> findRecipient ( ' [email protected] ' ); // null returned if current email was not found

現在のリストのすべてのグループを取得します。

 $ groups = $ list -> getGroups ();

リストに含まれている受信者の数を数えます（デフォルトは購読されていますが、保留中のステータスも登録解除されていないことを検索できます）：

 $ countRecipients = $ list -> countRecipients (); // equal to $list->countRecipients(Recipient::STATUS_SUBSCRIBED);
// OR
$ countRecipients = $ list -> countRecipients (Recipient:: STATUS_UNSUBSCRIBED );
// OR
$ countRecipients = $ list -> countRecipients (Recipient:: STATUS_PENDING );

受信者をPaginatedに取得します（MailingList :: Countrecipients（）で使用されているのと同じステータスを指定できます）：

 $ recipients = $ list -> getRecipientsPaginated ( $ pageNumber , $ pageSize );

少なくとも、最後ではありませんが、 Recipientオブジェクトの配列をインポートします。

 $ list -> import ( $ recipients );

グループ

各MailingListは、複数のグループに分割できます。利用可能な操作は次のとおりです。

その名前を取得または変更します。

 $ group -> getName ();
$ group -> setName ( ' Gondor Army ' );

メモを取得または変更します。

 $ group -> getNotes ();
$ group -> setNotes ( ' 10.000 knights and 20.000 peons ' );

削除を防止または許可します：

 $ group -> isDeletable ();
$ group -> setDeletable ( true );

消去：

 $ group -> delete ();

受信者を追加、削除、または取得します。

 use Fazland  MailUpRestClient  Recipient ;

$ legolas = new Recipient ( ' Legolas Thranduilion ' , ' [email protected] ' , ' 3334444444 ' , ' +39 ' );
$ group -> addRecipient ( $ legolas );
$ group -> removeRecipient ( $ legolas );
$ lothlorienCitizens = $ group -> getRecipients ();