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 module com { module sun { module star { module mail {
  21
  22 /**
  23     A MailAttachment specifies a mail message attachment.
  24
  25     @see ::com::sun::star::mail::XMailMessage
  26
  27     @since OOo 2.0
  28 */
  29 struct MailAttachment
  30 {
  31     /**
  32         The actual data which should be attached to a mail message.
  33         It is expected that the transferable delivers the data as
  34         sequence of bytes. Although a transferable may support
  35         multiple data flavors only the first data flavor supplied
  36         will be used to retrieve the data and it is expected that
  37         the type of the data is a sequence of bytes.
  38
  39         @see ::com::sun::star::datatransfer::XTransferable
  40     */
  41     ::com::sun::star::datatransfer::XTransferable Data;
  42
  43     /**
  44         The name of the attachment as seen by the recipient of the
  45         mail message. ReadableName must not be empty.
  46     */
  47     string ReadableName;
  48 };
  49
  50 }; }; }; };
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */