DMessengerEvents::OnUnreadEmailChange event
[OnUnreadEmailChange is no longer available for use as of Windows Vista. See Windows Messenger for more information.]
Indicates the number of unread e-mail messages in the Messenger client's correlated Outlook.com Inbox that have changed from the last count of previous OnUnreadEmailChange events or initial sign-in.
Syntax
void OnUnreadEmailChange(
[in] MUAFOLDER mFolder,
[in] LONG cUnreadEmail,
[in] VARIANT_BOOL *pBoolfEnableDefault
);
Parameters
- *mFolder* \[in\]
-
C++ A value of the [MUAFOLDER](im-muafolder.md) 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. VB A value of the [MUAFOLDER](im-muafolder.md) enumeration. -
cUnreadEmail [in]
-
A LONG that contains the new number of unread e-mail messages in the Outlook.com Inbox.
- *pBoolfEnableDefault* \[in\]
-
C++ 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 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.VB A BOOL that is used to specify whether new e-mail alerts should suppress the e-mail pop-up message in the Messenger client 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
This event does not return a value.
Remarks
The OnUnreadEmailChange event is scriptable.
To use this event in 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 Outlook.com Inbox and therefore only to users signed in with Microsoft Outlook.com accounts or equivalent Outlook.com test domain accounts.
On the Microsoft Exchange Instant Messaging Service (IM) client, 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.
Requirements
| Minimum supported client |
Windows 2000 Professional, Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| End of client support |
Windows XP |
| End of server support |
Windows Server 2003 |
| Product |
Messenger 4.5 |
| Header |
|
| IDL |
|
| DLL |
|