Retrieves the headers for the specified message from the
server.
Syntax
object.GetHeaders( MessageNumber,
Headers )
Remarks
The GetHeaders method is used to retrieve the message
headers from the server and copy it into a local buffer. This
method will cause the current thread to block until the article
transfer completes, a timeout occurs or the transfer is canceled.
During the transfer, the OnProgress event will fire
periodically, enabling the application to update any user interface
objects such as a progress bar.
- MessageNumber
- Number of article to retrieve from the server. This value must
be greater than zero. The first message in the mailbox is message
number one.
- Headers
- A string or byte array which will contain the data transferred
from the remote server when the method returns.
Note that the header data will be from the first part of the
message, not from any additional sections of a multipart message.
In other words, the headers such as From, To, Subject and Date will
be returned in the buffer. To retrieve the headers from a specific
section of a multipart message, you can use the GetMessage
method and specify the imapSectionHeader option.
Return Value
A value of zero is returned if the method was successful.
Otherwise, a non-zero error code is returned which indicates the
cause of the failure.
See Also
MessageCount
Property, CreateMessage
Method, GetMessage Method,
OpenMessage Method, OnProgress Event
|