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 XMailServer
Usage Restrictions
not published
Description
Represents a mail server abstraction.
Since
OOo 2.0
See also
XMailMessage

Methods' Summary
getSupportedConnectionTypes Returns all connection types which are supported by the mail server. Possible connection types are for instance secure connections like 'SSL' or 'TLS'.  
setConnectionType Set the connection type that will be used to connect to the mail server. The supported connection types may be queried using getSupportedConnectionTypes(). If no connection types has explicitly been set the default connection type will be used.  
isConnectionTypeSupported Allow a client to query if a certain connection type is supported.  
addConnectionListener Register a connection listener.  
removeConnectionListener Unregister a connection listener.  
connectUser 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.  
disconnectUser Logoff the currently logged in user.  
isUserConnected Returns whether a user is currently logged in to the mail server or not.  
sendMailMessage Send a mail message to its recipients.  
Attributes' Summary
Name The complete domain name of the mail server.  
Port 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.  
Methods' Details
getSupportedConnectionTypes
sequence< string >
getSupportedConnectionTypes();

Description
Returns all connection types which are supported by the mail server. Possible connection types are for instance secure connections like 'SSL' or 'TLS'.
Returns
a sequence of supported connection types.
setConnectionType
void
setConnectionType( [in] string  sConnectionType )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Set the connection type that will be used to connect to the mail server. The supported connection types may be queried using getSupportedConnectionTypes(). If no connection types has explicitly been set the default connection type will be used.
Parameter sConnectionType
[in] identifies the connection that should be used to connect to the mail server.
Throws
com::sun::star::lang::IllegalArgumentException if the provided connection type is not supported.
See also
getSupportedConnectionTypes, isConnectionTypeSupported
isConnectionTypeSupported
boolean
isConnectionTypeSupported( [in] string  sConnectionType );

Description
Allow a client to query if a certain connection type is supported.
Parameter sConnectionType
[in] query if a certain connection type is supported.
Returns
true if the specified connection type is supported.
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
connectUser
void
connectUser( [in] XAuthenticator  xAuthenticator )
raises( ::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
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.
Parameter xAuthenticator
[in] an interface used to query for the necessary user information needed to login to the mail server.
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::IllegalStateException if a user is currently logged in.
Throws
com::sun::star::mail::MailException for other errors during login.
See also
XAuthenticator, ::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
disconnectUser
void
disconnectUser()
raises( MailException );

Description
Logoff the currently logged in user.
Throws
com::sun::star::mail::MessagingException if errors occur during logoff.
isUserConnected
boolean
isUserConnected();

Description
Returns whether a user is currently logged in to the mail server or not.
Returns
true if a user is currently logged in to the mail server.
sendMailMessage
void
sendMailMessage( [in] XMailMessage  xMailMessage )
raises( ::com::sun::star::io::NotConnectedException,
SendMailMessageFailedException,
MailException,
::com::sun::star::datatransfer::UnsupportedFlavorException );

Description
Send a mail message to its recipients.
Throws
com::sun::star::io::NotConnectedException if no user is currently connected to the mail server.
Throws
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 RFC 822.
Throws
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.
Throws
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.
See also
com::sun::star::io::NotConnectedExceptionException, SendMailMessageFailedException, MailException, ::com::sun::star::datatransfer::UnsupportedFlavorException
Attributes' Details
Name
[ readonly ] string Name;
Description
The complete domain name of the mail server.
Port
long Port;
Description
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.
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.