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