IMsgStore::NotifyNewMail
The IMsgStore::NotifyNewMail
method informs the message store that a new message has arrived. This
method is called only by the MAPI spooler.
Quick Info
See IMsgStore
: IMAPIProp.
HRESULT NotifyNewMail(
|
LPNOTIFICATION lpNotification |
|
|
) |
|
Parameters
lpNotification
[in] Pointer
to a NOTIFICATION
structure describing the new-message notification.
Return Value
S_OK
The message
store was successfully notified.
Remarks
The IMsgStore::NotifyNewMail
method is called by the MAPI spooler to inform the message store that a message
is ready for delivery.
Notes to Implementers
When NotifyNewMail
is called, send a new mail notification to all registered clients. This can be
done by calling IMAPISupport::Notify if you elect to use the support object
methods or with your own implementation. A registered client is one that has
called IMsgStore::Advise and set the lpEntryID parameter to NULL
and the ulEventMask parameter to fnevNewMail.
Do not modify
or free the memory for the NOTIFICATION structure that describes the new mail
notification. Copy the NOTIFICATION structure by calling the utility
function ScCopyNotifications
to make use of the information in its members.
See Also