1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_mail_MailMessage_idl__
29#define __com_sun_star_mail_MailMessage_idl__
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35#ifndef __com_sun_star_mail_MailAttachment_idl__
36#include <com/sun/star/mail/MailAttachment.idl>
37#endif
38
39#ifndef __com_sun_star_datatransfer_XTransferable_idl__
40#include <com/sun/star/datatransfer/XTransferable.idl>
41#endif
42
43module com { module sun { module star { module mail {
44
45interface XMailMessage;
46
47/**
48   @since OOo 2.0
49 */
50service MailMessage: XMailMessage
51{
52    /**
53        Constructs an instance of a mail message.
54
55        @param sTo
56        [in] the e-mail address of the recipient.
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 sFrom
60        [in] the e-mail address of the sender of this mail message.
61        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
62
63        @param sSubject
64        [in] the subject of the mail message.
65
66        @param xBody
67        [in] the body of the mail message. It is expected that the
68        transferable delivers the data as a string. Although a
69        transferable may support multiple data flavors only the
70        first data flavor supplied will be used to retrieve the data
71        and it is expected that the data will be provided as a string.
72
73        @see com::sun::star::mail::XMailMessage
74        @see com::sun::star::datatransfer::XTransferable
75    */
76    create([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody);
77
78    /**
79        Constructs an instance of a mail message.
80
81        @param sTo
82        [in] the e-mail address of the recipient.
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 sFrom
86        [in] the e-mail address of the sender of this mail message.
87        The e-mail address has to conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>.
88
89        @param sSubject
90        [in] the subject of the mail message.
91
92        @param xBody
93        [in] the body of the mail message. It is expected that the
94        transferable delivers the data as a string. Although a
95        transferable may support multiple data flavors only the
96        first data flavor supplied will be used to retrieve the data
97        and it is expected that the data will be provided as a string.
98
99        @param aMailAttachment
100        [in] specifies an attachment which should be send with this mail message.
101
102        @see com::sun::star::mail::XMailMessage
103        @see com::sun::star::datatransfer::XTransferable
104        @see com::sun::star::mail::MailAttachment
105    */
106    createWithAttachment([in] string sTo, [in] string sFrom, [in] string sSubject, [in] com::sun::star::datatransfer::XTransferable xBody, [in] MailAttachment aMailAttachment);
107};
108
109}; }; }; };
110
111#endif
112