1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_XMailServer_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_mail_XMailServer_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_XAuthenticator_idl__ 32*b1cdbd2cSJim Jagielski#include <com/sun/star/mail/XAuthenticator.idl> 33*b1cdbd2cSJim Jagielski#endif 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_XMailMessage_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/mail/XMailMessage.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_auth_AuthenticationFailedException_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/auth/AuthenticationFailedException.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_AlreadyConnectedException_idl__ 44*b1cdbd2cSJim Jagielski#include <com/sun/star/io/AlreadyConnectedException.idl> 45*b1cdbd2cSJim Jagielski#endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_NotConnectedException_idl__ 48*b1cdbd2cSJim Jagielski#include <com/sun/star/io/NotConnectedException.idl> 49*b1cdbd2cSJim Jagielski#endif 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_UnknownHostException_idl__ 52*b1cdbd2cSJim Jagielski#include <com/sun/star/io/UnknownHostException.idl> 53*b1cdbd2cSJim Jagielski#endif 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_NoRouteToHostException_idl__ 56*b1cdbd2cSJim Jagielski#include <com/sun/star/io/NoRouteToHostException.idl> 57*b1cdbd2cSJim Jagielski#endif 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_io_ConnectException_idl__ 60*b1cdbd2cSJim Jagielski#include <com/sun/star/io/ConnectException.idl> 61*b1cdbd2cSJim Jagielski#endif 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 64*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 65*b1cdbd2cSJim Jagielski#endif 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_InteractiveIOException_idl__ 68*b1cdbd2cSJim Jagielski#include <com/sun/star/ucb/InteractiveIOException.idl> 69*b1cdbd2cSJim Jagielski#endif 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_MailException_idl__ 72*b1cdbd2cSJim Jagielski#include <com/sun/star/mail/MailException.idl> 73*b1cdbd2cSJim Jagielski#endif 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_SendMailMessageFailedException_idl__ 76*b1cdbd2cSJim Jagielski#include <com/sun/star/mail/SendMailMessageFailedException.idl> 77*b1cdbd2cSJim Jagielski#endif 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_mail_XConnectionListener_idl__ 80*b1cdbd2cSJim Jagielski#include <com/sun/star/mail/XConnectionListener.idl> 81*b1cdbd2cSJim Jagielski#endif 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__ 84*b1cdbd2cSJim Jagielski#include <com/sun/star/datatransfer/UnsupportedFlavorException.idl> 85*b1cdbd2cSJim Jagielski#endif 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module mail { 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski/** 90*b1cdbd2cSJim Jagielski Represents a mail server abstraction. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @see com::sun::star::mail::XMailMessage 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielskiinterface XMailServer: ::com::sun::star::uno::XInterface { 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski /** 99*b1cdbd2cSJim Jagielski The complete domain name of the mail server. 100*b1cdbd2cSJim Jagielski */ 101*b1cdbd2cSJim Jagielski [attribute, readonly] string Name; 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski /** 104*b1cdbd2cSJim Jagielski The port number that will be used to connect to the mail server. 105*b1cdbd2cSJim Jagielski If no port number has been set the default port number 25 will 106*b1cdbd2cSJim Jagielski be used. 107*b1cdbd2cSJim Jagielski */ 108*b1cdbd2cSJim Jagielski [attribute] long Port; 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski /** 111*b1cdbd2cSJim Jagielski Returns all connection types which are supported by the 112*b1cdbd2cSJim Jagielski mail server. Possible connection types are for instance 113*b1cdbd2cSJim Jagielski secure connections like 'SSL' or 'TLS'. 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski @returns 116*b1cdbd2cSJim Jagielski a sequence of supported connection types. 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski sequence<string> getSupportedConnectionTypes(); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski /** 121*b1cdbd2cSJim Jagielski Set the connection type that will be used to connect to the 122*b1cdbd2cSJim Jagielski mail server. The supported connection types may be queried 123*b1cdbd2cSJim Jagielski using <code>getSupportedConnectionTypes()</code>. 124*b1cdbd2cSJim Jagielski If no connection types has explicitly been set the default 125*b1cdbd2cSJim Jagielski connection type will be used. 126*b1cdbd2cSJim Jagielski 127*b1cdbd2cSJim Jagielski @param sConnectionType 128*b1cdbd2cSJim Jagielski [in] identifies the connection that should be used to connect 129*b1cdbd2cSJim Jagielski to the mail server. 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::IllegalArgumentException 132*b1cdbd2cSJim Jagielski if the provided connection type is not supported. 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski @see getSupportedConnectionTypes 135*b1cdbd2cSJim Jagielski @see isConnectionTypeSupported 136*b1cdbd2cSJim Jagielski */ 137*b1cdbd2cSJim Jagielski void setConnectionType([in] string sConnectionType) 138*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IllegalArgumentException); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski /** 141*b1cdbd2cSJim Jagielski Allow a client to query if a certain connection type is 142*b1cdbd2cSJim Jagielski supported. 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski @param sConnectionType 145*b1cdbd2cSJim Jagielski [in] query if a certain connection type is supported. 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski @returns 148*b1cdbd2cSJim Jagielski <TRUE/> if the specified connection type is supported. 149*b1cdbd2cSJim Jagielski */ 150*b1cdbd2cSJim Jagielski boolean isConnectionTypeSupported([in] string sConnectionType); 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski /** 153*b1cdbd2cSJim Jagielski Register a connection listener. 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski @param xListener 156*b1cdbd2cSJim Jagielski [in] a listener that will be informed about connection events. 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski @see com::sun::star::mail::XConnectionListener 159*b1cdbd2cSJim Jagielski */ 160*b1cdbd2cSJim Jagielski void addConnectionListener([in] XConnectionListener xListener); 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski /** 163*b1cdbd2cSJim Jagielski Unregister a connection listener. 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski @param xListener 166*b1cdbd2cSJim Jagielski [in] a listener that no longer need to be informed about connection events. 167*b1cdbd2cSJim Jagielski 168*b1cdbd2cSJim Jagielski @see com::sun::star::mail::XConnectionListener 169*b1cdbd2cSJim Jagielski */ 170*b1cdbd2cSJim Jagielski void removeConnectionListener([in] XConnectionListener xListener); 171*b1cdbd2cSJim Jagielski 172*b1cdbd2cSJim Jagielski /** 173*b1cdbd2cSJim Jagielski Login a user to the mail server. Only one user may logged in 174*b1cdbd2cSJim Jagielski at a time. An attempt to login while another user is logged in 175*b1cdbd2cSJim Jagielski causes an exception to be thrown. 176*b1cdbd2cSJim Jagielski 177*b1cdbd2cSJim Jagielski @param xAuthenticator 178*b1cdbd2cSJim Jagielski [in] an interface used to query for the necessary user information 179*b1cdbd2cSJim Jagielski needed to login to the mail server. 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski @throws com::sun::star::io::AlreadyConnectedException 182*b1cdbd2cSJim Jagielski on a try to connect to an already connect mail server. 183*b1cdbd2cSJim Jagielski 184*b1cdbd2cSJim Jagielski @throws com::sun::star::io::UnknownHostException 185*b1cdbd2cSJim Jagielski usually if the IP address of the mail server could not be 186*b1cdbd2cSJim Jagielski determined. Possible causes are a broken network connection, 187*b1cdbd2cSJim Jagielski a wrong server name, an unreachable DNS server, etc. 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski @throws com::sun::star::io::NoRouteToHostException 190*b1cdbd2cSJim Jagielski if an error occured to connect to the remote mail server. 191*b1cdbd2cSJim Jagielski Typically the remote mail server cannot be reach because of an 192*b1cdbd2cSJim Jagielski intervening firewall, or if an intermediate router is down, 193*b1cdbd2cSJim Jagielski the network connection is broken, etc. 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski @throws com::sun::star::io::ConnectException 196*b1cdbd2cSJim Jagielski if an error occured while attempting to connect to the remote 197*b1cdbd2cSJim Jagielski mail server. Typically the connection was refused remotely, 198*b1cdbd2cSJim Jagielski because the mail server is not listening on the remote address/port. 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski @throws com::sun::star::auth::AuthenticationException 201*b1cdbd2cSJim Jagielski if the specified user could not be logged in. 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski @throws com::sun::star::mail::IllegalStateException 204*b1cdbd2cSJim Jagielski if a user is currently logged in. 205*b1cdbd2cSJim Jagielski 206*b1cdbd2cSJim Jagielski @throws com::sun::star::mail::MailException 207*b1cdbd2cSJim Jagielski for other errors during login. 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski @see com::sun::star::mail::XAuthenticator 210*b1cdbd2cSJim Jagielski @see com::sun::star::io::AlreadyConnectedException 211*b1cdbd2cSJim Jagielski @see com::sun::star::io::UnknownHostException 212*b1cdbd2cSJim Jagielski @see com::sun::star::io::NoRouteToHostException 213*b1cdbd2cSJim Jagielski @see com::sun::star::io::ConnectException 214*b1cdbd2cSJim Jagielski @see com::sun::star::auth::AuthenticationException 215*b1cdbd2cSJim Jagielski @see com::sun::star::mail::IllegalStateException 216*b1cdbd2cSJim Jagielski @see com::sun::star::mail::MailException 217*b1cdbd2cSJim Jagielski */ 218*b1cdbd2cSJim Jagielski void connectUser([in] XAuthenticator xAuthenticator) 219*b1cdbd2cSJim Jagielski raises(com::sun::star::io::AlreadyConnectedException, 220*b1cdbd2cSJim Jagielski com::sun::star::io::UnknownHostException, 221*b1cdbd2cSJim Jagielski com::sun::star::io::NoRouteToHostException, 222*b1cdbd2cSJim Jagielski com::sun::star::io::ConnectException, 223*b1cdbd2cSJim Jagielski com::sun::star::auth::AuthenticationFailedException, 224*b1cdbd2cSJim Jagielski com::sun::star::mail::MailException); 225*b1cdbd2cSJim Jagielski 226*b1cdbd2cSJim Jagielski /** 227*b1cdbd2cSJim Jagielski Logoff the currently logged in user. 228*b1cdbd2cSJim Jagielski 229*b1cdbd2cSJim Jagielski @throws com::sun::star::mail::MessagingException 230*b1cdbd2cSJim Jagielski if errors occur during logoff. 231*b1cdbd2cSJim Jagielski */ 232*b1cdbd2cSJim Jagielski void disconnectUser() 233*b1cdbd2cSJim Jagielski raises(com::sun::star::mail::MailException); 234*b1cdbd2cSJim Jagielski 235*b1cdbd2cSJim Jagielski /** 236*b1cdbd2cSJim Jagielski Returns whether a user is currently logged in to the mail server or not. 237*b1cdbd2cSJim Jagielski 238*b1cdbd2cSJim Jagielski @returns 239*b1cdbd2cSJim Jagielski <TRUE/> if a user is currently logged in to the mail server. 240*b1cdbd2cSJim Jagielski */ 241*b1cdbd2cSJim Jagielski boolean isUserConnected(); 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski /** 244*b1cdbd2cSJim Jagielski Send a mail message to its recipients. 245*b1cdbd2cSJim Jagielski 246*b1cdbd2cSJim Jagielski @throws com::sun::star::io::NotConnectedException 247*b1cdbd2cSJim Jagielski if no user is currently connected to the mail server. 248*b1cdbd2cSJim Jagielski 249*b1cdbd2cSJim Jagielski @throws com::sun::star::mail::SendMailMessageFailedException 250*b1cdbd2cSJim Jagielski if the message could not be sent because of invalid recipient 251*b1cdbd2cSJim Jagielski addresses. The e-mail addresses of recipients have to conform to 252*b1cdbd2cSJim Jagielski <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>. 253*b1cdbd2cSJim Jagielski 254*b1cdbd2cSJim Jagielski @throws com::sun::star::mail::MailException 255*b1cdbd2cSJim Jagielski is thrown on other errors that may happen during sending. 256*b1cdbd2cSJim Jagielski A possible reason may be for instance that a file attachment 257*b1cdbd2cSJim Jagielski specified in a mail message could not be found or accessed. 258*b1cdbd2cSJim Jagielski 259*b1cdbd2cSJim Jagielski @throws com::sun::star::datatransfer::UnsupportedFlavorException 260*b1cdbd2cSJim Jagielski is thrown when the body of the mail message is provided in an 261*b1cdbd2cSJim Jagielski unsupported mime content type or may be thrown if one of the file 262*b1cdbd2cSJim Jagielski attachments specifies an unspupported mime content type. 263*b1cdbd2cSJim Jagielski 264*b1cdbd2cSJim Jagielski @see com::sun::star::io::NotConnectedExceptionException 265*b1cdbd2cSJim Jagielski @see com::sun::star::mail::SendMailMessageFailedException 266*b1cdbd2cSJim Jagielski @see com::sun::star::mail::MailException 267*b1cdbd2cSJim Jagielski @see com::sun::star::datatransfer::UnsupportedFlavorException 268*b1cdbd2cSJim Jagielski */ 269*b1cdbd2cSJim Jagielski void sendMailMessage([in] XMailMessage xMailMessage) 270*b1cdbd2cSJim Jagielski raises(com::sun::star::io::NotConnectedException, com::sun::star::mail::SendMailMessageFailedException, com::sun::star::mail::MailException, com::sun::star::datatransfer::UnsupportedFlavorException); 271*b1cdbd2cSJim Jagielski}; 272*b1cdbd2cSJim Jagielski 273*b1cdbd2cSJim Jagielski}; }; }; }; 274*b1cdbd2cSJim Jagielski 275*b1cdbd2cSJim Jagielski#endif 276