mailup rest client

Cliente REST de Mailup

El cliente de REST de Mailup de Fazland es un cliente PHP REST no oficial para el correo electrónico y SMS GatewayProvider Mailup.

Requisitos

• php> = 7.0
• php-http/cliente-implementación> = 1.0
• php-http/descubry> = 1.0
• php-http/mensaje> = 1.0
• php-http/mensaje-factory> = 1.0
• PSR/http-Message> = 1.0
• PSR/HTTP-Message-Implementation> = 1.0
• Symfony/Options-Resolver> = 2.7

Instalación

El método de instalación sugerido es a través del compositor:

$ composer require fazland/mailup-rest-client

Uso del cliente REST de Mailup

Es realmente simple. En primer lugar, configuración!

Configuración

Los parámetros de configuración obligatorios son:

• username
• password
• client_id
• client_secret

El único parámetro opcional es cache_dir . Si se establece, el token de acceso se guarda en ese camino.

Simplemente cree un objeto Context que pasa al constructor los parámetros como una matriz:

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

Listas de correo

Para crear una MailingList puede seguir este ejemplo. Por favor, consulte los documentos de API oficiales de Mailup para la matriz $params .

 use Fazland  MailUpRestClient  MailingList ;

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

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

También puede obtener todas las listas existentes en su cuenta de correo llamando al método estático MailingList::getAll() ::

 use Fazland  MailUpRestClient  MailingList ;

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

Una vez que tenga una instancia de MailingList , puede hacer las siguientes operaciones:

• Agregar un Recipient

 use Fazland  MailUpRestClient  Recipient ;

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

• Actualizar un Recipient

 use Fazland  MailUpRestClient  Recipient ;

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

• Eliminar un Recipient

 use Fazland  MailUpRestClient  Recipient ;

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

• Encuentre un Recipient por su email

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

• Recupere todos los grupos de la lista actual:

 $ groups = $ list -> getGroups ();

• Cuente cuántos destinatarios hay en la lista (se suscribe el valor predeterminado, pero también puede buscar los estados pendientes de suscripción 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 );

• Obtenga los destinatarios paginados (puede especificar el mismo estado utilizado en MailingList :: CounterTecipients ()):

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

• menos, pero no dura, importar una matriz de objetos Recipient :

 $ list -> import ( $ recipients );

Grupos

Cada MailingList se puede dividir en múltiples grupos. Las operaciones disponibles son las siguientes:

• recuperar o modificar su nombre:

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

• recuperar o modificar sus notas:

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

• prevenir o permitir la eliminación:

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

• borrar:

 $ group -> delete ();

• Agregue, elimine o recupere los destinatarios:

 use Fazland  MailUpRestClient  Recipient ;

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

Que contribuye

Las contribuciones son bienvenidas. ¡No dude en abrir un PR o presentar un problema aquí en GitHub!

Licencia

El cliente de REST de Mailup tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles