SMTP_AddHeader

4D Internet Commands v16

SMTP_AddHeader


SMTP_AddHeader ( smtp_ID ; nomeCabe ; textoCabe {; excluirOpcao} ) -> Resultado

Parâmetro	Tipo	Descrição
smtp_ID	Inteiro longo	Referencia da mensagem
nomeCabe	String	Nome do cabeçalho
textoCabe	Texto	Texto do cabeçalho
excluirOpcao	Inteiro	0 = Adicionar 1 = Substituir todos os cabeçalhos com 'nomeCabe', 2 = Excluir todos os cabeçalhos chamados 'nomeCabe'
Resultado	Inteiro	Código de erro

Descrição

O comando SMTP_AddHeader permite aos usuários adicionar seus próprios cabeçalhos a mensagem referenciada por smtp_ID. Além dos cabeçalhos estandarte diretamente gerados pelos comandos Internet de 4D, há duas categorias de cabeçalhos adicionais, os cabeçalhos "usuário" (definidos pelo usuário) e os cabeçalhos "estendidos". O comando SMTP_AddHeader permite ao usuário adicionar o novo cabeçalho e os dados a associar a ele.

Cabeçalhos "estendidos": Estes Cabeçalhos têm sido oficialmente reconhecidos pelo NIC e se definiram depois das especificações SMTP iniciais. Estes cabeçalhos muitas vezes têm uma função específica afetando o comportamento das diferentes aplicações de software. Os cabeçalhos "estendidos" nunca começam pela letra "X".

Cabeçalhos "usuário": O protocolo SMTP permite que qualquer possa criar suas próprias definições de cabeçalho. Todos os cabeçalhos definidos pelo usuário devem começar pelos caracteres "X-" para evitar todo conflito com um futuro cabeçalho "estendido". Os cabeçalhos "usuário" são particularmente úteis quando você controla ambos extremos da comunicação.

Os cabeçalhos "usuário" permitem ao desenvolvedor armazenar dados que podem extrair facilmente com o comando POP3 MSG_FindHeader. Por exemplo, pode criar um cabeçalho chamado "X-001001", que contém o valor no campo 01 do arquivo 01. Pode agregar um número ilimitado de cabeçalhos a uma mensagem. Os cabeçalhos "usuário" dão ao usuário a possibilidade de adicionar a informação mais fácil de extrair sem necessidade de analisar o corpo da mensagem.

smtp_ID é a referencia inteiro longo de uma mensagem eletrônica criado com o comando SMTP_New.

nomeCabe contém o nome do cabeçalho a ser adicionado.

textoCabe contém a informação que será assinalada na área de cabeçalho identificada por nomeCabe.

Atenção: O texto não deve conter retornos de linha (ASCII = 10). Um retorno de linha significa o final da seção de cabeçalho e o começo do corpo. Os cabeçalhos posteriores poderiam ser considerados como o corpo do texto e não ser reconhecidos corretamente pelo software do servidor ou do cliente. Para obter mais informação sobre os cabeçalhos, consulte a RFC#822.

Nota: o comando não faz nada se nomCab ou textoCab for uma string vazia (sem cabeçalho adicionado).

excluirOpcao permite precisar se deseja eliminar o cabeçalho atual. Se passar zero, o cabeçalho nomeCabe é adicionado à mensagem. Se passar 1, todos os cabeçalhos da mensagem será substituído pelo cabeçalho nomeCabe. Neste caso, se nomeCabe é uma cadeia vazia, todos os cabeçalhos serão eliminados. Se passar 2, todos os cabeçalhos nomeCabe são eliminados da mensagem.

Nota: a partir da versão 14 de 4D Internet Commands, quando deseje enviar uma mensagem em formato HTML, já não é necessário mudar o cabeçalho "content-type" utilizando SMTP_AddHeader. Pode definir o formato HTML diretamente utilizando o comando SMTP_Body, cujo caso o "Content-Type" será definido automaticamente como "text/html;charset=utf-8" (caso contrário, o "Content-Type" está configurado por padrão como "text/plain;charset=utf-8"). No entanto, para necessidades específicas, pode sempre "forçar" o campo "Content-Type" com SMTP_AddHeader. Neste caso, tenha certeza de especificar o conjunto de caracteres (normalmente "charset=utf-8", já que, por padrão, 4D IC sempre envia o corpo como UTF-8).

Ver também

MSG_FindHeader
SMTP_New