offapi/com/sun/star/mail/MailAttachment.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: MailAttachment.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_MailAttachment_idl__
  32 #define __com_sun_star_mail_MailAttachment_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  35 #include <com/sun/star/datatransfer/XTransferable.idl>
  36 #endif
  37
  38 module com { module sun { module star { module mail {
  39
  40 /**
  41     A <type>MailAttachment</type> specifies a mail message attachment.
  42
  43     @see ::com::sun::star::mail::XMailMessage
  44
  45     @since OOo 2.0.0
  46 */
  47 struct MailAttachment
  48 {
  49     /**
  50         The actual data which should be attached to a mail message.
  51         It is expected that the transferable delivers the data as
  52         sequence of bytes. Although a transferable may support
  53         multiple data flavors only the first data flavor supplied
  54         will be used to retrive the data and it is expected that
  55         the type of the data is a sequence of bytes.
  56
  57         @see ::com::sun::star::datatransfer::XTransferable
  58     */
  59     ::com::sun::star::datatransfer::XTransferable Data;
  60
  61     /**
  62         The name of the attachment as seen by the recipient of the
  63         mail message. ReadableName must not be empty.
  64     */
  65     string ReadableName;
  66 };
  67
  68 }; }; }; };
  69
  70 #endif