[PT] – Enviar e-mail: enviar e-mail e assinaturas

1 Formato de Pedido
2 Explicação dos campos
3 Operação
4 Uso de los Tags Simples
5 Uso de los Tags Estruturados
6 Formato de Resposta
- 6.1 Lista de respostas de erro esperadas
- 6.2 Lista de respostas esperadas de sucesso

Formato de Pedido

<enviarEmail>
   <suscripto>
      <email>EMAIL DEL SUSCRIPTO</email>
      [
      <nombre>NOMBRE DEL SUSCRIPTO</nombre>
      ]
      [
      <apellido>APELLIDO DEL SUSCRIPTO</apellido>
      ]
   </suscripto>
   <campanaId>ID DE LA CAMPAÑA</campanaId>
   <email>
      [
      <viaUrl>DIRECCION DE LA PIEZA</viaUrl>
      ]
      [
      <piezaEnUtf8>0 ó 1</piezaEnUtf8>
      ]
      [
      <piezaFija>DIRECCION DE PIEZA FIJA</piezaFija>
      ]
      [
      <asunto>ASUNTO DE E-MAIL</asunto>
      ]
      [
      <tags>
         <tag1>REEMPLAZO 1</tag1>
         ....
         <tagN>REEMPLAZO       N</tagN>
      </tags>
      ]
   </email>
   <serverKey>SERVER KEY</serverKey>
</enviarEmail>

Explicação dos campos

O campo de email é obrigatório. Se email = 0 ou falso, nenhum email será enviado e somente o assinante será inserido no sistema.
O ID da campanha é obtido da plataforma DMDS: Na visualização detalhada de um tipo de API Campaign, você pode encontrar o campo ID da campanha para copiar.
Se email.viaUrl estiver presente, espera-se que seja o URL de uma parte HTML. Se não estiver presente, a peça associada à API do tipo Campaign será usada (consulte Como criar uma API do tipo Campaign)
Email.piezaEnUtf8 só deve ser enviado se for enviado usando email.viaUrl e define a codificação da parte (UTF-8 ou IS0-8859-1)
As tags podem ser substituídas por uma enumeração, que determinará o número de repetições aplicadas com a marca <% REPEAT TAG%>. Por exemplo:

<tag1>Reemplazo1</tag1>
<tag2>
<item>Reemplazo 2.1</item> <item>Reemplazo 2.2</item> <item>Reemplazo 2.3</item>
</tag2>

irá determinar 3 loops em uma marca <% REPEAT tag1%>. Se for usado no modo usual (individual), a primeira substituição disponível será usada.

Você também pode usar tags estruturadas, com atributos. Nesse caso, por exemplo, “Replace1” poderia ser uma estrutura de mais um nível:

<tag1>
<attr1>Valor para tag1.attr1</attr1> <attr2>Valor para tag1.attr2</attr2> <attr3>Valor para tag1.attr3</attr3>
</tag1>

As ocorrências da cadeia tag1.attr1 sendo substituídas por “Valor para tag1.attr1” e assim por diante.
Esta última funcionalidade pode ser combinada com as enumerações, possibilitando a construção de peças complexas altamente customizadas.

Operação

O subscrito será adicionado ao banco de dados, se não estiver lá.
O assinante estará relacionado à origem associada à campanha
Se o campo de email for 0, nenhuma outra ação será executada
Se houver um valor no campo de email, um email será enviado. Os dados neste e-mail são, por padrão, os dados associados à campanha e alguns podem ser configurados na solicitação da API (viaUrl, PieceFix e assunto).

Uso de los Tags Simples

Por convención los tags reemplazables son de la forma: XYZtagXYZ, para evitar reemplazos erróneos.

Hay dos modos de uso disponibles: Individual y modo Repeat.

Uso individual

É o normalmente usado em DMDS: XYZNOMBREXYZ é substituído pelo nome do assinante. Observe que a substituição é insensível a maiúsculas e minúsculas (XYZNOMBREXYZ é igual a xyznamexyz e XyZnOMbReXyZ).

