offapi/com/sun/star/mail/XMailMessage.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    Represents a mail message.
  24
  25    @see com::sun::star::mail::XMailService
  26
  27    @since OOo 2.0
  28  */
  29 interface XMailMessage: ::com::sun::star::uno::XInterface {
  30
  31      /**
  32         The display name of the sender of this mail message.
  33     */
  34     [attribute, readonly] string SenderName;
  35     /**
  36         The e-mail address of the sender of this mail message.
  37         The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
  38     */
  39     [attribute, readonly] string SenderAddress;
  40
  41     /**
  42         The e-mail address where replies on this mail message should be sent to.
  43         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  44         sending the mail message later will fail.
  45         If no ReplyToAddress is set replies go to the SenderAddress.
  46     */
  47     [attribute] string ReplyToAddress;
  48
  49     /**
  50         Add a recipients e-mail address to the list of recipients of this mail message.
  51         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  52         sending the mail message will fail.
  53
  54         @param sRecipientAddress
  55         [in] the e-mail address of the recipient.
  56     */
  57     void addRecipient([in] string sRecipientAddress);
  58
  59     /**
  60         Add a Cc recipients e-mail address to the list of recipients of this mail message.
  61         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  62         sending the mail message will fail.
  63
  64         @param sRecipientAddress
  65         [in] the e-mail address of the Cc recipient.
  66     */
  67     void addCcRecipient([in] string sRecipientAddress);
  68
  69     /**
  70         Add a BCC recipients e-mail address to the list of recipients of this mail message.
  71         If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
  72         sending the mail message will fail.
  73
  74         @param sRecipientAddress
  75         [in] the e-mail address of the BCC recipient.
  76     */
  77     void addBccRecipient([in] string sRecipientAddress);
  78
  79     /**
  80         Return a sequence of the e-mail addresses of all recipients of
  81         this mail message.
  82     */
  83     sequence<string> getRecipients();
  84
  85     /**
  86         Return a sequence of the e-mail addresses of all the Cc recipients
  87         of this mail message.
  88     */
  89     sequence<string> getCcRecipients();
  90
  91     /**
  92         Return a sequence of the e-mail addresses of all the BCC recipients
  93         of this mail message.
  94     */
  95     sequence<string> getBccRecipients();
  96
  97     /**
  98         The subject of a mail message.
  99     */
 100     [attribute] string Subject;
 101
 102     /**
 103         The body of the mail message.
 104         It is expected that the transferable delivers the data as
 105         a string. Although a transferable may support multiple
 106         data flavors only the first data flavor supplied will be
 107         used to retrieve the data and it is expected that the data
 108         will be provided as a string.
 109
 110         @see com::sun::star::datatransfer::XTransferable
 111     */
 112     [attribute] com::sun::star::datatransfer::XTransferable Body;
 113
 114     /**
 115         Add a file attachment to a mail message.
 116
 117         param aMailAttachment
 118         [in] specifies a file which should be attached to this mail message.
 119
 120         @see com::sun::star::mail::MailAttachment
 121     */
 122     void addAttachment([in] MailAttachment aMailAttachment);
 123
 124     /**
 125         Return a sequence of MailAttachment's that will
 126         be attached to this mail message.
 127
 128         @see com::sun::star::mail::MailAttachment
 129     */
 130     sequence<MailAttachment> getAttachments();
 131 };
 132
 133 }; }; }; };
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */