xref: /trunk/main/offapi/com/sun/star/system/XMailMessage.idl (revision ae77b8ca)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/

#ifndef __com_sun_star_system_XMailMessage_idl__
#define __com_sun_star_system_XMailMessage_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

module com { module sun { module star { module system {

/** This interface lets a client set or get the information of a mail message.
*/
interface XMailMessage
{
    /** The recipient of the mail message.
    */
    [attribute] string Recipient;

    /** The email address of the originator of the mail.
    */
    [attribute] string Originator;

    /** The subject of the mail message.
    */
    [attribute] string Subject;

    /** The body of the mail message.
     */
    [attribute] string Body;

    /** A sequence with the email addresses of one or more bcc recipients.
    */
    [attribute] sequence< string > BccRecipient;

    /** A sequence with the email addresses of one or more cc recipients.
    */
    [attribute] sequence< string > CcRecipient;

    /** A sequence of file URLs specifying the files that should be attached to
        the mail.
        <p>The file URLs must be conform to
        <a href="http://www.w3.org/Addressing/rfc1738.txt" target="_blank">Rfc1738</a>.</p>

        @throws ::com::sun::star::lang::IllegalArgumentException
        if at least one of the given file URLs is invalid (doesn't conform to
        <a href="http://www.w3.org/Addressing/rfc1738.txt" target="_blank">Rfc1738</a>).
    */
    [attribute] sequence< string > Attachement
    {
        set raises (::com::sun::star::lang::IllegalArgumentException);
    };
};

}; }; }; };

#endif