offapi/com/sun/star/mail/MailMessage.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: MailMessage.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_MailMessage_idl__
  32 #define __com_sun_star_mail_MailMessage_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_mail_MailAttachment_idl__
  39 #include <com/sun/star/mail/MailAttachment.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  43 #include <com/sun/star/datatransfer/XTransferable.idl>
  44 #endif
  45
  46 module com { module sun { module star { module mail {
  47
  48 interface XMailMessage;
  49
  50 /**
  51    @since OOo 2.0.0
  52  */
  53 service MailMessage: XMailMessage
  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         @see com::sun::star::mail::XMailMessage
  77         @see com::sun::star::datatransfer::XTransferable
  78     */
  79     create([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody);
  80
  81     /**
  82         Constructs an instance of a mail message.
  83
  84         @param sTo
  85         [in] the e-mail address of the recipient.
  86         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  87
  88         @param sFrom
  89         [in] the e-mail address of the sender of this mail message.
  90         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  91
  92         @param sSubject
  93         [in] the subject of the mail message.
  94
  95         @param xBody
  96         [in] the body of the mail message. It is expected that the
  97         transferable delivers the data as a string. Although a
  98         transferable may support multiple data flavors only the
  99         first data flavor supplied will be used to retrieve the data
 100         and it is expected that the data will be provided as a string.
 101
 102         @param aMailAttachment
 103         [in] specifies an attachment which should be send with this mail message.
 104
 105         @see com::sun::star::mail::XMailMessage
 106         @see com::sun::star::datatransfer::XTransferable
 107         @see com::sun::star::mail::MailAttachment
 108     */
 109     createWithAttachment([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment);
 110 };
 111
 112 }; }; }; };
 113
 114 #endif