<html> <head> <title>Interface XMailServer</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XMailServer-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">mail</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XMailServer</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Represents a mail server abstraction. </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd><a href="XMailMessage.html">XMailMessage</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedConnectionTypes">getSupportedConnectionTypes</a></td> <td class="imsum_right">Returns all connection types which are supported by the mail server. Possible connection types are for instance secure connections like 'SSL' or 'TLS'. </td> </tr> <tr> <td class="imsum_left"><a href="#setConnectionType">setConnectionType</a></td> <td class="imsum_right">Set the connection type that will be used to connect to the mail server. The supported connection types may be queried using <code>getSupportedConnectionTypes()</code>. If no connection types has explicitly been set the default connection type will be used. </td> </tr> <tr> <td class="imsum_left"><a href="#isConnectionTypeSupported">isConnectionTypeSupported</a></td> <td class="imsum_right">Allow a client to query if a certain connection type is supported. </td> </tr> <tr> <td class="imsum_left"><a href="#addConnectionListener">addConnectionListener</a></td> <td class="imsum_right">Register a connection listener. </td> </tr> <tr> <td class="imsum_left"><a href="#removeConnectionListener">removeConnectionListener</a></td> <td class="imsum_right">Unregister a connection listener. </td> </tr> <tr> <td class="imsum_left"><a href="#connectUser">connectUser</a></td> <td class="imsum_right">Login a user to the mail server. Only one user may logged in at a time. An attempt to login while another user is logged in causes an exception to be thrown. </td> </tr> <tr> <td class="imsum_left"><a href="#disconnectUser">disconnectUser</a></td> <td class="imsum_right">Logoff the currently logged in user. </td> </tr> <tr> <td class="imsum_left"><a href="#isUserConnected">isUserConnected</a></td> <td class="imsum_right">Returns whether a user is currently logged in to the mail server or not. </td> </tr> <tr> <td class="imsum_left"><a href="#sendMailMessage">sendMailMessage</a></td> <td class="imsum_right">Send a mail message to its recipients. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getSupportedConnectionTypes" class="membertitle">getSupportedConnectionTypes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getSupportedConnectionTypes</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns all connection types which are supported by the mail server. Possible connection types are for instance secure connections like 'SSL' or 'TLS'. </dd> <dt><b>Returns</b></dt> <dd>a sequence of supported connection types. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setConnectionType" class="membertitle">setConnectionType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setConnectionType</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sConnectionType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set the connection type that will be used to connect to the mail server. The supported connection types may be queried using <code>getSupportedConnectionTypes()</code>. If no connection types has explicitly been set the default connection type will be used. </dd> <dt><b>Parameter sConnectionType</b></dt> <dd>[in] identifies the connection that should be used to connect to the mail server. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the provided connection type is not supported. </dd> <dt><b>See also</b></dt> <dd><a href="#getSupportedConnectionTypes">getSupportedConnectionTypes</a>, <a href="#isConnectionTypeSupported">isConnectionTypeSupported</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isConnectionTypeSupported" class="membertitle">isConnectionTypeSupported</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isConnectionTypeSupported</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sConnectionType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Allow a client to query if a certain connection type is supported. </dd> <dt><b>Parameter sConnectionType</b></dt> <dd>[in] query if a certain connection type is supported. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the specified connection type is supported. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addConnectionListener" class="membertitle">addConnectionListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addConnectionListener</b>(</td> <td valign="top">[in] <a href="XConnectionListener.html">XConnectionListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Register a connection listener. </dd> <dt><b>Parameter xListener</b></dt> <dd>[in] a listener that will be informed about connection events. </dd> <dt><b>See also</b></dt> <dd><a href="XConnectionListener.html">XConnectionListener</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeConnectionListener" class="membertitle">removeConnectionListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeConnectionListener</b>(</td> <td valign="top">[in] <a href="XConnectionListener.html">XConnectionListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Unregister a connection listener. </dd> <dt><b>Parameter xListener</b></dt> <dd>[in] a listener that no longer need to be informed about connection events. </dd> <dt><b>See also</b></dt> <dd><a href="XConnectionListener.html">XConnectionListener</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="connectUser" class="membertitle">connectUser</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>connectUser</b>(</td> <td valign="top">[in] <a href="XAuthenticator.html">XAuthenticator</a></td> <td valign="bottom"> xAuthenticator )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/AlreadyConnectedException.html">AlreadyConnectedException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/UnknownHostException.html">UnknownHostException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/NoRouteToHostException.html">NoRouteToHostException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/ConnectException.html">ConnectException</a>,<br> ::com::sun::star::<a href="../auth/module-ix.html">auth</a>::<a href="../auth/AuthenticationFailedException.html">AuthenticationFailedException</a>,<br> <a href="MailException.html">MailException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Login a user to the mail server. Only one user may logged in at a time. An attempt to login while another user is logged in causes an exception to be thrown. </dd> <dt><b>Parameter xAuthenticator</b></dt> <dd>[in] an interface used to query for the necessary user information needed to login to the mail server. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::AlreadyConnectedException on a try to connect to an already connect mail server. </dd> <dt><b>Throws</b></dt> <dd>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, a wrong server name, an unreachable DNS server, etc. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::NoRouteToHostException if an error occured to connect to the remote mail server. Typically the remote mail server cannot be reach because of an intervening firewall, or if an intermediate router is down, the network connection is broken, etc. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::ConnectException if an error occured while attempting to connect to the remote mail server. Typically the connection was refused remotely, because the mail server is not listening on the remote address/port. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::auth::AuthenticationException if the specified user could not be logged in. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::mail::IllegalStateException if a user is currently logged in. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::mail::MailException for other errors during login. </dd> <dt><b>See also</b></dt> <dd><a href="XAuthenticator.html">XAuthenticator</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/AlreadyConnectedException.html">AlreadyConnectedException</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/UnknownHostException.html">UnknownHostException</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/NoRouteToHostException.html">NoRouteToHostException</a>, ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/ConnectException.html">ConnectException</a>, com::sun::star::auth::AuthenticationException, com::sun::star::mail::IllegalStateException, <a href="MailException.html">MailException</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="disconnectUser" class="membertitle">disconnectUser</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>disconnectUser</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MailException.html">MailException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Logoff the currently logged in user. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::mail::MessagingException if errors occur during logoff. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isUserConnected" class="membertitle">isUserConnected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isUserConnected</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns whether a user is currently logged in to the mail server or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if a user is currently logged in to the mail server. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="sendMailMessage" class="membertitle">sendMailMessage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>sendMailMessage</b>(</td> <td valign="top">[in] <a href="XMailMessage.html">XMailMessage</a></td> <td valign="bottom"> xMailMessage )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/NotConnectedException.html">NotConnectedException</a>,<br> <a href="SendMailMessageFailedException.html">SendMailMessageFailedException</a>,<br> <a href="MailException.html">MailException</a>,<br> ::com::sun::star::<a href="../datatransfer/module-ix.html">datatransfer</a>::<a href="../datatransfer/UnsupportedFlavorException.html">UnsupportedFlavorException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Send a mail message to its recipients. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::NotConnectedException if no user is currently connected to the mail server. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::mail::SendMailMessageFailedException if the message could not be sent because of invalid recipient addresses. The e-mail addresses of recipients have to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::mail::MailException is thrown on other errors that may happen during sending. A possible reason may be for instance that a file attachment specified in a mail message could not be found or accessed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::datatransfer::UnsupportedFlavorException is thrown when the body of the mail message is provided in an unsupported mime content type or may be thrown if one of the file attachments specifies an unspupported mime content type. </dd> <dt><b>See also</b></dt> <dd>com::sun::star::io::NotConnectedExceptionException, <a href="SendMailMessageFailedException.html">SendMailMessageFailedException</a>, <a href="MailException.html">MailException</a>, ::com::sun::star::<a href="../datatransfer/module-ix.html">datatransfer</a>::<a href="../datatransfer/UnsupportedFlavorException.html">UnsupportedFlavorException</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Name">Name</a></td> <td class="imsum_right">The complete domain name of the mail server. </td> </tr> <tr> <td class="imsum_left"><a href="#Port">Port</a></td> <td class="imsum_right">The port number that will be used to connect to the mail server. If no port number has been set the default port number 25 will be used. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>Name</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The complete domain name of the mail server. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Port" class="membertitle">Port</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>Port</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>The port number that will be used to connect to the mail server. If no port number has been set the default port number 25 will be used. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4227
