MapiMessageW structure (mapi.h)

A MapiMessageW structure contains information about a message.

Syntax

typedef struct {
  ULONG            ulReserved;
  PWSTR            lpszSubject;
  PWSTR            lpszNoteText;
  PWSTR            lpszMessageType;
  PWSTR            lpszDateReceived;
  PWSTR            lpszConversationID;
  FLAGS            flFlags;
  lpMapiRecipDescW lpOriginator;
  ULONG            nRecipCount;
  lpMapiRecipDescW lpRecips;
  ULONG            nFileCount;
  lpMapiFileDescW  lpFiles;
} MapiMessageW, *lpMapiMessageW;

Members

ulReserved

Type: ULONG

Reserved; must be zero.

lpszSubject

Type: PWSTR

Pointer to the text string describing the message subject, typically limited to 256 characters or less.

If this member is empty or NULL, there is no subject text.

lpszNoteText

Type: PWSTR

Pointer to a string containing the message text.

If this member is empty or NULL, there is no message text.

lpszMessageType

Type: PWSTR

Pointer to a string that indicates the message type of when the message is not an IPM.

If your Client supports Interpersonal Messages (IPMs) exclusively, set the lpszMessageType member to empty or NULL when sending messages and ignore the member when reading messages.

lpszDateReceived

Type: PWSTR

Pointer to a string indicating the date when the message was received. The format is YYYY/MM/DDHH:MM, using a 24-hour clock.

lpszConversationID

Type: PWSTR

Pointer to a string identifying the conversation thread to which the message belongs. Some messaging systems ignore this member.

flFlags

Type: FLAGS

Bitmask of message status flags. The following flags can be set.

Value Meaning
MAPI_RECEIPT_REQUESTED
0x00000002
A receipt notification is requested. Client applications set this flag when sending a message.
MAPI_SENT
0x00000004
The message has been sent.
MAPI_UNREAD
0x00000001
The message has not been read.

lpOriginator

Type: lpMapiRecipDescW

Pointer to a MapiRecipDescW structure containing information about the sender of the message.

nRecipCount

Type: ULONG

The number of MapiRecipDescW structures in the array pointed to by the lpRecips member.

If this member is zero, there are no recipients.

lpRecips

Type: lpMapiRecipDescW

Pointer to an array of MapiRecipDescW structures. Each structure contains information about one recipient.

nFileCount

Type: ULONG

The number of MapiFileDescW structures in the array pointed to by the lpFiles member.

If this member is zero, there are no file attachments.

lpFiles

Type: lpMapiFileDescW

Pointer to an array of MapiFileDescW structures. Each structure contains information about one file attachment.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header mapi.h

See also

MAPISendMailW

MapiFileDescW

MapiMessage

MapiRecipDescW