OEAPI::IOEAPIObj Interface Reference

List of all members.

Public Member Functions

HRESULT AddSelectedMessageID ([in] LONG msgId)
HRESULT ComposeMessage ()
HRESULT CreateToolbar ([out, retval] IOEToolbar **newToolbar)
HRESULT CreateToolbarInMsgWnd ([in] WNDSTYLE wndStyle,[out, retval] IOEToolbar **newToolbar)
HRESULT GetActiveMsgWndID ([out, retval] LONG *msgWndId)
HRESULT GetCurrentMessageID ([out, retval] LONG *msgId)
HRESULT GetFirstMenuItemID ([out, retval] LONG *)
HRESULT GetFirstMsgWndID ([out, retval] LONG *msgWndId)
HRESULT GetFirstSelectedMessageID ([out, retval] LONG *msgId)
HRESULT GetFirstToolbarID ([out, retval] LONG *toolbarId)
HRESULT GetID ([out, retval] LONG *id)
HRESULT GetMenu ([in] LONG index,[out, retval] IOEMenu **menu)
HRESULT GetMenuItem ([in] LONG itemId,[out, retval] IOEMenuItem **item)
HRESULT GetMsgWnd ([in] LONG msgWndId,[out, retval] IOEMsgWnd **msgWnd)
HRESULT GetMsgWndMenu ([in] WNDSTYLE wndStyle,[in] LONG index,[out, retval] IOEMenu **menu)
HRESULT GetMsgWndMenuItem ([in] WNDSTYLE wndStyle,[in] LONG itemId,[out, retval] IOEMenuItem **item)
HRESULT GetNextMenuItemID ([out, retval] LONG *itemId)
HRESULT GetNextMsgWndID ([out, retval] LONG *msgWndId)
HRESULT GetNextSelectedMessageID ([out, retval] LONG *msgId)
HRESULT GetNextToolbarID ([out, retval] LONG *toolbarId)
HRESULT GetOEMainWindow ([out, retval] LONG *wndHandle)
HRESULT GetOEToolbar ([out, retval] IOEToolbar **newToolbar)
HRESULT GetOEToolbarInMsgWnd ([in] WNDSTYLE wndStyle,[out, retval] IOEToolbar **newToolbar)
HRESULT GetSelectedFolderID ([out, retval] LONG *selFolderId)
HRESULT GetToolbar ([in] long toolbarId,[out, retval] IOEToolbar **newToolbar)
HRESULT IsAnyMessageSelected ([out, retval] BOOL *)
HRESULT OpenCurrentMessage ()
HRESULT RemoveAllMenuItems ()
HRESULT RemoveAllToolbars ()
HRESULT SendAndReceiveMessages ()
HRESULT SendKey ([in] LONG keyCode,[in] LONG controlCode,[in] BOOL setForeground)
HRESULT SendMessage ([in] LONG folderId,[in] LONG msgId)
HRESULT SetSelectedFolderID ([in] LONG selFolderId)
HRESULT SetSelectedMessageID ([in] LONG msgId)

Member Function Documentation

HRESULT OEAPI::IOEAPIObj::AddSelectedMessageID ( [in] LONG  msgId  ) 

Only in Enterprise Edition.
Add a message by id to the current selection. After calling this function, the previous selection is kept and msgId is added to the selection.

HRESULT OEAPI::IOEAPIObj::ComposeMessage (  ) 

Only in Enterprise Edition.
Open a new message window to compose a message. Equivalent to press 'Create Mail' button.

HRESULT OEAPI::IOEAPIObj::CreateToolbar ( [out, retval] IOEToolbar **  newToolbar  ) 

Create a toolbar.

HRESULT OEAPI::IOEAPIObj::CreateToolbarInMsgWnd ( [in] WNDSTYLE  wndStyle,
[out, retval] IOEToolbar **  newToolbar 
)

Only in Enterprise Edition.
Create a toolbar in msg wnd.
It will appear when the user creates / replies / forwards / double clicks an email
depending on the wndStyle parameter.

HRESULT OEAPI::IOEAPIObj::GetActiveMsgWndID ( [out, retval] LONG *  msgWndId  ) 

Only in Enterprise Edition.
Get the msg wnd id of the msg wnd that is in the front of the screen.
The returned msg wnd could be the msg wnd of the main window.

HRESULT OEAPI::IOEAPIObj::GetCurrentMessageID ( [out, retval] LONG *  msgId  ) 

Only in Enterprise Edition.
Get the current message id of the current folder. Current message is displayed in OE's Preview Pane.

HRESULT OEAPI::IOEAPIObj::GetFirstMenuItemID ( [out, retval] LONG *   ) 

Get first menu item's id created in this OEAPIObj. If you use GetMenu and then create the items, you can list the items using this functions too.

HRESULT OEAPI::IOEAPIObj::GetFirstMsgWndID ( [out, retval] LONG *  msgWndId  ) 

Only in Enterprise Edition.
Get the first msg window id of the OEAPIObj.

HRESULT OEAPI::IOEAPIObj::GetFirstSelectedMessageID ( [out, retval] LONG *  msgId  ) 

Only in Enterprise Edition.
Get the first selected message's id in the current folder.
Returns -1 if the selected folder is not local.

HRESULT OEAPI::IOEAPIObj::GetFirstToolbarID ( [out, retval] LONG *  toolbarId  ) 

Get the first toolbar's id of the OEAPIObj.

