offapi/com/sun/star/mail/MailMessage.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 interface XMailMessage;
  23
  24 /**
  25    @since OOo 2.0
  26  */
  27 service MailMessage: XMailMessage
  28 {
  29     /**
  30         Constructs an instance of a mail message.
  31
  32         @param sTo
  33         [in] the e-mail address of the recipient.
  34         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  35
  36         @param sFrom
  37         [in] the e-mail address of the sender of this mail message.
  38         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  39
  40         @param sSubject
  41         [in] the subject of the mail message.
  42
  43         @param xBody
  44         [in] the body of the mail message. It is expected that the
  45         transferable delivers the data as a string. Although a
  46         transferable may support multiple data flavors only the
  47         first data flavor supplied will be used to retrieve the data
  48         and it is expected that the data will be provided as a string.
  49
  50         @see com::sun::star::mail::XMailMessage
  51         @see com::sun::star::datatransfer::XTransferable
  52     */
  53     create([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody);
  54
  55     /**
  56         Constructs an instance of a mail message.
  57
  58         @param sTo
  59         [in] the e-mail address of the recipient.
  60         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  61
  62         @param sFrom
  63         [in] the e-mail address of the sender of this mail message.
  64         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  65
  66         @param sSubject
  67         [in] the subject of the mail message.
  68
  69         @param xBody
  70         [in] the body of the mail message. It is expected that the
  71         transferable delivers the data as a string. Although a
  72         transferable may support multiple data flavors only the
  73         first data flavor supplied will be used to retrieve the data
  74         and it is expected that the data will be provided as a string.
  75
  76         @param aMailAttachment
  77         [in] specifies an attachment which should be send with this mail message.
  78
  79         @see com::sun::star::mail::XMailMessage
  80         @see com::sun::star::datatransfer::XTransferable
  81         @see com::sun::star::mail::MailAttachment
  82     */
  83     createWithAttachment([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment);
  84 };
  85
  86 }; }; }; };
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */