mailup

Mailup -Clientklasse für Laravel 5.x

Diese Klasse hilft Ihnen dabei, die Mailing -Funktionalität der Mailup -Plattform mit Ihrem Laravel 5.x -Framework zu verwenden.

Installation

Verwenden Sie den folgenden Codeblock in composer.json ein .

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

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

Dann führen Sie das Komponist -Update aus

Fangen an

Das Folgende Beispiel zeigen die grundlegenden Schritte für die Verwendung dieser Klasse in Ihrem 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 und $ client_secret können erhalten werden. Befolgen Sie diese Anleitung

Verfügbare Methoden

Login

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

Parameter:

• Benutzer : Benutzername für die Mailup -Plattform (normalerweise mxxxxx )
• Passwort : Passwort für die Mailup -Plattform
• Listname : (optional) Der Name der zu verwendenden Liste der Empfänger, wenn nicht angegeben, wird die Standardliste von Mailup verwendet

Rückgabewerte:

• MailUpStatus :: OK - korrekt angemeldet
• MailUpStatus :: err_not_logged_in - Benutzername oder Passwort sind falsch
• MailUpStatus :: err_invalid_parameter - ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_list_not_found - Wenn ListName angegeben ist, aber in der Mailup -Plattform nicht vorhanden ist

Kreatelist

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

Parameter:

• Listenname : Der Name der zu verwendenden Empfängerliste
• ListData : Array mit Feldern für Fülllistendaten

ListData Fields

• Name - Name der Liste
• Main_mail - Haupt -E -Mail -Adresse, die mit der Liste verknüpft ist
• Reply_to - Mail -Adresse für die Antwort vom Benutzer
• SENTER_NAME - Absendername, der beim Empfangen von E -Mails dem Benutzer angezeigt wird
• Company_Name - Ihr Firmenname
• contact_name - Kontaktname in der Firma (unnötiges Match main_mail oder antworten_to Eigentümer)
• Adresse - Ihre Firmenadresse
• Stadt - Ihre Firmenstadt
• Country_Code - Ihr Ländercode (z. B. It)
• perm_remind - Berechtigungserinnerung (Standard "") finden Sie hier Informationen finden Sie hier
• Web_sites - Ihre Website -URL

Alle Felder sind obligatorisch

Rückgabewerte:

• MailUpStatus :: OK - Liste richtig erstellt
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_invalid_parameter - ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_list_not_created - Der Listname existiert nicht in der Mailup -Plattform und kann nicht erstellt werden
• MailUpStatus :: err_no_list_data - Das ListData -Array ist leer oder null
• MailUpStatus :: err_invalid_list_data - Das ListData -Array hat ein oder viele Felder leer oder null

ChangeList

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

Wenn ListName nicht das und das ListData -Array vorhanden ist

Parameter:

• Listenname : Der Name der zu verwendenden Empfängerliste
• ListData : (optional) Array mit Feldern für Fülllistendaten (siehe CreateList für Array -Struktur)

Rückgabewerte:

• MailUpStatus :: OK - Die Liste wurde korrekt geändert
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_invalid_parameter - ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_list_not_created - Der Listname existiert nicht in der Mailup -Plattform und kann nicht erstellt werden
• MailUpStatus :: err_list_not_changed - Der Listenname ist ungültig und die aktuelle Liste bleibt unverändert

Addgroup

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

Parameter:

• GroupName : Der Name der zu erstellenden Gruppe

Rückgabewerte:

• (Nummer> 0) - Gruppe erstellt und die ID wird zurückgegeben, wenn die Gruppe die Methode zurückgibt, ist ID ID.
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_invalid_parameter - Ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_creating_groups - Der GroupName existiert nicht in der Mailup -Plattform und kann nicht erstellt werden

AddUSertogruppe

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

Parameter:

• UserData : Array mit Benutzerdaten, die zu Gruppen hinzugefügt werden sollen
• GroupName : Der Name der Gruppe (kann auch eine Gruppen -ID sein)

UserData Fields

• Mail - Benutzer -E -Mail ( obligatorisch )
• Name - Benutzer FirstName
• Nachname - Benutzer LastName
• Mobile - Benutzernummer ohne internationales Präfix (Ex. +39xxxxxxx)
• Firma - Benutzerfirmenname (falls verfügbar)

Rückgabewerte:

• MailUpStatus :: OK - Benutzer erstellt oder der Benutzer existieren in der Plattform
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_invalid_parameter - Ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_getting_fields Dieser Fehler wird zurückgegeben, wenn wir ein Problem mit dynamischen Feldern von Mailup haben (hier finden Sie hier Details)
• MailUpStatus :: err_invalid_userdata - Die UserData enthält ungültige Daten oder ein falsches Feld
• MailUpStatus :: err_adding_user - Der Benutzer kann nicht erstellt werden (hinzugefügt)

Nachricht senden

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

Parameter:

• Betreff - Betreff der Nachricht
• Nachricht - Meldungstext (kann nur Text oder HTML sein)
• GroupName - Der Name der Gruppe zum Senden einer Nachricht
• UserMails - Die E -Mail der Benutzer, um eine Nachricht zu senden, kann eine einzige E -Mail -Adresse oder ein Array von Mail -Adresse sein
• Anhang - Pfad zur Datei/im Bild/zum anderen, um an der Nachricht hinzugefügt zu werden (muss, wenn es vorhanden ist, absoluter Pfad zur Datei, wenn sie auf dem Server oder auf der URL bleibt), wenn die Klasse den Anhang nicht gefunden hat, werden keine Daten an die Nachricht angehängt

Wenn einer von GroupName und/oder UsMails nicht angegeben wird ("" oder NULL übergeben wird), wird die Nachricht an alle in der aktuellen Liste vorhandenen Empfänger (Benutzer) gesendet.

Rückgabewerte:

• MailUpStatus :: Message_Sended - Die Nachricht ist korrekt in der Warteschlange und wird so schnell wie möglich gesendet
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_invalid_parameter - ein oder viele Parameter sind ungültig oder leer
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_message_not_sended - Die Nachricht kann nicht gesendet werden
• MailUpStatus :: err_cant_create_message - Das System kann die Nachricht vor dem Senden nicht erstellen (vorbereiten)
• MailUpStatus :: err_message_text_empty - Der Meldungsparameter ist leer oder null

GetTemplatelist

   $result = $mailUp->getTemplateList();

Fast eine E -Mail -Vorlage muss erstellt werden

Rückgabewerte:

• Templateliststruktur - Vorlagenliste auf der Mailup -Plattform vorhanden
• MailUpStatus :: err_no_templates - In der Mailup -Plattform gibt es keine Vorlage
• MailUpStatus :: err_not_logged_in - Die Methode wird ohne Anmeldung aufgerufen
• MailUpStatus :: err_mailup_exception - Mailup -Plattformausnahme
• MailUpStatus :: err_unknow_list - Die aktuelle Liste hat ein Problem

sendfromTemplate

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

Betreff und Nachricht sind offensichtlich unnötig :)

Siehe SendMessage für die meisten Parameter- und Rückgabewerte, außer folgend

Parameter:

• TemplateID - ID von Template, die aus ausgewählten Element der GetTemPlatelist zurückgegeben wurde, Liste

Rückgabewerte:

• MailUpStatus :: err_no_templates - Die Vorlagen -ID ist falsch oder ungültig

Referenz

Für alle Referenzen und Spezifikationen auf API -Anruf für Mailup -Plattform finden Sie hier

Basierend auf Beispielcode von hier

Autor

Massimo Villalta - (c) 2017 - Caereservices.it.it