xref: /trunk/main/offapi/com/sun/star/mail/MailMessage.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_mail_MailMessage_idl__
25#define __com_sun_star_mail_MailMessage_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30
31#ifndef __com_sun_star_mail_MailAttachment_idl__
32#include <com/sun/star/mail/MailAttachment.idl>
33#endif
34
35#ifndef __com_sun_star_datatransfer_XTransferable_idl__
36#include <com/sun/star/datatransfer/XTransferable.idl>
37#endif
38
39module com { module sun { module star { module mail {
40
41interface XMailMessage;
42
43/**
44   @since OOo 2.0
45 */
46service MailMessage: XMailMessage
47{
48    /**
49        Constructs an instance of a mail message.
50
51        @param sTo
52        [in] the e-mail address of the recipient.
53        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
54
55        @param sFrom
56        [in] the e-mail address of the sender of this mail message.
57        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
58
59        @param sSubject
60        [in] the subject of the mail message.
61
62        @param xBody
63        [in] the body of the mail message. It is expected that the
64        transferable delivers the data as a string. Although a
65        transferable may support multiple data flavors only the
66        first data flavor supplied will be used to retrieve the data
67        and it is expected that the data will be provided as a string.
68
69        @see com::sun::star::mail::XMailMessage
70        @see com::sun::star::datatransfer::XTransferable
71    */
72    create([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody);
73
74    /**
75        Constructs an instance of a mail message.
76
77        @param sTo
78        [in] the e-mail address of the recipient.
79        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
80
81        @param sFrom
82        [in] the e-mail address of the sender of this mail message.
83        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
84
85        @param sSubject
86        [in] the subject of the mail message.
87
88        @param xBody
89        [in] the body of the mail message. It is expected that the
90        transferable delivers the data as a string. Although a
91        transferable may support multiple data flavors only the
92        first data flavor supplied will be used to retrieve the data
93        and it is expected that the data will be provided as a string.
94
95        @param aMailAttachment
96        [in] specifies an attachment which should be send with this mail message.
97
98        @see com::sun::star::mail::XMailMessage
99        @see com::sun::star::datatransfer::XTransferable
100        @see com::sun::star::mail::MailAttachment
101    */
102    createWithAttachment([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment);
103};
104
105}; }; }; };
106
107#endif
108