offapi/com/sun/star/mail/XMailMessage.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: XMailMessage.idl,v $
  10  * $Revision: 1.6 $
  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_XMailMessage_idl__
  32 #define __com_sun_star_mail_XMailMessage_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.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 /**
  49    Represents a mail message.
  50
  51    @see com::sun::star::mail::XMailServer
  52
  53    @since OOo 2.0.0
  54  */
  55 interface XMailMessage: ::com::sun::star::uno::XInterface {
  56
  57      /**
  58         The display name of the sender of this mail message.
  59     */
  60     [attribute, readonly] string SenderName;
  61     /**
  62         The e-mail address of the sender of this mail message.
  63         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  64     */
  65     [attribute, readonly] string SenderAddress;
  66
  67     /**
  68         The e-mail address where replies on this mail message should be sent to.
  69         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  70         sending the mail message later will fail.
  71         If no ReplyToAddress is set replies go to the SenderAddress.
  72     */
  73     [attribute] string ReplyToAddress;
  74
  75     /**
  76         Add an recipients e-mail address to the list of recipients of this mail message.
  77         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  78         sending the mail message will fail.
  79
  80         @param sRecipientAddress
  81         [in] the e-mail address of the recipient.
  82     */
  83     void addRecipient([in] string sRecipientAddress);
  84
  85     /**
  86         Add an Cc recipients e-mail address to the list of recipients of this mail message.
  87         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  88         sending the mail message will fail.
  89
  90         @param sRecipientAddress
  91         [in] the e-mail address of the Cc recipient.
  92     */
  93     void addCcRecipient([in] string sRecipientAddress);
  94
  95     /**
  96         Add an Bcc recipients e-mail address to the list of recipients of this mail message.
  97         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  98         sending the mail message will fail.
  99
 100         @param sRecipientAddress
 101         [in] the e-mail address of the Bcc recipient.
 102     */
 103     void addBccRecipient([in] string sRecipientAddress);
 104
 105     /**
 106         Return a sequence of the e-mail addresses of all recipients of
 107         this mail message.
 108     */
 109     sequence<string> getRecipients();
 110
 111     /**
 112         Return a sequence of the e-mail addresses of all the Cc recipients
 113         of this mail message.
 114     */
 115     sequence<string> getCcRecipients();
 116
 117     /**
 118         Return a sequence of the e-mail addresses of all the Bcc recipients
 119         of this mail message.
 120     */
 121     sequence<string> getBccRecipients();
 122
 123     /**
 124         The subject of a mail message.
 125     */
 126     [attribute] string Subject;
 127
 128     /**
 129         The body of the mail message.
 130         It is expected that the transferable delivers the data as
 131         a string. Although a transferable may support multiple
 132         data flavors only the first data flavor supplied will be
 133         used to retrieve the data and it is expected that the data
 134         will be provided as a string.
 135
 136         @see com::sun::star::datatransfer::XTransferable
 137     */
 138     [attribute] com::sun::star::datatransfer::XTransferable Body;
 139
 140     /**
 141         Add a file attachment to a mail message.
 142
 143         param aMailAttachment
 144         [in] specifies a file which should be attached to this mail message.
 145
 146         @see com::sun::star::mail::MailAttachment
 147     */
 148     void addAttachment([in] MailAttachment aMailAttachment);
 149
 150     /**
 151         Return a sequence of <type>MailAttachment</type>'s that will
 152         be attached to this mail message.
 153
 154         @see com::sun::star::mail::MailAttachment
 155     */
 156     sequence<MailAttachment> getAttachments();
 157 };
 158
 159 }; }; }; };
 160
 161 #endif