Assim, se em email.tags encontramos <XYZTAG1XYZ> SUBSTITUIÇÃO 1 </ XYZTAG1XYZ> então cada ocorrência da palavra XYZTAG1XYZ na peça será substituída por SUBSTITUIÇÃO 1. Introduziremos o uso da Repetição com um exemplo.

Assuma uma peça com este texto:

A melhor opção para você é XYZURLXYZ

<% REPETIR XYZURLXYZ%>

Veja esta seção: XYZURLXYZ onde você vai encontrar o seu XYZBUSQUEDAXYZ

<% / REPETIR XYZURLXYZ%>

<% REPETIR XYZSEGUNDABUSQUEDAXYZ%>

Nenhuma notícia sobre o seu XYZSEGUNDABUSQUEDAXYZ

<% / REPETIR XYZSEGUNDABUSQUEDAXYZ%>

E um pedido para sendMail com as seguintes tags:

<XYZBUSQUEDAXYZ>Perro</XYZBUSQUEDAXYZ>
<XYZSEGUNDABUSQUEDAXYZ>Gato</ XYZSEGUNDABUSQUEDAXYZ > 
<XYZURLXYZ>
<item>golderetriever.com</item>
<item>google.com</item>
<item>pedigree.com</item>
</XYZURLXYZ>

Peça resultante

1 | A melhor opção para você é golderetriever.com

2 | Veja esta seção: golderetriever.com onde você encontrará seu cão

3 | Veja esta seção: google.com onde você encontrará seu cão

4 | Veja esta seção: pedigree.com onde você encontrará seu cão

5 |

6 | Nenhuma notícia sobre o seu gato

Note que:

Quando uma tag enumerada é usada sem estar dentro de um contexto de <% REPEAT%>, a primeira substituição disponível é usada:

1| A melhor opção para você é golderetriever.com
O corpo de um <% REPEAT%> é repetido uma vez para cada substituição de uma tag listada. O contexto é aberto apenas para uma única tag e o REPEAT não pode ser aninhado:
2 | Veja esta seção: golderetriever.com onde você encontrará seu cão

3 | Veja esta seção: google.com onde você encontrará seu cão

4 | Veja esta seção: pedigree.com onde você encontrará seu cão

Se XYZBUSQUEDAXYZ fosse listado, de qualquer forma, apenas o primeiro item (Dog) apareceria.
Para um REPEAT, uma tag individual é considerada como uma lista de item único6 | Nenhuma notícia sobre o seu gato
Consulte o início da tag de fechamento é <% / (Low-Percent-bar) e não </% (baixo Barra por cento) como seria um típico tag de fechamento HTML

Uso de los Tags Estruturados

Mais uma vez, eles podem ser usados no modo Individual e no modo de repetição.

O uso dessas tags é: NombreTag (punto) NombreAtributo

Exemplo de uso individual: Se no email.tags aparecer:

<XYZTAG1XYZ>
<XYZATTR1XYZ>Atributo 1</XYZATTR1XYZ>
<XYZATTR2XYZ>Atributo 2</XYZATTR2XYZ>
</XYZTAG1XYZ>

cada ocorrência da string XYZTAG1XYZ.XYZATTR1XYZ na peça será substituída pelo Atributo 1 e XYZTAG1XYZ.XYZATTR1XYZ será substituído pelo Atributo 2.

Observe que XYZTAG1XYZ sozinho não será substituído.

Exemplo de uso de tags estruturadas no modo de repetição:

Peça

Nós temos notícias sobre INTERES.NOMBRE!

<% REPEAT INTERES%>

<h1> INTERES.NAME </ h1>

Visite o endereço INTERES.LINK

Ou entre em contato com INTERES.CONTACTO

<% / REPETIÇÃO DE INTERESSES%>

<% REPEAT SEGUNDABUSQUEDA%>

Não há notícias sobre o seu SECUNDABUSQUEDA.NOMBRE

A pesquisa expira no dia SEGUNDABUSQUEDA.VENCIMIENTO

<% / REPEAT SEGUNDABUSQUEDA%>

E um pedido para sendMail com as seguintes tags:

