offapi/com/sun/star/mail/SendMailMessageFailedException.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: SendMailMessageFailedException.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_SendMailMessageFailedException_idl__
  32 #define __com_sun_star_mail_SendMailMessageFailedException_idl__
  33
  34 #ifndef __com_sun_star_mail_MailException_idl__
  35 #include <com/sun/star/mail/MailException.idl>
  36 #endif
  37
  38 module com { module sun { module star { module mail {
  39
  40 /**
  41    A SendFailedException will be thrown if a mail message
  42    could not be sent because the e-mail addresses of some
  43    recipients are invalid. E-mail addresses have to conform
  44    to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  45
  46    @see com::sun::star::mail::XMailServer
  47
  48    @since OOo 2.0.0
  49  */
  50 exception SendMailMessageFailedException: com::sun::star::mail::MailException
  51 {
  52     /**
  53         The addresses which are invalid because they do not conform
  54         to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  55     */
  56     sequence<string> InvalidAddresses;
  57
  58     /**
  59         The addresses to which the mail message was sent successfully.
  60     */
  61     sequence<string> ValidSentAddresses;
  62
  63     /**
  64         The addresses which are valid but to which the message was not sent.
  65     */
  66     sequence<string> ValidUnsentAddresses;
  67 };
  68
  69 }; }; }; };
  70
  71 #endif