HRESULT OEAPI::IOEAPIObj::GetID ( [out, retval] LONG *  id  ) 

Get the id.

HRESULT OEAPI::IOEAPIObj::GetMenu ( [in] LONG  index,
[out, retval] IOEMenu **  menu 
)

Get a menu by index.

HRESULT OEAPI::IOEAPIObj::GetMenuItem ( [in] LONG  itemId,
[out, retval] IOEMenuItem **  item 
)

Get the menu item object.

HRESULT OEAPI::IOEAPIObj::GetMsgWnd ( [in] LONG  msgWndId,
[out, retval] IOEMsgWnd **  msgWnd 
)

Only in Enterprise Edition.
Get the message window by id.
NOTE: While you keep the OEMsgWnd object, the real Message Window cannot be destroyed. If the user closes the window, it will be kept locked until you release the object.

HRESULT OEAPI::IOEAPIObj::GetMsgWndMenu ( [in] WNDSTYLE  wndStyle,
[in] LONG  index,
[out, retval] IOEMenu **  menu 
)

Get a msg wnd menu by index.

HRESULT OEAPI::IOEAPIObj::GetMsgWndMenuItem ( [in] WNDSTYLE  wndStyle,
[in] LONG  itemId,
[out, retval] IOEMenuItem **  item 
)

Get the menu item object.

HRESULT OEAPI::IOEAPIObj::GetNextMenuItemID ( [out, retval] LONG *  itemId  ) 

Get next menu item's id created in this OEAPIObj.

HRESULT OEAPI::IOEAPIObj::GetNextMsgWndID ( [out, retval] LONG *  msgWndId  ) 

Only in Enterprise Edition.
Get next msg wnd id of the OEAPIObj.
It returns -1 when finished.

HRESULT OEAPI::IOEAPIObj::GetNextSelectedMessageID ( [out, retval] LONG *  msgId  ) 

Only in Enterprise Edition.
Get the next selected message's id in the current folder. If no more selected messages it returns -1.

HRESULT OEAPI::IOEAPIObj::GetNextToolbarID ( [out, retval] LONG *  toolbarId  ) 

Get the next toolbar's id of the OEAPIObj.
It returns -1 when finished.

HRESULT OEAPI::IOEAPIObj::GetOEMainWindow ( [out, retval] LONG *  wndHandle  ) 

Get the handle of OE's main window.

HRESULT OEAPI::IOEAPIObj::GetOEToolbar ( [out, retval] IOEToolbar **  newToolbar  ) 

Get Outlook Express' toolbar.

HRESULT OEAPI::IOEAPIObj::GetOEToolbarInMsgWnd ( [in] WNDSTYLE  wndStyle,
[out, retval] IOEToolbar **  newToolbar 
)

Only in Enterprise Edition.
Get the OE toolbar in msg wnd.
It will appear when the user creates / replies / forwards / double clicks an email
depending on the wndStyle parameter.

HRESULT OEAPI::IOEAPIObj::GetSelectedFolderID ( [out, retval] LONG *  selFolderId  ) 

Only in Enterprise Edition.
Get the selected folder's id.

HRESULT OEAPI::IOEAPIObj::GetToolbar ( [in] long  toolbarId,
[out, retval] IOEToolbar **  newToolbar 
)

Get toolbar of the OEAPIObj by id.

HRESULT OEAPI::IOEAPIObj::IsAnyMessageSelected ( [out, retval] BOOL *   ) 

Only in Enterprise Edition.
Returns TRUE if there is any message selected in the messages' listview.
NOTE: This function returns valid values even if a Hotmail or an IMAP folder is selected.

HRESULT OEAPI::IOEAPIObj::OpenCurrentMessage (  ) 

Only in Enterprise Edition.
Display current message in a new window. Equivalent to double-click the message.
Current message is displayed in OE's Preview Pane.

HRESULT OEAPI::IOEAPIObj::RemoveAllMenuItems (  ) 

Remove all the menu items created with this object or any OEMenu obtained using GetMenu in this object.

HRESULT OEAPI::IOEAPIObj::RemoveAllToolbars (  ) 

Remove all the toolbars created with this object.

HRESULT OEAPI::IOEAPIObj::SendAndReceiveMessages (  ) 

Send messages in Outbox folder and receive pending messages in server.
Equivalent to press 'Send/Receive' button, except that it does not display the progress dialog.

HRESULT OEAPI::IOEAPIObj::SendKey ( [in] LONG  keyCode,
[in] LONG  controlCode,
[in] BOOL  setForeground 
)

Send a Key to OE main window.
keyCode contains the code of the key and controlCode the control combination (e.g.: VK_CONTROL).
If setForeground is TRUE, the window is set as foreground window before sending the key.

HRESULT OEAPI::IOEAPIObj::SendMessage ( [in] LONG  folderId,
[in] LONG  msgId 
)

While OE/WM is running, makes a copy of the the specified message in the Outbox folder, and modifies this copy to be able to be sent.

HRESULT OEAPI::IOEAPIObj::SetSelectedFolderID ( [in] LONG  selFolderId  ) 

Only in Enterprise Edition.
Select folder by id.

HRESULT OEAPI::IOEAPIObj::SetSelectedMessageID ( [in] LONG  msgId  ) 

Only in Enterprise Edition.
Set the next selected message by id in the current folder. This function clears the previous selection. After calling this function, only msgId will be selected.
This function also changes the current message.



Developed by Nektra