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

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