DMessengerEvents::OnUnreadEmailChange Event

  • Article

Deprecated. Indicates the number of unread e-mail messages in the Messenger client's correlated MSN Hotmail Inbox that have changed from the last count of previous DMessengerEvents::OnUnreadEmailChange events or initial sign-in.

Syntax

void OnUnreadEmailChange(      
    MUAFOLDER mFolder,
    LONG cUnreadEmail,
    VARIANT_BOOL *pBoolfEnableDefault
);

Parameters

  • mFolder
    [in] A value of the MUAFOLDER enumeration. Allowed values are:

    Constant Value Description
    MUADFOLDER_INBOX 0 Unread mail count has changed in the Inbox.
    MUADFOLDER_ALL_OTHER_FOLDERS 1 Not currently implemented. Do not use.

  • cUnreadEmail
    [in] A LONG that contains the new number of unread e-mail messages in the Hotmail Inbox.

  • pBoolfEnableDefault
    [in] 

    A pointer to a VARIANT_BOOL (equivalent to a VARIANT) of type VT_BOOL that is used to specify whether new e-mail alerts should suppress the e-mail pop-up message in the Messenger client user interface (UI). Suppressing the e-mail pop-up message is useful if a client displays its own UI when new e-mail arrives.

    Note: Reserved. In the current implementation, the e-mail pop-up message cannot be suppressed.

Return Value

No return value.

Event DISPID

DISPID_MUAE_ONUNREADEMAILCHANGE

The DISPID for this event is defined in msgrua.h. Use this value to identify the event handler when implementing IDispatch::Invoke.

Remarks

To use this event in Microsoft Windows Messenger, you must install an add-in component that supports e-mail integration.

In most cases, this mail count mechanism applies only to the Hotmail Inbox and therefore only to users signed in with @hotmail.com accounts or equivalent Hotmail test domain accounts.

On the Microsoft Exchange Instant Messaging Service (IM) client, DMessengerEvents::OnUnreadEmailChange indicates the changed unread e-mail count on the Exchange Inbox of the associated account.

To be used when writing custom ::Invoke methods to handle these events.

Parameter vaArgs[x] Variant Type
pBoolfEnableDefault 0 VT_BOOL
cUnreadEmail 1 VT_14
mFolder 2 VT_I4

Note  This event is available for scripting languages.

Important  DMessengerEvents::OnUnreadEmailChange is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

IMessenger::OpenInbox, IMessenger::UnreadEmailCount