IMsgStore::SetReceiveFolder

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Establishes a folder as the destination for incoming messages of a particular message class.

HRESULT SetReceiveFolder(
  LPSTR lpszMessageClass,
  ULONG ulFlags,
  ULONG cbEntryID,
  LPENTRYID lpEntryID
);

Parameters

• lpszMessageClass
  [in] A pointer to the message class that is to be associated with the new receive folder. If the lpszMessageClass parameter is set to NULL or an empty string, SetReceiveFolder sets the default receive folder for the message store.

• ulFlags
  [in] A bitmask of flags that controls the type of the text in the passed-in strings. The following flag can be set:

  • MAPI_UNICODE
    The message class string is in Unicode format. If the MAPI_UNICODE flag is not set, the message class string is in ANSI format.

• cbEntryID
  [in] The byte count in the entry identifier pointed to by the lpEntryID parameter.

• lpEntryID
  [in] A pointer to the entry identifier of the folder to establish as the receive folder. If the lpEntryID parameter is set to NULL, SetReceiveFolder replaces the current receive folder with the message store's default.

Return Value

• S_OK
  A receive folder was successfully established.

Remarks

The IMsgStore::SetReceiveFolder method sets or changes the receive folder for a particular message class. With SetReceiveFolder, a client can, by using successive calls, specify a different receive folder for each defined message class or specify that incoming messages for multiple message classes all go to the same folder. For example, a client can have its own class of messages arrive in its own folder. A fax application can designate one folder in which the store provider puts incoming faxes and another folder in which the provider puts outgoing faxes.

If an error occurs during the call to SetReceiveFolder, the receive folder setting remains unchanged.

If SetReceiveFolder changes the receive folder setting with lpEntryID set to NULL, indicating that the default receive folder should be set, SetReceiveFolder returns S_OK even if there was no existing setting for the indicated message class.

MFCMAPI Reference

For MFCMAPI sample code, see the following table.

File	Function	Comment
MsgStoreDlg.cpp	CMsgStoreDlg::OnSetReceiveFolder	MFCMAPI uses the IMsgStore::SetReceiveFolder method to set a folder as the receive folder for a particular message class.

See Also

Reference

IMsgStore : IMAPIProp

Concepts

MFCMAPI as a Code Sample