| |
| INT WINAPI ImapGetHeaderValue(
|
| |
HCLIENT hClient, |
|
| |
UINT nMessageId, |
|
| |
LPCTSTR lpszHeader, |
|
| |
LPTSTR lpszValue, |
|
| |
INT nMaxLength |
|
| );
|
The ImapGetHeaderValue function returns the value of a
header field in the specified message.
Parameters
- hClient
- Handle to the client session.
- nMessageId
- Number of message to retrieve header value from. This value
must be greater than zero. The first message in the mailbox is
message number one.
- lpszHeader
- Pointer to a null-terminated string which specifies the message
header to retrieve. The colon should not be included in this
string.
- lpszValue
- Pointer to a string buffer that will contain the value of the
specified message header.
- nMaxLength
- The maximum number of characters that may be copied into the
buffer, including the terminating null-byte.
Return Value
If the function succeeds, it returns the length of the header
field value. If the header field is not present in the message, the
function will return a value of zero. If the function fails, the
return value is IMAP_ERROR. To get extended error information, call
ImapGetLastError.
Remarks
The ImapGetHeaderValue function returns the value of
header field from the specified message. This allows an application
to be able to easily determine the value of a header such as the
sender, or the subject of the message. Any header field, including
non-standard extensions, may be returned by this function.
To return the value of a header field from a specific part of a
multipart MIME message, use the ImapGetHeaderValueEx
function.
Requirements
Client: Requires Windows 7, Windows Vista or Windows
XP.
Server: Requires Windows Server 2008 or Windows Server
2003.
Header: Include cstools7.h.
Library: Use csmapav7.lib.
Unicode: Implemented as Unicode and ANSI versions.
See Also
ImapGetHeaderValueEx,
ImapGetMessageHeaders,
ImapGetMessageId, ImapGetMessageSender
|
|