IIMAPTransport::Lsub method

[IIMAPTransport::Lsub is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Sends the LSUB command to the Internet Message Access Protocol (IMAP) server.

Syntax

HRESULT Lsub(
  [in] WPARAM        wParam,
  [in] LPARAM        lParam,
  [in] IIMAPCallback *pCBHandler,
  [in] LPCSTR        lpszMailboxNameReference,
  [in] LPCSTR        lpszMailboxNamePattern
);

Parameters

wParam [in]

Type: WPARAM

Specifies a WPARAM that together with lParam forms a unique transaction ID assigned by the caller to this IMAP command and its responses. The value can be anything except zero, which is reserved for unsolicited responses.

lParam [in]

Type: LPARAM

Specifies an LPARAM that together with wParam forms a unique transaction ID assigned by the caller to this IMAP command and its responses. The value can be anything except zero, which is reserved for unsolicited responses.

pCBHandler [in]

Type: IIMAPCallback*

Specifies a pointer to the IIMAPCallback interface to use to process the responses for this command. If this parameter is NULL, then the default callback interface is used. The default callback interface is specified in the IIMAPTransport::InitNew method, which initialized this IIMAPTransport object.

lpszMailboxNameReference [in]

Type: LPCSTR

Specifies an LPCSTR that contains the IMAP-compliant mailbox name or level in the mailbox tree as a multibyte string.

lpszMailboxNamePattern [in]

Type: LPCSTR

Specifies an LPCSTR that contains the specific IMAP-compliant mailbox name or mailbox name pattern with wildcard character ("*" or "%") as a multibyte string.

Return value

Type: HRESULT

Returns one of the following values.

Return code	Description
S_OK	Indicates success.
E_FAIL	Indicates that an unknown error has occurred.
E_OUTOFMEMORY	Indicates that an attempt to allocate memory failed.
IXP_E_IMAP_IMPROPER_SVRSTATE	Indicates that the server is not in an authenticated state and cannot accept this command.

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Product	Outlook Express 6.0
Header	Imnxport.h
IDL	Imnxport.idl
DLL	Inetcomm.dll (version 6.0 or later)