Quelle  MailMessage.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

module com { module sun { module star { module mail {

interface XMailMessage;

/**
   @since OOo 2.0
 */
service MailMessage: XMailMessage
{
    /**
        Constructs an instance of a mail message.

        @param sTo
        [in] the e-mail address of the recipient.
        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>.

        @param sFrom
        [in] the e-mail address of the sender of this mail message.
        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>.

        @param sSubject
        [in] the subject of the mail message.

        @param xBody
        [in] the body of the mail message. It is expected that the
        transferable delivers the data as a string. Although a
        transferable may support multiple data flavors only the
        first data flavor supplied will be used to retrieve the data
        and it is expected that the data will be provided as a string.

        @see com::sun::star::mail::XMailMessage
        @see com::sun::star::datatransfer::XTransferable
    */
    create([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody);

    /**
        Constructs an instance of a mail message.

        @param sTo
        [in] the e-mail address of the recipient.
        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>.

        @param sFrom
        [in] the e-mail address of the sender of this mail message.
        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC 822</a>.

        @param sSubject
        [in] the subject of the mail message.

        @param xBody
        [in] the body of the mail message. It is expected that the
        transferable delivers the data as a string. Although a
        transferable may support multiple data flavors only the
        first data flavor supplied will be used to retrieve the data
        and it is expected that the data will be provided as a string.

        @param aMailAttachment
        [in] specifies an attachment which should be send with this mail message.

        @see com::sun::star::mail::XMailMessage
        @see com::sun::star::datatransfer::XTransferable
        @see com::sun::star::mail::MailAttachment
    */
    createWithAttachment([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment);
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */