MAILHEADER()

From Recital Documentation Wiki
Jump to: navigation, search

Purpose

Function to return specified header information


Syntax

MAILHEADER(<array1>, <expC1>)


See Also

CLOSEMAIL(), COUNTMAIL(), DELETEMAIL(), MAILATTACH(), MAILCLOSE(), MAILCOUNT(), MAILDELETE(), MAILERROR(), MAILNODENAME(), MAILOPEN(), MAILREAD(), MAILSAVEAS(), MAILSEND(), MAILUSERNAME(), OPENMAIL(), READMAIL(), SENDMAIL()


Description

The MAILHEADER() function will return the specified header information from an array that was already created by MAILREAD(). If you are not connected to a mail server, it will return an error. You can use the MAILUSERNAME() or MAILNODENAME() function to check if you are connected.


Parameters Required Default Description
<array1> Yes None The name of an array to contain the mail messages read by MAILREAD()
<expC2> Yes None Specify the header information to return from the mail message. This can be any one of the following options:

"RECEIVED" "RETURN-PATH" "MESSAGE-ID" "FROM" "TO" "SUBJECT" "DATE" "STATUS"


The MAILERROR() function can be used to return the error message if the MAILHEADER() fails.


Example

number = mailread(1, "mail_mes")
? number
        30
? mailheader(mail_mes, "FROM")
sales@recital.com


Products

Recital Server, Recital