summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/mail/MailMessage.idl
blob: 2ced5957236720ce6ead9ce3754f066e800d9e93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_mail_MailMessage_idl__
#define __com_sun_star_mail_MailMessage_idl__

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_mail_MailAttachment_idl__
#include <com/sun/star/mail/MailAttachment.idl>
#endif

#ifndef __com_sun_star_datatransfer_XTransferable_idl__
#include <com/sun/star/datatransfer/XTransferable.idl>
#endif

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

interface XMailMessage;

/**
   @since OOo 2.0.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&nbsp;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&nbsp;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&nbsp;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&nbsp;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);            
};

}; }; }; };

#endif