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