Module sintra_5_58_2_0-sintra.email

Facilidade para enviar e-mail pelo sistema.

Referências externas: https://tools.ietf.org/html/rfc3696 https://tools.ietf.org/html/rfc5322#section-3.4.1

Functions

encode_header (s, Encoding) Codifica o texto.
formata_nome_email (nome, email, Encoding) Monta um e-mail válido a partir de um nome e de um e-mail.
formata_email (s, Encoding) Formata a string para servir de e-mail válido.
formata_array_email (t, Encoding) Formata a string ou array para servir lista de e-mails válidos.
conteudo_anexo (texto, nome) Função auxiliar na montagem de e-mail com anexos.
nome_anexo (nome, path) Função auxiliar na montagem de e-mail com anexos.
monta_cabecalho_anexo (nome_arquivo) Função auxiliar na montagem dos cabeçalhos de anexos (usada internamente).
envia (t) Envia uma mensagem através do servidor da PUC.
valida_email (s) Verifica se o endereço de e-mail é válido.


Functions

encode_header (s, Encoding)
Codifica o texto.

Parameters:

  • s String com o conteúdo do cabeçalho a ser codificado.
  • Encoding String com o nome da codificação (UTF-8 ou ISO-8859-1, por exemplo).

Returns:

    String codificada para ser usada em cabeçalho SMTP.
formata_nome_email (nome, email, Encoding)
Monta um e-mail válido a partir de um nome e de um e-mail. A string resultante será da forma [[termo* ]] (sem os []), onde termo pode ser qualquer sequência de não-espaços que será codifiacada se necessário.

Parameters:

  • nome String com um nome (pode ser vazia).
  • email String com um endereço eletrônico (obrigatório).
  • Encoding String com o nome do encoding da string dada (s).

Returns:

    String da forma "nome qualquer" , ou nil, em caso de erro.
formata_email (s, Encoding)
Formata a string para servir de e-mail válido. A string resultante será da forma [[termo* ]] (sem os []), onde termo pode ser qualquer sequência de não-espaços que será codificada se necessário.

Parameters:

  • s String com e-mail a ser formatado.
  • Encoding String com o nome do encoding da string dada (s).

Returns:

    String onde o último trecho sem espaços fica entre '<' e '>', ou nil, em caso de erro.
formata_array_email (t, Encoding)
Formata a string ou array para servir lista de e-mails válidos. Cada elemento do array será uma string da forma [[termo* ]] (sem os []), onde termo pode ser qualquer sequência de não-espaços que será codificada se necessário.

Parameters:

  • t Tabela ou String com e-mail a ser formatado.
  • Encoding String com o nome do encoding usado na formatação (opcional).

Returns:

    Tabela (array) de strings formatadas.
conteudo_anexo (texto, nome)
Função auxiliar na montagem de e-mail com anexos.

Parameters:

  • texto String com o conteúdo do anexo.
  • nome String com o nome do arquivo.

Returns:

    Tabela que representa um anexo (e que deve ser um dos elementos do array Attachments passado para a função envia).
nome_anexo (nome, path)
Função auxiliar na montagem de e-mail com anexos.

Parameters:

  • nome String com o nome do arquivo.
  • path String com o path do arquivo.

Returns:

    Tabela que representa um anexo (e que deve ser um dos elementos do array Attachments passado para a função envia).
monta_cabecalho_anexo (nome_arquivo)
Função auxiliar na montagem dos cabeçalhos de anexos (usada internamente).

Parameters:

  • nome_arquivo String com o nome do arquivo que deve constar na mensagem.

Returns:

    Tabela com os cabeçalhos adequados.
envia (t)
Envia uma mensagem através do servidor da PUC. Os e-mails podem conter nomes antes (como em 'Tomás Guisasola tomas@esp.puc-rio.br'); os nomes ficarão entre aspas e os e-mails entre '<' e '>'. CUIDADO com listas de e-mails: 'tomas@puc-rio.br, tomas@gmail.com' vai ser transformado em um único destinatário: '"tomas@puc-rio.br," ' Como as mensagens são enviadas pelo servidor do RDC, provavelmente mensagens com remetentes de domínios que não são administrados lá serão rejeitadas.

Parameters:

  • t Tabela com os campos: Server String com o nome do servidor de correio postal (default = "correio.rdc.puc-rio.br") From String com o e-mail do remetente (de domínios do RDC) Body String com o conteúdo da mensagem Subject String com o assunto da mensagem To String ou tabela com o(s) destinatário(s) da mensagem Cc String ou tabela com a(s) cópia(s) da mensagem (opcional) Bcc String ou tabela com a(s) cópia(s) oculta(s) da mensagem (opcional) Reply String com o e-mail de retorno (opcional) Really_from String com o e-mail de verdade do remetente (default = From) Encoding String com a codificação do assunto e/ou corpo da mensagem (opcional) Type String com o tipo (cabeçalho Content-Type) do corpo da mensagem (opcional) Attachments Tabela com os anexos (usar as funções *_anexo deste módulo para especificar os dados)

Returns:

  1. Booleano indicando o sucesso no envio para o servidor.
  2. Mensagem de erro, em caso de falha.
valida_email (s)
Verifica se o endereço de e-mail é válido.

Parameters:

  • s String com e-mail a ser validado.

Returns:

  1. Booleano indicando se o endereço é válido (true) ou não (false).
  2. Mensagem de erro, em caso de invalidez.
generated by LDoc 1.4.6 Last updated 2024-09-26 20:37:35