offapi/com/sun/star/mail/XSmtpService.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSmtpService.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_mail_XSmtpService_idl__
  32 #define __com_sun_star_mail_XSmtpService_idl__
  33
  34 #ifndef __com_sun_star_mail_XMailService_idl__
  35 #include <com/sun/star/mail/XMailService.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_mail_XMailMessage_idl__
  39 #include <com/sun/star/mail/XMailMessage.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_io_NotConnectedException_idl__
  43 #include <com/sun/star/io/NotConnectedException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_io_ConnectException_idl__
  47 #include <com/sun/star/io/ConnectException.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_mail_MailException_idl__
  51 #include <com/sun/star/mail/MailException.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_mail_SendMailMessageFailedException_idl__
  55 #include <com/sun/star/mail/SendMailMessageFailedException.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_datatransfer_UnsupportedFlavorException_idl__
  59 #include <com/sun/star/datatransfer/UnsupportedFlavorException.idl>
  60 #endif
  61
  62 module com { module sun { module star { module mail {
  63
  64 /**
  65    Represents a SMTP service abstraction.
  66
  67    @see com::sun::star::mail::XMailService
  68    @see com::sun::star::mail::XMailMessage
  69
  70    @since OOo 2.0.0
  71  */
  72 interface XSmtpService: ::com::sun::star::mail::XMailService {
  73
  74     /**
  75         Send a mail message to its recipients.
  76
  77         @param xMailMessage
  78         [in] the mail message to be sent.
  79
  80         @throws com::sun::star::io::NotConnectedException
  81         if no user is currently connected to the mail server.
  82
  83         @throws com::sun::star::mail::SendMailMessageFailedException
  84         if the message could not be sent because of invalid recipient
  85         addresses. The e-mail addresses of recipients have to conform to
  86         <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  87
  88         @throws com::sun::star::mail::MailException
  89         is thrown on other errors that may happen during sending.
  90         A possible reason may be for instance that a file attachment
  91         specified in a mail message could not be found or accessed.
  92
  93         @throws com::sun::star::datatransfer::UnsupportedFlavorException
  94         is thrown when the body of the mail message is provided in an
  95         unsupported mime content type or may be thrown if one of the file
  96         attachments specifies an unspupported mime content type.
  97
  98         @see com::sun::star::mail::XMailMessage
  99         @see com::sun::star::io::NotConnectedException
 100         @see com::sun::star::mail::SendMailMessageFailedException
 101         @see com::sun::star::mail::MailException
 102         @see com::sun::star::datatransfer::UnsupportedFlavorException
 103     */
 104     void sendMailMessage([in] XMailMessage xMailMessage)
 105         raises(com::sun::star::io::NotConnectedException, com::sun::star::mail::SendMailMessageFailedException, com::sun::star::mail::MailException, com::sun::star::datatransfer::UnsupportedFlavorException);
 106 };
 107
 108 }; }; }; };
 109
 110 #endif