IMailMsgStoreDriver::EnumMessages

Platform SDK: SMTP Server Events

IMailMsgStoreDriver::EnumMessages

[This is preliminary documentation and subject to change.]

The IMailMsgStoreDriver::EnumMessages method returns a reference to an object used to enumerate undelivered messages in the backing store.

HRESULT EnumMessages([out] IMailMsgEnumMessages **ppEnum);

ppEnum: Receives the object reference used to enumerate the undelivered messages in the backing store.

Return Values

Value	Description
S_OK	Success.
E_FAIL	Failure. The store driver object has not been initialized.
E_POINTER	Error. NULL passed in ppEnum.
ERROR_SHUTDOWN_IN_PROGRESS	Error. Shutdown is in progress. (FACILITY_WIN32)

Remarks

Each store driver COM object must provide an enumerator for its undelivered messages in its persistence location, such as the file system. To do so, it must internally create an instance of such an object, initialize it with the location of all undelivered messages, and return the appropriate reference to the caller.

Store driver objects normally internally uses an instance of this same class when the SMTP service calls its exposed ISMTPStoreDriver::EnumerateAndSubmitMessages method.