mailup

Classe client MailUp pour Laravel 5.x

Cette classe vous aide à utiliser la fonctionnalité de diffusion de la plate-forme MailUp avec votre framework Laravel 5.x.

Installation

Utilisation de l'insert de compositeur dans Composer.json Le bloc de code suivant:

 "repositories": [
        {
            "url": "https://github.com/caereservices/mailup.git",
            "type": "git"
        }
    ], ...

"require": {
	 "caereservices/mailup": "dev-master", ...

puis exécutez la mise à jour du compositeur

Commencer

Exemple suivant Affichez les étapes de base d'utilisation de cette classe dans votre code.

 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 et $ client_secret peuvent être obtenus Suivez ces guides

Méthodes disponibles

se connecter

   $result = $mailUp->login(<USER>, <PASSWORD> [, <LISTNAME>]);

Paramètres:

• Utilisateur : Nom d'utilisateur pour la plate-forme MailUp (généralement MXXXXX )
• Mot de passe : mot de passe pour la plateforme MailUp
• ListName : (facultatif) Le nom de la liste des destinataires à utiliser, sinon spécifié, la liste de MailUp est utilisée

Valeurs de retour:

• MailUpStatus :: OK - connecté correctement
• MailUpStatus :: err_not_logged_in - le nom d'utilisateur ou le mot de passe sont incorrectement
• MailUpStatus :: err_invalid_parameter - un ou plusieurs paramètres AR invalide ou vide
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_list_not_found - Si Listname est spécifié mais n'existe pas dans la plate-forme MailUp

crééliste

   $result = $mailUp->createList(<LISTNAME>, <LISTDATA>);

Paramètre:

• Nom de List : le nom de la liste des destinataires à utiliser
• ListData : tableau avec champs pour les données de liste de remplissage

Champs listData

• Nom - Nom de la liste
• Main_mail - Adresse e-mail principale liée à la liste
• Répondre_to - Adresse mail pour la réponse de l'utilisateur
• Sender_name - Nom de l'expéditeur qui apparaît à l'utilisateur lors de la réception du courrier
• Company_name - le nom de votre entreprise
• CONTACT_NAME - Nom de contact dans l'entreprise (Match inutile Main_mail ou Répondre_to Propriétaire)
• Adresse - Adresse de votre entreprise
• Ville - votre ville d'entreprise
• Country_code - Votre code de pays (Ex. It)
• perm_remind - Rappel d'autorisation (par défaut "") Voir ici pour plus d'informations
• Web_site - URL de votre site Web

Tous les champs sont obligatoires

Valeurs de retour:

• MailUpStatus :: OK - Liste créée correctement
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailUpStatus :: err_invalid_parameter - un ou plusieurs paramètres AR invalide ou vide
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_list_not_created - le nom de liste n'existe pas dans la plate-forme MailUp et ne peut pas être créé
• MailUpStatus :: err_no_list_data - Le tableau ListData est vide ou nul
• MailUpStatus :: err_invalid_list_data - Le tableau ListData a un ou plusieurs champs vides ou nuls

liste de change

   $result = $mailUp->changeList(<LISTNAME> [, <LISTDATA>]);

Si listName n'existe pas le tableau et listData est spécifié la méthode, essayez de la créer

Paramètre:

• Nom de List : le nom de la liste des destinataires à utiliser
• ListData : (facultatif) Array avec champs pour les données de liste de remplissage (voir crééliste pour la structure du tableau)

Valeurs de retour:

• MailUpStatus :: OK - Liste a correctement changé
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailUpStatus :: err_invalid_parameter - un ou plusieurs paramètres AR invalide ou vide
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_list_not_created - le nom de liste n'existe pas dans la plate-forme MailUp et ne peut pas être créé
• MailUpStatus :: err_list_not_changed - le nom de liste n'est pas valide et la liste actuelle reste inchangée

addgroup

   $result = $mailUp->addGroup(<GROUPNAME>);

Paramètre:

• GroupName : le nom du groupe à créer

Valeurs de retour:

• (numéro> 0) - Groupe créé et son ID est renvoyé, si le groupe existe, la méthode renvoie son ID.
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailUpStatus :: err_invalid_parameter - Un ou plusieurs paramètres sont invalides ou vides
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_creating_groups - le nom de groupe n'existe pas dans la plate-forme MailUp et ne peut pas être créé

adsusertogroup

   $result = $mailUp->addUserToGroup(<USERDATA>, <GROUPNAME>);

Paramètres:

• UserData : tableau avec des données utilisateur à ajouter au groupe
• GroupName : le nom du groupe (peut être un identifiant de groupe également)

Champs userdata

• Mail - e-mail utilisateur ( obligatoire )
• Nom - FirstName de l'utilisateur
• Nom de famille - Nom de l'utilisateur
• Mobile - Numéro de mobile utilisateur sans préfixe international (Ex. + 39xxxxxxx)
• Entreprise - Nom de l'entreprise d'utilisateurs (si disponible)

Valeurs de retour:

• MailUpStatus :: OK - L'utilisateur créé ou que l'utilisateur existe dans la plate-forme
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailUpStatus :: err_invalid_parameter - Un ou plusieurs paramètres sont invalides ou vides
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailupStatus :: err_getting_fields Cette erreur est renvoyée lorsque nous avons un problème avec les champs dynamiques de MailUp (voir ici pour plus de détails)
• MailUpStatus :: err_invalid_userdata - L' UserData contient des données non valides ou un champ incorrect
• MailUpStatus :: err_adding_user - l'utilisateur ne peut pas être créé (ajouté)

SendMessage

   $result = $mailUp->sendMessage(<SUBJECT>, <MESSAGE>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);

Paramètres:

• Sujet - sujet de message
• Message - Texte du message (peut être un texte brut ou HTML)
• GroupName - le nom du groupe pour envoyer un message
• USERMAILS - Le courrier de l'utilisateur pour envoyer un message peut être une seule adresse messagerie ou une table d'adresse Mail
• Pièce jointe - Chemin vers le fichier / image / autre pour attacher au message (doit être, si présent, chemin absolu vers le fichier, s'il reste sur le serveur, ou URL), si la classe n'a pas trouvé la pièce jointe aucune donnée n'est jointe au message

Si l'un ou l'autre de GroupName et / ou Usermails n'est pas spécifié ("" ou NULL est passé), le message est envoyé à tous les destinataires (utilisateurs) présents dans la liste actuelle.

Valeurs de retour:

• MailUpStatus :: Message_Seded - Le message est correctement en file d'attente et est envoyé dès que possible
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailUpStatus :: err_invalid_parameter - un ou plusieurs paramètres AR invalide ou vide
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_message_not_seend - Le message ne peut pas être envoyé
• MailUpStatus :: err_cant_create_message - le système ne peut pas créer (préparer) le message avant de l'envoyer
• MailUpStatus :: err_message_text_empty - le paramètre du message est vide ou nul

getTemplatelist

   $result = $mailUp->getTemplateList();

Presque un modèle de messagerie doit être créé appartenant à la plate-forme MailUp avant d'utiliser cette méthode et les méthodes liées, vous pouvez trouver toutes les informations et guider sur les modèles ici

Valeurs de retour:

• TemplatelistStructure - Liste des modèles présente sur la plate-forme MailUp
• MailUpStatus :: err_no_templates - Il n'y a pas de modèle dans la plate-forme MailUp
• MailUpStatus :: err_not_logged_in - la méthode est appelée sans se connecter
• MailupStatus :: err_mailup_exception - Exception de la plate-forme MailUp
• MailUpStatus :: err_unknow_list - la liste actuelle a un problème

sendromTemplate

   $result = $mailUp->sendFromTemplate(<TEMPLATEID>, <GROUPNAME>, <USERMAILS>, <ATTACHMENT>);

Le sujet et le message sont évidemment inutiles :)

Reportez-vous à SendMessage pour la plupart des valeurs de paramètre et de retour, sauf suit

Paramètre:

• TemplateId - ID de modèle obtenu à partir de l'élément sélectionné de la liste renvoyée de GetTemplalist

Valeurs de retour:

• MailUpStatus :: err_no_templates - L'ID de modèle est incorrect ou non valide

Référence

Pour toutes les références et les spécifications sur l'appel API pour la plateforme MailUp, référez-vous ici

Basé sur l'exemple de code d'ici

Auteur

Massimo Villalta - (c) 2017 - CaeReServices.it