Página Inicial>Código fonte PHP>Outras categorias
Baixar

Classe do cliente em MailUp para Laravel 5.x

Esta aula ajuda você a usar a funcionalidade de correspondência da plataforma de correio com sua estrutura Laravel 5.x.

Instalação

Usando o compositor inserir no composer.json o seguinte bloco de código: 

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

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

Em seguida, execute a atualização do compositor

Comece

A seguir, o exemplo mostre as etapas básicas para usar esta classe em seu código. 

 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 e $ client_secret podem ser obtidos seguindo estes

Métodos disponíveis

Conecte-se 

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

Parâmetros:

  • Usuário : Nome de usuário para plataforma de correio (geralmente mxxxxx )
  • Senha : senha para plataforma de correio
  • ListName : (Opcional) O nome da lista de destinatários a serem usados, se não for especificado, a lista de correio é usada

Valores de retorno:

  • MailUpStatus :: ok - conectado corretamente
  • MailUpStatus :: err_not_logged_in - nome de usuário ou senha estão incorretamente
  • MailUpStatus :: err_invalid_parameter - um ou muitos parâmetros AR inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_list_not_found - Se listname for especificado, mas não existir na plataforma de correio

CreateList 

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

Parâmetro:

  • ListName : o nome da lista de destinatários para usar
  • ListData : Array com campos para preenchimento de dados da lista

Campos ListData

  • Nome - Nome da lista
  • Main_mail - Endereço de e -mail principal vinculado à lista
  • Responder_to - Endereço de correio para resposta do usuário
  • Sender_name - nome do remetente que aparece ao usuário quando recebe e -mail
  • Company_Name - Nome da sua empresa
  • Contact_name - Nome do contato na empresa (Match desnecessário Main_mail ou Responder_to Proprietário)
  • Endereço - Endereço da sua empresa
  • Cidade - sua empresa Cidade
  • country_code - seu código de país (por exemplo)
  • Perm_remind - lembrete de permissão (padrão "") Veja aqui para obter informações
  • Web_site - URL do seu site

Todos os campos são obrigatórios

Valores de retorno:

  • MailUpStatus :: OK - Lista criada corretamente
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_invalid_parameter - um ou muitos parâmetros AR inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_list_not_created - o nome da lista não existe na plataforma de correio e não pode ser criado
  • MailUpStatus :: err_no_list_data - a matriz ListData está vazia ou nula
  • MailUpStatus :: err_invalid_list_data - A matriz ListData tem um ou muitos campos vazios ou nulos

Changelist 

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

Se a listname não existir, a matriz e listdata for especificada, tente criá -lo

Parâmetro:

  • ListName : o nome da lista de destinatários para usar
  • ListData : (opcional) Matriz com campos para preenchimento de dados da lista (consulte CreateList for Array Struction)

Valores de retorno:

  • MailUpStatus :: OK - Lista alterada corretamente
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_invalid_parameter - um ou muitos parâmetros AR inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_list_not_created - o nome da lista não existe na plataforma de correio e não pode ser criado
  • MailUpStatus :: err_list_not_changed - o nome da lista é inválido e a lista atual permanece inalterada

addGroup 

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

Parâmetro:

  • GrupoName : o nome do grupo a ser criado

Valores de retorno:

  • (Número> 0) - Grupo criado e seu ID são retornados, se o grupo existir, o método retorna seu ID.
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_invalid_parameter - Um ou muitos parâmetros são inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_creating_groups - o nome do grupo não existe na plataforma de correio e não pode ser criado

addusertoGroup 

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

Parâmetros:

  • UserData : matriz com dados do usuário a serem adicionados ao grupo
  • Nome do grupo : o nome do grupo (pode ser um ID de grupo também)

Campos do usuário

  • Correio - Email de usuário ( obrigatório )
  • Nome - Usuário primeiro nome
  • Sobrenome - nome do usuário
  • Mobile - Número do celular do usuário sem prefixo internacional (Ex. +39xxxxxxx)
  • Empresa - Nome da empresa do usuário (se disponível)

Valores de retorno:

  • MailUpStatus :: OK - Usuário criado ou usuário existe na plataforma
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_invalid_parameter - Um ou muitos parâmetros são inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_getting_fields Este erro é retornado quando tivermos um problema com campos dinâmicos de correio (veja aqui para obter detalhes)
  • MailUpStatus :: err_invalid_userdata - O UserData contém dados inválidos ou campo incorreto
  • MailUpStatus :: err_adding_user - O usuário não pode ser criado (adicionado)

SendMessage 

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

Parâmetros:

  • Assunto - Assunto da mensagem
  • Mensagem - Texto da mensagem (pode ser texto simples ou html)
  • GrupoName - o nome do grupo para enviar uma mensagem
  • UserMails - o correio do (s) usuário (s) para enviar uma mensagem, pode ser um único endereço de correio ou matriz de endereço
  • Anexo - caminho para o arquivo/imagem/outro a anexar na mensagem (deve estar, se presente, caminho absoluto para arquivo, se ele permanecer no servidor ou URL), se a classe não encontrar o anexo, nenhum dado é anexado à mensagem

Se qualquer um de nome do grupo e/ou correios de usermands não for especificado ("" ou nulo for passado), a mensagem será enviada a todos os destinatários (usuários) presentes na lista atual.

Valores de retorno:

  • MailUpStatus :: message_sended - A mensagem é corretamente na fila e é enviada o mais rápido possível
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_invalid_parameter - um ou muitos parâmetros AR inválidos ou vazios
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_message_not_sended - A mensagem não pode ser enviada
  • MailUpStatus :: err_cant_create_message - O sistema não pode criar (preparar) a mensagem antes de enviá -la
  • MailUpStatus :: err_message_text_empty - O parâmetro da mensagem está vazio ou nulo

getTemplatelist 

   $result = $mailUp->getTemplateList();

Quase um modelo de correio deve ser criado pertence a plataforma de correio antes de usar este método e métodos vinculados, você pode encontrar todas as informações e guiar sobre modelos aqui

Valores de retorno:

  • Templateliststructure - Lista de modelos presentes na plataforma de correio
  • MailUpStatus :: err_no_templates - Não há modelo na plataforma de correio
  • MailUpStatus :: err_not_logged_in - O método é chamado sem fazer login
  • MailUpStatus :: err_mailup_exception - Exceção da plataforma de correio
  • MailUpStatus :: err_unknow_list - A lista atual tem um problema

sendFromTemplate 

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

Assunto e mensagem são obviamente desnecessários :)

Consulte o sendMessage para obter a maioria dos valores de parâmetro e retorno, exceto

Parâmetro:

  • TemplateID - ID do modelo obtido do item selecionado de GetTemplatelist Returned List

Valores de retorno:

  • MailUpStatus :: err_no_templates - O ID do modelo está incorreto ou inválido

Referência

Para toda a referência e especificação na API, ligue para a plataforma

Com base no código de exemplo daqui

Autor

Massimo Villalta - (c) 2017 - CaeRervices.it

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos