Author: arielch
Date: Wed Jan 25 08:36:47 2012
New Revision: 1235679
URL: http://svn.apache.org/viewvc?rev=1235679&view=rev
Log:
i118814 - Allow set timeout in Mail API
Modified:
incubator/ooo/trunk/main/offapi/com/sun/star/mail/XMailService.idl
Modified: incubator/ooo/trunk/main/offapi/com/sun/star/mail/XMailService.idl
URL:
http://svn.apache.org/viewvc/incubator/ooo/trunk/main/offapi/com/sun/star/mail/XMailService.idl?rev=1235679&r1=1235678&r2=1235679&view=diff
==============================================================================
--- incubator/ooo/trunk/main/offapi/com/sun/star/mail/XMailService.idl
(original)
+++ incubator/ooo/trunk/main/offapi/com/sun/star/mail/XMailService.idl Wed Jan
25 08:36:47 2012
@@ -135,30 +135,45 @@ interface XMailService: ::com::sun::star
*/
com::sun::star::uno::XCurrentContext getCurrentConnectionContext()
raises(com::sun::star::io::NotConnectedException);
-
+
/**
Connect to a mail service. Only one connection to a mail service
can be established at a time.
-
+
@param xConnectionContext
[in] an interface used to query for connection related information.
The context must contain the following values:
- "ServerName" of type 'string', "Port" of type 'long', "ConnectionType"
- of type 'string'. A list of supported connection types can be queried
- using <code>getSupportedConnectionTypes</code>.
-
+ <ul>
+ <li>
+ <b>ServerName</b> of type 'string'.
+ </li>
+ <li>
+ <b>Port</b> of type 'long'.
+ </li>
+ <li>
+ <b>ConnectionType</b> of type 'string'.
+ A list of supported connection types can be queried using
+ <member>getSupportedConnectionTypes</member>.
+ </li>
+ <li>
+ <b>Timeout</b> of type 'long' (Optional).
+ Specifies a timeout in seconds for blocking operations,
+ like the connection attempt.
+ </li>
+ </ul>
+
@param xAuthenticator
[in] an interface used to query for the necessary user information
needed to login to the mail server. If no authentication is required
the xAuthenticator must return an empty user name and an empty
password.
-
+
@throws com::sun::star::lang::IllegalArgumentException
if the provided connection context contains invalid values or
misses required connection parameters.
-
+
@throws com::sun::star::io::AlreadyConnectedException
on a try to connect to an already connect mail server.
-
+
@throws com::sun::star::io::UnknownHostException
usually if the IP address of the mail server could not be
determined. Possible causes are a broken network connection,
