OESTORE::IOEFolderManager Interface Reference

List of all members.

Public Member Functions

HRESULT ActivateGlobalNotification ()
HRESULT CopyMessage ([in] long srcFolderId,[in] long destFolderId,[in] long msgId,[out, retval] BOOL *)
HRESULT CreateFolder ([in] long parentFolderId,[in] BSTR name,[out, retval] long *)
HRESULT DeleteFolder ([in] long folderId,[out, retval] BOOL *)
HRESULT GetCurrentFolder ([out, retval] OEFolder **folder)
HRESULT GetDeletedFolder ([out, retval] OEFolder **folder)
HRESULT GetDraftFolder ([out, retval] OEFolder **folder)
HRESULT GetFirstFolder ([out, retval] OEFolder **folder)
HRESULT GetFolder ([in] long folderId,[out, retval] OEFolder **folder)
HRESULT GetInboxFolder ([out, retval] OEFolder **folder)
HRESULT GetNextFolder ([out, retval] OEFolder **folder)
HRESULT GetOutboxFolder ([out, retval] OEFolder **folder)
HRESULT GetSentFolder ([out, retval] OEFolder **folder)
HRESULT MoveFolder ([in] long folderId,[in] long newParentId,[out, retval] BOOL *)
HRESULT MoveMessage ([in] long srcFolderId,[in] long destFolderId,[in] long msgId,[out, retval] BOOL *)
HRESULT RenameFolder ([in] long folderId,[in] BSTR newName,[out, retval] BOOL *)

Member Function Documentation

HRESULT OESTORE::IOEFolderManager::ActivateGlobalNotification (  ) 

Activate the IOEFolderManagerEvents::OnNewMessage notification.
You need to activate it explicitly because the activation takes some time.

HRESULT OESTORE::IOEFolderManager::CopyMessage ( [in] long  srcFolderId,
[in] long  destFolderId,
[in] long  msgId,
[out, retval] BOOL *   
)

Copies a message from srcFolderId to destFolderId.

HRESULT OESTORE::IOEFolderManager::CreateFolder ( [in] long  parentFolderId,
[in] BSTR  name,
[out, retval] long *   
)

Creates a folder. If the function fails it returns -1. Otherwise, returns the folderId of the new folder.

HRESULT OESTORE::IOEFolderManager::DeleteFolder ( [in] long  folderId,
[out, retval] BOOL *   
)

Deletes the specified folder. If the function returns TRUE the folderId is no longer valid.

HRESULT OESTORE::IOEFolderManager::GetCurrentFolder ( [out, retval] OEFolder **  folder  ) 

Get the current folder of the iterator. The last folder retrieved with GetFirstFolder or GetNextFolder.

HRESULT OESTORE::IOEFolderManager::GetDeletedFolder ( [out, retval] OEFolder **  folder  ) 

Gets the special folder Deleted items.

HRESULT OESTORE::IOEFolderManager::GetDraftFolder ( [out, retval] OEFolder **  folder  ) 

Gets the special folder Drafts.

HRESULT OESTORE::IOEFolderManager::GetFirstFolder ( [out, retval] OEFolder **  folder  ) 

Reset the internal OEFolder iterator. Using GetNextFolder the iterator browses all the folders' hierarchy.

HRESULT OESTORE::IOEFolderManager::GetFolder ( [in] long  folderId,
[out, retval] OEFolder **  folder 
)

Get the folder using the id.

HRESULT OESTORE::IOEFolderManager::GetInboxFolder ( [out, retval] OEFolder **  folder  ) 

Gets the special folder Inbox.

HRESULT OESTORE::IOEFolderManager::GetNextFolder ( [out, retval] OEFolder **  folder  ) 

Get next folder. This function returns the first child folder of the previous object if any, the sibling folder if any or the parent sibling. If the previous was the last folder, it returns NULL.

HRESULT OESTORE::IOEFolderManager::GetOutboxFolder ( [out, retval] OEFolder **  folder  ) 

Gets the special folder Outbox.

HRESULT OESTORE::IOEFolderManager::GetSentFolder ( [out, retval] OEFolder **  folder  ) 

Gets the special folder Sent items.

HRESULT OESTORE::IOEFolderManager::MoveFolder ( [in] long  folderId,
[in] long  newParentId,
[out, retval] BOOL *   
)

Moves the folder.

HRESULT OESTORE::IOEFolderManager::MoveMessage ( [in] long  srcFolderId,
[in] long  destFolderId,
[in] long  msgId,
[out, retval] BOOL *   
)

Moves a message from srcFolderId to destFolderId.

HRESULT OESTORE::IOEFolderManager::RenameFolder ( [in] long  folderId,
[in] BSTR  newName,
[out, retval] BOOL *   
)

Renames the folder.



Developed by Nektra