4D Doc Center : SMTP

4D Internet Commands v14

SMTP_AddHeader


SMTP_AddHeader ( smtp_ID ; nomEncabezado ; textoEncab {; eliminarOpcion} ) -> resultado

Parámetro	Tipo	Descripción
smtp_ID	Entero largo	Referencia del mensaje
nomEncabezado	Cadena	Nombre del encabezado
textoEncab	Texto	Texto del encabezado
eliminarOpcion	Entero	0 = Añadir 1 = Reemplazar todos los encabezados con 'nombreEncabezado', 2 = Eliminar todos los encabezados llamados 'nomEncab'
resultado	Entero	Código de error

Descripción

El comando SMTP_AddHeader permite a los usuarios añadir sus propios encabezados al mensaje referenciado por smtp_ID. Además de los encabezados estándar directamente generados por los comandos Internet de 4D, hay dos categorías de encabezados adicionales, los encabezados "usuario" (definidos por el usuario) y los encabezados "extendidos". El comando SMTP_AddHeader permite al usuario añadir el nuevo encabezado y los datos a asociar a él.

Encabezados "extendidos": estos encabezados han sido oficialmente reconocidos por el NIC y se definieron después de las especificaciones SMTP iniciales. Estos encabezados a menudo tienen una función específica afectando el comportamiento de las diferentes aplicaciones de software. Los encabezados "extendidos" nunca comienzan por la letra "X".

Encabezados "usuario": el protocolo SMTP permite que cualquiera pueda crear sus propias definiciones de encabezado. Todos los encabezados definidos por el usuario deben comenzar por los caracteres "X-" para evitar todo conflicto con un futuro encabezado "extendido". Los encabezados "usuario" son particularmente útiles cuando usted controla ambos extremos de la comunicación.

Los encabezados "usuario" permiten al desarrollador almacenar datos que se pueden extraer fácilmente con el comando POP3 MSG_FindHeader. Por ejemplo, puede crear un encabezado llamado "X-001001", que contiene el valor en el campo 01 del archivo 01. Puede añadir un número ilimitado de encabezados a un mensaje. Los encabezados "usuario" le dan al usuario la posibilidad de añadir la información más fácil de extraer sin necesidad de analizar el cuerpo del mensaje.

smtp_ID es la referencia entero largo de un mensaje electrónico creado con el comando SMTP_New.

nomEncab contiene el nombre del encabezado a añadir.

textoEncab contiene la información que se asignará en el área de encabezado identificada por nomEncab.

Atención: el texto no debe contener retornos de línea (ASCII = 10). Un retorno de línea significa el final de la sección de encabezado y el comienzo del cuerpo. Los encabezados posteriores podrían ser considerados como el cuerpo del texto y no ser reconocidos correctamente por el software del servidor o del cliente. Para obtener más información sobre los encabezados, consulte la RFC#822.

eliminarOpcion permite precisar si desea eliminar el encabezado actual. Si pasa cero, el encabezado nomEncab se añade al mensaje. Si pasa 1, todos los encabezados del mensaje se remplazan por el encabezado nomEncab. En este caso, si nomEncab es una cadena vacía, todos los encabezados se eliminarán. Si pasa 2, todos los encabezados nomEncab se eliminan del mensaje.

Nota: a partir de la versión 14 de 4D Internet Commands, cuando desee enviar un mensaje en formato HTML, ya no es necesario cambiar el encabezado "content-type" utilizando SMTP_AddHeader. Puede definir el formato HTML directamente utilizando el comando SMTP_Body.