Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: mail ::

unpublished interface XMailService
Usage Restrictions
not published
Description
Represents a mail server abstraction.
Since
OOo 2.0

Methods' Summary
getSupportedConnectionTypes Returns all connection types which are supported to connect to the mail service. At least support insecure connections must be supported. Currently defined connection types are (the values should be handled case insensitive): "Insecure" - insecure connections "Ssl" - Secure Socket Layer 2.0/3.0 based connection  
addConnectionListener Register a connection listener.  
removeConnectionListener Unregister a connection listener.  
getCurrentConnectionContext Return the context of the current connnection. The context contains information like the server name, port, connection type etc. @precond isConnected returns true.  
connect Connect to a mail service. Only one connection to a mail service can be established at a time.  
disconnect Disconnect from a mail service.  
isConnected Returns whether a connection to a mail service currently exist or not.  
Methods' Details
getSupportedConnectionTypes
sequence< string >
getSupportedConnectionTypes();

Description
Returns all connection types which are supported to connect to the mail service. At least support insecure connections must be supported. Currently defined connection types are (the values should be handled case insensitive): "Insecure" - insecure connections "Ssl" - Secure Socket Layer 2.0/3.0 based connection
Returns
a sequence of supported connection types.
addConnectionListener
void
addConnectionListener( [in] XConnectionListener  xListener );

Description
Register a connection listener.
Parameter xListener
[in] a listener that will be informed about connection events.
See also
XConnectionListener
removeConnectionListener
void
removeConnectionListener( [in] XConnectionListener  xListener );

Description
Unregister a connection listener.
Parameter xListener
[in] a listener that no longer need to be informed about connection events.
See also
XConnectionListener
getCurrentConnectionContext
::com::sun::star::uno::XCurrentContext
getCurrentConnectionContext()
raises( ::com::sun::star::io::NotConnectedException );

Description
Return the context of the current connnection. The context contains information like the server name, port, connection type etc. @precond isConnected returns true.
Returns
the current connection context.
Throws
com::sun::star::io::NotConnectedException if no connection is currently established.
See also
com::sun::star::mail::connectUser, ::com::sun::star::io::NotConnectedException
connect
void
connect( [in] ::com::sun::star::uno::XCurrentContext  xConnectionContext,
[in] XAuthenticator  xAuthenticator )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::AlreadyConnectedException,
::com::sun::star::io::UnknownHostException,
::com::sun::star::io::NoRouteToHostException,
::com::sun::star::io::ConnectException,
::com::sun::star::auth::AuthenticationFailedException,
MailException );

Description
Connect to a mail service. Only one connection to a mail service can be established at a time.
Parameter 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 getSupportedConnectionTypes.
  • Timeout of type 'long' (Optional). Specifies a timeout in seconds for blocking operations, like the connection attempt.
Parameter 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, a wrong server name, an unreachable DNS server, etc.
Throws
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.
Throws
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.
Throws
com::sun::star::auth::AuthenticationException if the specified user could not be logged in.
Throws
com::sun::star::mail::MailException for other errors during login.
See also
::com::sun::star::uno::XCurrentContext, XAuthenticator, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::AlreadyConnectedException, ::com::sun::star::io::UnknownHostException, ::com::sun::star::io::NoRouteToHostException, ::com::sun::star::io::ConnectException, com::sun::star::auth::AuthenticationException, com::sun::star::mail::IllegalStateException, MailException
disconnect
void
disconnect()
raises( MailException );

Description
Disconnect from a mail service.
Throws
com::sun::star::mail::MailException if errors occur during disconnecting.
isConnected
boolean
isConnected();

Description
Returns whether a connection to a mail service currently exist or not.
Returns
true if a connection to a mail service is established.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.