*Parâmetros
Abaixo seguem duas listas de parâmetros, que são usados por todos os meios de transporte (Mitte pro client, SMTP e Rest API). A primeira é a lista de parâmetros para o envio de email com texto simples, e a segunda é para o envio de email com template. A segunda também contempla todos os parâmetros da primeira lista.
O * está indicando que, o parâmetro em questão, é usado / fornecido de forma distinta em alguns transportes, na descrição são ditos quais são esses transportes.
Para o Mitte pro client em Javascript, os parâmetros estão em CamelCase (mais especifícamente em lowerCamelCase).
Parâmetros no envio de email com texto simples
Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| recipient_list | Lista | Sim * | Lista de destinatários. O formato esperado é 'Nome <email>' ou '<email>'. Verificar como fornecer esse parâmetro por SMTP. |
| from | Texto | Sim * | O nome e email do remetente. O formato esperado é 'Nome <email>' ou '<email>'. Verificar como fornecer esse parâmetro por Mitte pro client. |
| subject | Texto | Sim | O assunto do email. |
| message_text | Texto | Sim | A mensagem do email em formato de texto. |
| message_html | Texto | Não | A mensagem do email em formato de html. |
| tags | Objeto/Lista | Não | As tags podem ser um objeto simples com chaves e valores, ou uma lista com strings. |
| activate_tracking | Booleano | Não | Se ativado o Mitte pro irá rastrear se o email é aberto e quantas vezes isso ocorre. Ele fará o mesmo Obs: Em Js deve ser utilizado o padrão LowerCamelCase---- activateTracking |
| Reply-to | Texto | Não* | Utilizado junto com o headers em Python Obs: Em Java deve ser utilizado fora do headers e da seguinte forma message.setReplyTo(InternetAddress.parse("Nome <Email@email.com>")); Obs: Em JavaScript deve ser usado junto com o headers 'headers': {'replyTo': 'Nome <Mittepro@mittepro.com.br>'} ou 'headers': {'replyTo': 'Mittepro@mittepro.com.br} |
| send_at | Texto | Não | Data e hora para qual agendamos o envio do email. 'send_at': 'AAAA-MM-DD 00:00:00', |
Parâmetros no envio de email com template
Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| recipient_list | Lista | Sim | Lista de destinatários. O formato esperado é 'Nome <email>' ou '<email>'. Verificar como fornecer esse parâmetro por SMTP. |
| from | Texto | Sim * | O nome e email do remetente. O formato esperado é 'Nome <email>' ou '<email>'. Verificar como Obs: Se for usado o envio de email com template, e o parâmetro |
Subject | Texto | Sim * | O assunto do email. Obs: Se for usado o envio de email com template, e o parâmetro 'use_template_subject' for fornecido como 'true', então 'subject' não precisa ser fornecido. |
| message_text | Texto | Sim | A mensagem do email em formato de texto. Obs: Se esse parâmetro for fornecido, então o Mitte pro |
| message_html | Texto | Não | A mensagem do email em formato de html. Obs: Se esse parâmetro for fornecido, então o Mitte pro irá |
| template_slug | Texto | Não | Aqui é fornecido o slug do template. |
| context | Objeto | Não | Variáveis globais usadas no template. O formato é de um objeto simples com chave e valor. |
| context_per_recipient | Objeto | Não | Variáveis usadas no template, e cujos os valores são específicos por cada destinatário. O formato é de objetos simples dentro de um objeto, e cujas chaves desse são os emails dos destinatários. |
| use_tpl_default_name | Booleano | Não | Se ativado o Mitte pro irá usar o valor padrão, estabelecido no template, para o nome do remetente. |
| use_tpl_default_email | Booleano | Não | Se ativado o Mitte pro irá usar o valor padrão, estabelecido no template, para o email do remetente. |
| use_tpl_default_subject | Booleano | Não | Se ativado o Mitte pro irá usar o valor padrão, estabelecido no template, para o assunto do email. |
| activate_tracking | Booleano | Não | Se ativado o Mitte pro irá rastrear se o email é aberto e quantas vezes isso ocorre. Ele fará o mesmo Obs: Em Js deve ser utilizado o padrão LowerCamelCase---- activateTracking |
| get_text_from_html | Booleano | Não | Se ativado o Mitte pro irá extrair do conteúdo html do template uma versão em formato de texto. Isso apenas pode acontecer se o template já não possuir uma versão em formato de texto. |
| Reply-to | Texto | Não* | Utilizado junto com o headers em Python Obs: Em Java deve ser utilizado fora do headers e da seguinte forma message.setReplyTo(InternetAddress.parse("Nome <Email@email.com>")); Obs: Em JavaScript deve ser utilizado da seguinte forma 'headers': {'replyTo': 'Nome <Mittepro@mittepro.com.br>'} ou 'headers': {'replyTo': 'Mittepro@mittepro.com.br} |
| Send_at | Texto | Não | Data e hora para qual agendamos o envio do email. 'send_at': 'AAAA-MM-DD 00:00:00', |