offapi/com/sun/star/system/XSimpleMailMessage.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_system_XSimpleMailMessage_idl__
  21 #define __com_sun_star_system_XSimpleMailMessage_idl__
  22
  23 #include <com/sun/star/uno/RuntimeException.idl>
  24 #include <com/sun/star/uno/XInterface.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27
  28 module com { module sun { module star { module system {
  29
  30 /** This interface lets a client set or get the information of a simple mail
  31     message.
  32 */
  33
  34
  35 published interface XSimpleMailMessage: com::sun::star::uno::XInterface
  36 {
  37     /** To set the recipient of the simple mail message.
  38         @param aRecipient
  39         The email address of a recipient. The method doesn't check if
  40         the given email address is valid.
  41     */
  42     void setRecipient( [in] string aRecipient );
  43
  44     /** To get the recipient of the simple mail message.
  45         @returns
  46         The specified email address of a recipient
  47         if any has been specified or an empty string.
  48     */
  49     string getRecipient( );
  50
  51     /** To set the cc recipients of a simple mail message.
  52
  53         @param aCcRecipient
  54         Sets a sequence with the email addresses of one or more cc recipients.
  55         <p>The method does not check if the given addresses are valid. An empty
  56         sequence means there are no cc recipients.</p>
  57     */
  58     void setCcRecipient( [in] sequence< string > aCcRecipient );
  59
  60     /** To get the cc recipients of a simple mail message.
  61         @returns
  62         A sequence with the email addresses of one or more cc recipients.
  63         <p>If no cc recipients have been specified an empty sequence will be returned.</p>
  64     */
  65     sequence< string > getCcRecipient( );
  66
  67     /** To set the BCC recipient of a simple mail message.
  68         @param aBccRecipient
  69         A sequence with the email addresses of one or more BCC recipients. An empty
  70         sequence means there are no BCC recipients.</p>
  71     */
  72     void setBccRecipient( [in] sequence< string > aBccRecipient );
  73
  74     /** To get the BCC recipients of a simple mail message.
  75         @returns
  76         A sequence with the email addresses of one or more BCC recipients.
  77         <p>If no BCC recipients have been specified an empty sequence will be returned.</p>
  78     */
  79     sequence< string > getBccRecipient( );
  80
  81     /** To set the email address of the originator of a simple mail message.
  82         @param aOriginator
  83         Sets the email address of the originator of the mail.
  84     */
  85     void setOriginator( [in] string aOriginator );
  86
  87     /** To get the email address of the originator of a simple mail message.
  88         @returns
  89         The email address of the originator of the mail.
  90         <p>If no originator has been specified an empty string will be returned.</p>
  91     */
  92     string getOriginator( );
  93
  94     /** To set the subject of a simple mail message.
  95         @param aSubject
  96         Sets the subject of the simple mail message.
  97     */
  98     void setSubject( [in] string aSubject );
  99
 100     /** To get the subject of a simple mail message.
 101         @returns
 102         The subject of the simple mail message.
 103         <p>If no subject has been specified an empty string will be returned.</p>
 104     */
 105     string getSubject( );
 106
 107     /** To set an attachment of a simple mail message.
 108         @param aAttachement
 109         Sets a sequence of file URLs specifying the files that should be
 110         attached to the mail. The given file URLs must conform to
 111         <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
 112         The method does not check if the specified file or files really exist.
 113
 114         @throws ::com::sun::star::lang::IllegalArgumentException
 115         if at least one of the given file URLs is invalid (doesn't conform to
 116         <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>).
 117     */
 118     void setAttachement( [in] sequence< string > aAttachement )
 119         raises( ::com::sun::star::lang::IllegalArgumentException );
 120
 121     /** To get the attachment of a simple mail message.
 122         @returns
 123         A sequence of file URLs specifying the files that should be attached to
 124         the mail or an empty sequence if no attachments have been specified.
 125         The returned file URLs conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
 126     */
 127     sequence< string > getAttachement( );
 128 };
 129
 130
 131 }; }; }; };
 132
 133 #endif
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */