IMAPIFolder Interface

IID_IMAPIFolder

{0002030C-0000-0000-C000-000000000046}

The IMAPIFolder interface is used to perform operations on the messages and subfolders in a folder.

This interface inherits from IMAPIProp.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIProp Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

SaveChanges

Makes permanent any changes made to an object since the last save operation.

GetProps

Retrieves one or more properties.

GetPropList

Returns property tags for all properties.

OpenProperty

Returns a pointer to an interface to be used to access a property.

SetProps

Updates one or more properties.

DeleteProps

Deletes one or more properties.

CopyTo

Copies or moves all properties, except for specifically excluded properties.

CopyProps

Copies or moves selected properties.

GetNamesFromIDs

Provides the property names that correspond to one or more property identifiers.

GetIDsFromNames

Provides the property identifiers that correspond to one or more property names.

IMAPIFolder Methods

Description

CreateMessage

Creates a new message.

CoptyMessage

Copies or moves one or more messages.

DeleteMessages

Deletes one or more messages.

CreateFolder

Creates a new subfolder.

CopyFolder

Copies or moves a subfolder.

DeleteFolder

Deletes a subfolder.

SetReadFlags

Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS property of one or more of the folder's messages and manages the sending of read reports.

GetMessageStatus

Obtains a message's status.

SetMessageStatus

Sets a message's status.

SaveContentsSort

Sets the default sort order for the contents table.

EmptyFolder

Removes all of the subfolders and messages without deleting the folder itself.

CreateMessage

FUNCTION IMAPIFolder_CreateMessage ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lppMessage AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[19] USING IMAPIFolder_CreateMessage (pIMAPIFolder, lpInterface, ulFlags, lppMessage) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CopyMessages

FUNCTION IMAPIFolder_CopyMessages ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL lpMsgList AS DWORD _
, BYREF lpInterface AS GUID _
, BYVAL lpDestFolder AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[20] USING IMAPIFolder_CopyMessages (pIMAPIFolder, lpMsgList, lpInterface, lpDestFolder, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DeleteMessages

FUNCTION IMAPIFolder_DeleteMessages ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL lpMsgList AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[21] USING IMAPIFolder_DeleteMessages (pIMAPIFolder, lpMsgList, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CreateFolder

FUNCTION IMAPIFolder_CreateFolder ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL ulFolderType AS DWORD _
, BYREF lpszFolderName AS ASCIIZ _
, BYREF lpszFolderComment AS ASCIIZ _
, BYREF lpInterface AS GUID _
, BYVAL ulFlags AS DWORD _
, BYREF lppFolder AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[22] USING IMAPIFolder_CreateFolder (pIMAPIFolder, ulFolderType, lpszFolderName, lpszFolderComment, lpInterface, ulFlags, lppFolder) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CopyFolder

FUNCTION IMAPIFolder_CopyFolder ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYREF lpInterface AS GUID _
, BYVAL lpDestFolder AS DWORD _
, BYREF lpszNewFolderName AS ASCIIZ _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[23] USING IMAPIFolder_CopyFolder (pIMAPIFolder, cbEntryID, lpEntryID, lpInterface, lpDestFolder, lpszNewFolderName, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DeleteFolder

FUNCTION IMAPIFolder_DeleteFolder ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[24] USING IMAPIFolder_DeleteFolder (pIMAPIFolder, cbEntryID, lpEntryID, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetReadFlags

FUNCTION IMAPIFolder_SetReadFlags ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL lpMsgList AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[25] USING IMAPIFolder_SetReadFlags (pIMAPIFolder, lpMsgList, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetMessageStatus

FUNCTION IMAPIFolder_GetMessageStatus ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpulMessageStatus AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[26] USING IMAPIFolder_GetMessageStatus (pIMAPIFolder, cbEntryID, lpEntryID, ulFlags, lpulMessageStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetMessageStatus

FUNCTION IMAPIFolder_SetMessageStatus ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL cbEntryID AS DWORD _
, BYVAL lpEntryID AS ENTRYID PTR _
, BYVAL ulNewStatus AS DWORD _
, BYVAL ulNewStatusMask AS DWORD _
, BYREF lpulOldStatus AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[27] USING IMAPIFolder_SetMessageStatus (pIMAPIFolder, cbEntryID, lpEntryID, ulNewStatus, ulNewStatusMask, lpulOldStatus) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SaveContentSort

FUNCTION IMAPIFolder_SaveContentsSort ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYREF lpSortCriteria AS SSortOrderSet _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[28] USING IMAPIFolder_SaveContentsSort (pIMAPIFolder, lpSortCriteria, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

EmptyFolder

FUNCTION IMAPIFolder_EmptyFolder ( _
  BYVAL pIMAPIFolder AS DWORD PTR _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFolder[29] USING IMAPIFolder_EmptyFolder (pIMAPIFolder, ulUIParam, lpProgress, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION