NEWMAIL_NOTIFICATION

The NEWMAIL_NOTIFICATION structure describes information relating to the arrival of a new message.

Quick Info

Header file: MAPIDEFS.H

typedef struct _NEWMAIL_NOTIFICATION 
{ 
     ULONG      cbEntryID; 
     LPENTRYID  lpEntryID;  
     ULONG      cbParentID; 
     LPENTRYID  lpParentID;  
     ULONG      ulFlags;  
     LPTSTR     lpszMessageClass; 
     ULONG      ulMessageFlags;  
} NEWMAIL_NOTIFICATION; 
 

Members

cbEntryID
Count of bytes in the entry identifier pointed to by the lpEntryID member.
lpEntryID
Pointer to the entry identifier of the newly arrived message.
cbParentID
Count of bytes in the entry identifier pointed to by the lpParentID member.
lpParentID
Pointer to the entry identifier of the receive folder for the newly arrived message.
ulFlags
Bitmask of flags used to describe the format of the string properties included with the message. The following flag can be set:
MAPI_UNICODE
The passed-in strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.
lpszMessageClass
Pointer to the message class of the newly arrived message.
ulMessageFlags
Bitmask of flags that describes the current state of the newly arrived message. The ulMessageFlags member is a copy of the message's PR_MESSAGE_FLAGS property.

Remarks

The NEWMAIL_NOTIFICATION structure is one of the members of the union of structures included in the info member of the NOTIFICATION structure. When the info member of a NOTIFICATION structure contains a NEWMAIL_NOTIFICATION structure, the ulEventType member of the NOTIFICATION structure is set to fnevNewMail.

MAPI uses the NEWMAIL_NOTIFICATION structure only as a member of the NOTIFICATION structure, which holds information about a notification event for the advise sink.

For more information about notification, see the topics described in the following table.

Topic Description
Event Notification in MAPI General overview of notification and notification events.
Handling Notifications Discussion of how clients should handle notifications.
Supporting Event Notification Discussion of how service providers can use the IMAPISupport method to generate notifications.

See Also

Notification Structures, NOTIFICATION, PR_MESSAGE_FLAGS