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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_mail_MailAttachment_idl__
  21 #define __com_sun_star_mail_MailAttachment_idl__
  22
  23 #include <com/sun/star/datatransfer/XTransferable.idl>
  24
  25 module com { module sun { module star { module mail {
  26
  27 /**
  28     A MailAttachment specifies a mail message attachment.
  29
  30     @see ::com::sun::star::mail::XMailMessage
  31
  32     @since OOo 2.0
  33 */
  34 struct MailAttachment
  35 {
  36     /**
  37         The actual data which should be attached to a mail message.
  38         It is expected that the transferable delivers the data as
  39         sequence of bytes. Although a transferable may support
  40         multiple data flavors only the first data flavor supplied
  41         will be used to retrieve the data and it is expected that
  42         the type of the data is a sequence of bytes.
  43
  44         @see ::com::sun::star::datatransfer::XTransferable
  45     */
  46     ::com::sun::star::datatransfer::XTransferable Data;
  47
  48     /**
  49         The name of the attachment as seen by the recipient of the
  50         mail message. ReadableName must not be empty.
  51     */
  52     string ReadableName;
  53 };
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */