mailup rest client下載 - mailup rest client端源代碼下載

mailup rest client

其他類別

1.0.0

下載

MailUp REST客戶端

Fazland的Mailup REST客戶端是電子郵件和SMS GatewayProvider Mailup的非官方PHP REST客戶端。

要求

php> = 7.0
php-http/client-implementation> = 1.0
PHP-HTTP/Discovery> = 1.0
PHP-HTTP/消息> = 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您可以按照此示例。請，請參閱Mailup官方API文檔中的$params陣列。

 use Fazland  MailUpRestClient  MailingList ;

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

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

您還可以通過調用靜態方法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 ();

計算列表中有多少收件人（默認已訂閱，但您也可以搜索未訂閱的o待定狀態）：

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

獲取收件人分頁（您可以指定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 ();