office-gobmx/offapi/com/sun/star/mail/SendMailMessageFailedException.idl

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: SendMailMessageFailedException.idl,v $
 * $Revision: 1.5 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_mail_SendMailMessageFailedException_idl__
#define __com_sun_star_mail_SendMailMessageFailedException_idl__

#ifndef __com_sun_star_mail_MailException_idl__
#include <com/sun/star/mail/MailException.idl>
#endif

module com { module sun { module star { module mail {

/**
   A SendFailedException will be thrown if a mail message
   could not be sent because the e-mail addresses of some
   recipients are invalid. E-mail addresses have to conform
   to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.

   @see com::sun::star::mail::XMailServer

   @since OOo 2.0.0
 */
exception SendMailMessageFailedException: com::sun::star::mail::MailException
{
    /**
        The addresses which are invalid because they do not conform
        to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
    */
    sequence<string> InvalidAddresses;

    /**
        The addresses to which the mail message was sent successfully.
    */
    sequence<string> ValidSentAddresses;

    /**
        The addresses which are valid but to which the message was not sent.
    */
    sequence<string> ValidUnsentAddresses;
};

}; }; }; };

#endif