<INTERES>
   <item>
      <NOMBRE>Torneo de Futbol</NOMBRE>
      <LINK>
      http://www.torneofutbol.com/</LINK>
      <CONTACTO>webmaster@torneofutbol.com</CONTACTO>
   </item>
   <item>
      <NOMBRE>Torneo de Basquet</NOMBRE>
      <LINK>
      http://www.torneobasquet.com/</LINK>
      <CONTACTO>webmaster@torneobasquet.com</CONTACTO>
   </item>
</INTERES>
<SEGUNDABUSQUEDA>
   <NOMBRE>Viaje a la costa</NOMBRE>
   <VENCIMIENTO> 08/12/2010</VENCIMIENTO>
</SEGUNDABUSQUEDA

Peça Resultante

1 | Nós temos notícias sobre o torneio de futebol!

2 | <h1> Torneio de Futebol </ h1>

3 | Visite o endereço http://www.torneofutbol.com/

4 | Ou entre em contato com webmaster@torneofutbol.com

5 | <h1> Torneio de basquete </ h1>

6 | Visite o endereço http://www.torneobasquet.com/</

7 | Ou entre em contato com webmaster@torneobasquet.com

8 |

9 | Nenhuma notícia sobre sua viagem ao litoral

10 | A busca expira em 08/12/2010

Note que:

A funcionalidade é uma fusão natural do modo de Repetição e das Tags Estruturadas, valem exatamente os mesmos esclarecimentos que para o Modo de Repetição das tags simples, em particular:

Quando uma tag listada é usada sem estar dentro de um contextot de <% REPEAT%>, a primeira substituição disponível é usada
O corpo de um <% REPEAT%> é repetido uma vez para cada substituição de uma tag listada. O contexto é aberto apenas para uma tag apenas, e o REPEAT não pode ser aninhado. Para um REPEAT, uma tag individual é considerada como uma lista de 1 item individual.

Como pode ser visto no exemplo, nem as tags nem os atributos devem necessariamente iniciar e terminar com XYZ. De qualquer forma, é altamente recomendável seguir esta convenção, uma vez que todas as aparências serão substituídas. Se palavras comuns como “link” e “contato” forem usadas, é muito provável que o e-mail seja corrompido.

Formato de Resposta

<enviarMailResponse>
<return> XXX - Mensaje Human Readable </return>
</enviarMailResponse>

XXX - Mensaje Human Readable

Isto é: 3 números, espaço, hífen, espaço, Mensagem Legível.

Lista de respostas de erro esperadas

100 – ServerKey não encontrado
101 – serverkey incorreto
102 – Ordem incorreta
107 – errado errado
120 – Não há frete associado a campanaId
120 – Não há envio de dinheiro associado à campanha
121 – Ocorreu um problema ao inserir o suscribed
122 – Relés não configurados para a conta. Entre em contato com seu administrador.
124 – Não há resposta do servidor SMTP
125 – Problema ao enviar o e-mail: Descrição
110 – Alguns campos obrigatórios não estão configurados
111 – O e-mail digitado está incorreto
112 – O URL para encontrar a parte está incorreto
113 – Url ou parte no URL errado
114 – Peça de e-mail mal formatada
115 – Peça com caminhos relativos sem caminho absoluto inferível
116 – Problemas ao substituir Tags na peça: Descrição

Lista de respostas esperadas de sucesso

200 – Novo subscrito inserido
201 – Assinante existente. Novo relacionamento
202 – Assinante existente, relação existente
300 – E-mail enviado. Novo subscrito inserido
301 – E-mail enviado. Subscrição existente Novo relacionamento
302 – E-mail enviado. Assinante existente, relacionamento existente
303 – E-mail enviado.

Buscar en Planisys

[PT] – Enviar e-mail: enviar e-mail e assinaturas

Formato de Pedido

Explicação dos campos

Operação

Uso de los Tags Simples

Peça resultante

6 | Nenhuma notícia sobre o seu gato

Note que:

Uso de los Tags Estruturados

Peça

Peça Resultante

Note que:

Formato de Resposta

Lista de respostas de erro esperadas

Lista de respostas esperadas de sucesso