mailup

Mailup Client Class для Laravel 5.x

Этот класс поможет вам использовать функциональность рассылки платформы Mailup с вашей структурой Laravel 5.x.

Установка

Использование композитора вставки в composer.json Следующий блок кода:

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

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

Затем запустите обновление композитора

Начните

В следующем примере показаны основные шаги для использования этого класса в вашем коде.

 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 и $ client_secret можно получить, следуя этим руководству

Доступные методы

авторизоваться

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

Параметры:

• Пользователь : имя пользователя для платформы Maup (обычно MXXXXX )
• Пароль : пароль для платформы MailUp
• ListName : (Необязательно) Имя списка получателей для использования, если не указано, используется список почтовой помощи по умолчанию

Возвращаемые значения:

• MailUpStatus :: OK - правильно вошел в систему
• MailUpStatus :: err_not_logged_in - имя пользователя или пароль неверно
• MailUpStatus :: err_invalid_parameter - один или много параметров AR недействительным или пустым
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailupStatus :: err_list_not_found - если указано на список , но не существует на платформе почтовой помощи

CreateList

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

Параметр:

• ListName : имя списка получателей для использования
• ListData : массив с полями для данных списка заполнения

ListData Fields

• Имя - Имя списка
• main_mail - главный адрес электронной почты, связанный со списком
• reply_to - почтовый адрес для ответа от пользователя
• sender_name - Имя отправителя, которое появляется пользователю при получении почты
• Company_Name - название вашей компании
• contact_name - имя контакта в компании (ненужный совпадение main_mail или reply_to владелец)
• Адрес - адрес вашей компании
• Город - Город вашей компании
• Country_code - код вашей страны (например.
• perm_remind - напоминание о разрешении (по умолчанию ") см. Здесь для получения информации
• web_site - URL вашего сайта

Все поля обязательны

Возвращаемые значения:

• MailUpStatus :: OK - список создан правильно
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_invalid_parameter - один или много параметров AR недействительным или пустым
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailUpStatus :: ERR_LIST_NOT_CREATED - ЗАПИСЬ НЕТ НЕ ТЕРУЖИТЕ В ПЛАТВОДАМА
• MailupStatus :: err_no_list_data - массив списков пуст или нулевой
• MailUpStatus :: err_invalid_list_data - в массиве ListData есть одно или много полей пустых или нулевых

изменение

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

Если ListName не существует, а также указанный массив ListData - попробуйте создать его

Параметр:

• ListName : имя списка получателей для использования
• ListData : (необязательно) массив с полями для данных списка заполнения (см. CreateList для структуры массива)

Возвращаемые значения:

• MailUpStatus :: OK - список изменился правильно
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_invalid_parameter - один или много параметров AR недействительным или пустым
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailUpStatus :: ERR_LIST_NOT_CREATED - ЗАПИСЬ НЕТ НЕ ТЕРУЖИТЕ В ПЛАТВОДАМА
• MailUpStatus :: ERR_LIST_NOT_CHANGED - Имя списка недействителен, а текущий список остается неизменным

addgroup

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

Параметр:

• GroupName : название созданной группы

Возвращаемые значения:

• (номер> 0) - Группа создана, и ее идентификатор возвращается, если группа существует, метод возвращает его идентификатор.
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_invalid_parameter - один или много параметров недействительны или пустые
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailUpStatus :: err_creating_groups - GroupName не существует на платформе MailUp и не может быть создано

Addusertogroup

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

Параметры:

• Userdata : массив с пользовательскими данными, которые будут добавлены в группу
• GroupName : имя группы (также может быть идентификатор группы)

Польза пользователя

• Почта - электронная почта пользователя ( обязательно )
• Имя - Пользователь FirstName
• Фамилия - Пользовательский имя
• Мобильный номер - номер мобильного пользователя без международного префикса (Ex. +39xxxxxxx)
• Компания - название компании пользователя (если доступно)

Возвращаемые значения:

• MailUpStatus :: OK - Пользовательский созданный или пользователь существует на платформе
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_invalid_parameter - один или много параметров недействительны или пустые
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailupStatus :: err_getting_fields Эта ошибка возвращается, когда у нас возникает проблема с динамическими полями MailUp (подробности см. Здесь)
• MailupStatus :: err_invalid_userdata - userData содержит неверные данные или неверное поле
• MailUpStatus :: err_adding_user - Пользователь не может быть создан (добавлена)

Sendmessage

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

Параметры:

• Тема - предмет сообщения
• Сообщение - текст сообщения (может быть простой текст или HTML)
• GroupName - имя группы для отправки сообщения
• Usermails - почта пользователя (ы) для отправки сообщения может быть единым почтовым адресом или массивом почтового адреса
• Приложение - Путь к файлу/изображению/другим, чтобы прикрепить к сообщению (должно быть, если присутствует, абсолютный путь к файлу, если он остается на сервере или URL), если класс не нашел вложение. Никакие данные не подключены к сообщению

Если какое -либо из GroupName и/или USERMAIL не указано ("" "или NULL передается), сообщение отправляется всем получателям (пользователям), присутствующим в текущем списке.

Возвращаемые значения:

• MailUpStatus :: Message_send
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_invalid_parameter - один или много параметров AR недействительным или пустым
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailUpStatus :: err_message_not_sended - Сообщение не может быть отправлено
• MailUpStatus :: err_cant_create_message - Система не может создать (подготовить) сообщение перед отправкой его
• MailUpStatus :: err_message_text_empty - Параметр сообщения пуст или нулевой

GetTemplateList

   $result = $mailUp->getTemplateList();

Почти один шаблон почты должен быть создан Платформа Mailup. Перед использованием этого метода и методов связаны, вы можете найти всю информацию и руководство по шаблонам здесь

Возвращаемые значения:

• TemplateListStructure - Список шаблонов, присутствующий на платформе MailUp
• MailupStatus :: err_no_templates - В платформе Mailup нет шаблона
• MailUpStatus :: err_not_logged_in - метод вызывается без входа в систему
• MailUpStatus :: err_mailup_exception - Исключение платформы Mailup
• MailUpStatus :: err_unknow_list - у текущего списка есть проблема

SendFromTemplate

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

Тема и сообщение , очевидно, ненужные :)

Обратитесь к SendMessage для большинства значений параметров и возврата, кроме следующего.

Параметр:

• Templateid - идентификатор шаблона, полученный из выбранного элемента getTemplateList возвращенного списка

Возвращаемые значения:

• MailupStatus :: err_no_templates - идентификатор шаблона неверен или недействителен

Ссылка

Для всех ссылок и спецификации по вызову API для платформы MailUp обратитесь здесь

На основе примера кода отсюда

Автор

Massimo villalta - (c) 2017 - Ceereservices.it