| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_mail_XMailServer_idl__ |
| #define __com_sun_star_mail_XMailServer_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_mail_XAuthenticator_idl__ |
| #include <com/sun/star/mail/XAuthenticator.idl> |
| #endif |
| |
| #ifndef __com_sun_star_mail_XMailMessage_idl__ |
| #include <com/sun/star/mail/XMailMessage.idl> |
| #endif |
| |
| #ifndef __com_sun_star_auth_AuthenticationFailedException_idl__ |
| #include <com/sun/star/auth/AuthenticationFailedException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_AlreadyConnectedException_idl__ |
| #include <com/sun/star/io/AlreadyConnectedException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_NotConnectedException_idl__ |
| #include <com/sun/star/io/NotConnectedException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_UnknownHostException_idl__ |
| #include <com/sun/star/io/UnknownHostException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_NoRouteToHostException_idl__ |
| #include <com/sun/star/io/NoRouteToHostException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_ConnectException_idl__ |
| #include <com/sun/star/io/ConnectException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ucb_InteractiveIOException_idl__ |
| #include <com/sun/star/ucb/InteractiveIOException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_mail_MailException_idl__ |
| #include <com/sun/star/mail/MailException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_mail_SendMailMessageFailedException_idl__ |
| #include <com/sun/star/mail/SendMailMessageFailedException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_mail_XConnectionListener_idl__ |
| #include <com/sun/star/mail/XConnectionListener.idl> |
| #endif |
| |
| #ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__ |
| #include <com/sun/star/datatransfer/UnsupportedFlavorException.idl> |
| #endif |
| |
| module com { module sun { module star { module mail { |
| |
| /** |
| Represents a mail server abstraction. |
| |
| @see com::sun::star::mail::XMailMessage |
| |
| @since OpenOffice 2.0 |
| */ |
| interface XMailServer: ::com::sun::star::uno::XInterface { |
| |
| /** |
| The complete domain name of the mail server. |
| */ |
| [attribute, readonly] string Name; |
| |
| /** |
| 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. |
| */ |
| [attribute] long Port; |
| |
| /** |
| 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. |
| */ |
| sequence<string> getSupportedConnectionTypes(); |
| |
| /** |
| 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. |
| |
| @param 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 getSupportedConnectionTypes |
| @see isConnectionTypeSupported |
| */ |
| void setConnectionType([in] string sConnectionType) |
| raises (com::sun::star::lang::IllegalArgumentException); |
| |
| /** |
| Allow a client to query if a certain connection type is |
| supported. |
| |
| @param sConnectionType |
| [in] query if a certain connection type is supported. |
| |
| @returns |
| <TRUE/> if the specified connection type is supported. |
| */ |
| boolean isConnectionTypeSupported([in] string sConnectionType); |
| |
| /** |
| Register a connection listener. |
| |
| @param xListener |
| [in] a listener that will be informed about connection events. |
| |
| @see com::sun::star::mail::XConnectionListener |
| */ |
| void addConnectionListener([in] XConnectionListener xListener); |
| |
| /** |
| Unregister a connection listener. |
| |
| @param xListener |
| [in] a listener that no longer need to be informed about connection events. |
| |
| @see com::sun::star::mail::XConnectionListener |
| */ |
| void removeConnectionListener([in] XConnectionListener xListener); |
| |
| /** |
| 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. |
| |
| @param 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 com::sun::star::mail::XAuthenticator |
| @see com::sun::star::io::AlreadyConnectedException |
| @see com::sun::star::io::UnknownHostException |
| @see com::sun::star::io::NoRouteToHostException |
| @see com::sun::star::io::ConnectException |
| @see com::sun::star::auth::AuthenticationException |
| @see com::sun::star::mail::IllegalStateException |
| @see com::sun::star::mail::MailException |
| */ |
| 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, |
| com::sun::star::mail::MailException); |
| |
| /** |
| Logoff the currently logged in user. |
| |
| @throws com::sun::star::mail::MessagingException |
| if errors occur during logoff. |
| */ |
| void disconnectUser() |
| raises(com::sun::star::mail::MailException); |
| |
| /** |
| 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. |
| */ |
| boolean isUserConnected(); |
| |
| /** |
| 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 |
| <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. |
| |
| @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 com::sun::star::io::NotConnectedExceptionException |
| @see com::sun::star::mail::SendMailMessageFailedException |
| @see com::sun::star::mail::MailException |
| @see com::sun::star::datatransfer::UnsupportedFlavorException |
| */ |
| void sendMailMessage([in] XMailMessage xMailMessage) |
| raises(com::sun::star::io::NotConnectedException, com::sun::star::mail::SendMailMessageFailedException, com::sun::star::mail::MailException, com::sun::star::datatransfer::UnsupportedFlavorException); |
| }; |
| |
| }; }; }; }; |
| |
| #endif |
