xref: /aoo42x/main/offapi/com/sun/star/mail/MailAttachment.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_MailAttachment_idl__
#define __com_sun_star_mail_MailAttachment_idl__

#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#include <com/sun/star/datatransfer/XTransferable.idl>
#endif

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

/**
    A <type>MailAttachment</type> specifies a mail message attachment.

    @see ::com::sun::star::mail::XMailMessage

    @since OOo 2.0
*/
struct MailAttachment
{
    /**
        The actual data which should be attached to a mail message.
        It is expected that the transferable delivers the data as
        sequence of bytes. Although a transferable may support
        multiple data flavors only the first data flavor supplied
        will be used to retrive the data and it is expected that
        the type of the data is a sequence of bytes.

        @see ::com::sun::star::datatransfer::XTransferable
    */
    ::com::sun::star::datatransfer::XTransferable Data;

    /**
        The name of the attachment as seen by the recipient of the
        mail message. ReadableName must not be empty.
    */
    string ReadableName;
};

}; }; }; };

#endif