mailup rest client

Mailup Rest Client

Der Mailup Rest Client von Fazland ist ein inoffizieller PHP -REST -Client für die E -Mail- und SMS -GatewayProvider -Mailup.

Anforderungen

• php> = 7.0
• PHP-HTTP/Client-Implementierung> = 1.0
• PHP-HTTP/Discovery> = 1.0
• PHP-HTTP/Nachricht> = 1.0
• PHP-HTTP/Message-Factory> = 1.0
• psr/http-message> = 1.0
• psr/http-message-Implementierung> = 1.0
• Symfony/Options-Resolver> = 2,7

Installation

Die vorgeschlagene Installationsmethode erfolgt über Komponist:

$ composer require fazland/mailup-rest-client

Verwenden von Mailup -REST -Client

Es ist wirklich einfach. Erstens Konfiguration!

Konfiguration

Die obligatorischen Konfigurationsparameter sind:

• username
• password
• client_id
• client_secret

Der einzige optionale Parameter ist cache_dir . Wenn festgelegt, werden das Zugriffstoken auf diesem Weg gespeichert.

Erstellen Sie einfach ein Context , das die Parameter als Array an den Konstruktor übergibt:

 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 );

Mailinglisten

Um eine MailingList zu erstellen, können Sie diesem Beispiel folgen. Bitte beachten Sie die offiziellen API -Dokumente von Mailups für das $params -Array.

 use Fazland  MailUpRestClient  MailingList ;

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

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

Sie können auch alle vorhandenen Listen in Ihrem Mailup -Konto erhalten, indem Sie die statische Methode MailingList::getAll() aufrufen:

 use Fazland  MailUpRestClient  MailingList ;

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

Sobald Sie eine Instanz von MailingList haben, können Sie folgende Vorgänge ausführen:

• Fügen Sie einen Recipient hinzu

 use Fazland  MailUpRestClient  Recipient ;

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

• Aktualisieren Sie einen Recipient

 use Fazland  MailUpRestClient  Recipient ;

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

• einen Recipient entfernen

 use Fazland  MailUpRestClient  Recipient ;

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

• Finden Sie einen Recipient per email

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

• Abrufen Sie alle Gruppen der aktuellen Liste ab:

 $ groups = $ list -> getGroups ();

• Zählen Sie, wie viele Empfänger in der Liste sind (Standard ist abonniert. Sie können jedoch auch nach nicht beschriebenen o anstehenden Status suchen):

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

• Empfänger paginieren (Sie können denselben Status angeben, der in MailingList :: corporcopients () verwendet wird):

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

• Immobilien, aber nicht zuletzt, importieren Sie eine Reihe von Recipient :

 $ list -> import ( $ recipients );

Gruppen

Jede MailingList kann in mehrere Gruppen aufgeteilt werden. Die verfügbaren Operationen sind die folgenden:

• Rufen oder ändern Sie seinen Namen:

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

• Abrufen oder ändern Sie seine Notizen:

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

• Löschen verhindern oder erlauben:

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

• löschen:

 $ group -> delete ();

• Die Empfänger hinzufügen, entfernen oder abrufen:

 use Fazland  MailUpRestClient  Recipient ;

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

Beitragen

Beiträge sind willkommen. Fühlen Sie sich frei, eine PR zu öffnen oder hier auf Github ein Problem zu stellen!

Lizenz

Der Mailup -REST -Kunde ist unter der MIT -Lizenz lizenziert - finden Sie in der Lizenzdatei Details