OEAPI::IOEMsgWnd Interface Reference

List of all members.

Public Member Functions

HRESULT CancelSend ()
HRESULT GetBcc ([out, retval] BSTR *address)
HRESULT GetBody ([out, retval] BSTR *body)
HRESULT GetBodyLength ([out, retval] LONG *length)
HRESULT GetCc ([out, retval] BSTR *address)
HRESULT GetID ([out, retval] LONG *Id)
HRESULT GetIHTMLDocument2 ([out, retval] IDispatch **html)
HRESULT GetMenu ([in] LONG menuIdx,[out, retval] IOEMenu **newMenu)
HRESULT GetMenuItem ([in] LONG itemId,[out, retval] IOEMenuItem **item)
HRESULT GetSubject ([out, retval] BSTR *subject)
HRESULT GetTo ([out, retval] BSTR *address)
HRESULT GetToolbar ([in] LONG toolbarId,[out, retval] IOEToolbar **newToolbar)
HRESULT GetToolbarByIndex ([in] LONG toolbarIndex,[out, retval] IOEToolbar **newToolbar)
HRESULT GetWndStyle ([out, retval] WNDSTYLE *wndStyle)
HRESULT SendKey ([in] LONG keyCode,[in] LONG controlCode,[in] BOOL setForeground)
HRESULT SendMail ()
HRESULT SetBcc ([in] BSTR address)
HRESULT SetBody ([in] BSTR *body)
HRESULT SetBodyHTML ([in] BSTR *body)
HRESULT SetCc ([in] BSTR address)
HRESULT SetSubject ([in] BSTR subject)
HRESULT SetTo ([in] BSTR address)

Detailed Description

Only in Enterprise Edition.


Member Function Documentation

HRESULT OEAPI::IOEMsgWnd::CancelSend (  ) 

Cancel send process of the message window.
This function should be called inside the event IOEAPIObjEvents::OnSendButtonMsgWndClicked to cancel the 'Send' action started by the user or by the code.
After calling this function other handlers of the event are not called and the message is not sent.

HRESULT OEAPI::IOEMsgWnd::GetBcc ( [out, retval] BSTR *  address  ) 

Get the 'Bcc' address list of the message.

HRESULT OEAPI::IOEMsgWnd::GetBody ( [out, retval] BSTR *  body  ) 

Get the body of the message part of the window.

HRESULT OEAPI::IOEMsgWnd::GetBodyLength ( [out, retval] LONG *  length  ) 

Get the body length of the message part of the window in characters not including the NULL termination.

HRESULT OEAPI::IOEMsgWnd::GetCc ( [out, retval] BSTR *  address  ) 

Get the 'Cc' address list of the message.

HRESULT OEAPI::IOEMsgWnd::GetID ( [out, retval] LONG *  Id  ) 

Get the message window's id.

HRESULT OEAPI::IOEMsgWnd::GetIHTMLDocument2 ( [out, retval] IDispatch **  html  ) 

Get IHTMLDocument2 interface of this message window.
Only in Enterprise Edition.
NOTE: This is an experimental feature.
IMPORTANT: We do not offer support about IHTMLDocument2. It's supported on Microsoft's Newsgroups.

HRESULT OEAPI::IOEMsgWnd::GetMenu ( [in] LONG  menuIdx,
[out, retval] IOEMenu **  newMenu 
)

Get message window's menu by index.

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

Get message window's menu item by id.

HRESULT OEAPI::IOEMsgWnd::GetSubject ( [out, retval] BSTR *  subject  ) 

Get the message's subject. Not implemented for OE_CURRENT_MSG_WND windows.

HRESULT OEAPI::IOEMsgWnd::GetTo ( [out, retval] BSTR *  address  ) 

Get the 'To' address list of the message.

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

Get message window's toolbar by id.

HRESULT OEAPI::IOEMsgWnd::GetToolbarByIndex ( [in] LONG  toolbarIndex,
[out, retval] IOEToolbar **  newToolbar 
)

Get message window's toolbar by index.

HRESULT OEAPI::IOEMsgWnd::GetWndStyle ( [out, retval] WNDSTYLE wndStyle  ) 

Get the window style.

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

Send a Key to the message 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. Not implemented for OE_CURRENT_MSG_WND windows. Use IOEAPIObj::SendKey instead.

HRESULT OEAPI::IOEMsgWnd::SendMail (  ) 

Press the 'Send' button of the window.
Only valid for windows with wnd style different than OE_MSG_DETAIL_WND.
NOTE: This function it's just like pressing the button. If the email has any mistakes (E.G. Missing destination), it will not be sent. Not implemented for OE_CURRENT_MSG_WND windows.

HRESULT OEAPI::IOEMsgWnd::SetBcc ( [in] BSTR  address  ) 

Set the 'Bcc' address list of the message.

HRESULT OEAPI::IOEMsgWnd::SetBody ( [in] BSTR *  body  ) 

Set the body of the message part of the window.
NOTE: Doesn't work if OE/WM is configured to show messages as plain text.

HRESULT OEAPI::IOEMsgWnd::SetBodyHTML ( [in] BSTR *  body  ) 

Set the body of the message part of the window.
This function works as the SetBody function but it sets the body in a different way. This function is recommended if you want to modify an outgoing message because some mail clients experience problems showing html messages set with the SetBody function.
NOTE: Doesn't work if OE/WM is configured to show messages as plain text.

HRESULT OEAPI::IOEMsgWnd::SetCc ( [in] BSTR  address  ) 

Set the 'Cc' address list of the message.

HRESULT OEAPI::IOEMsgWnd::SetSubject ( [in] BSTR  subject  ) 

Set the message's subject. Not implemented for OE_CURRENT_MSG_WND windows.

HRESULT OEAPI::IOEMsgWnd::SetTo ( [in] BSTR  address  ) 

Set the 'To' address list of the message.



Developed by Nektra