summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/RecipientInfo.idl
blob: e1bd97e5b28a872d43b877bbe68d5f393d93dc10 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*************************************************************************
 *
 *  $RCSfile: RecipientInfo.idl,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_RecipientInfo_idl__
#define __com_sun_star_ucb_RecipientInfo_idl__

#ifndef __com_sun_star_ucb_OutgoingMessageState_idl__
#include <com/sun/star/ucb/OutgoingMessageState.idl>
#endif


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/**This struct contains all information needed to send a message using one(!)
    send protocol.

    <p>To send one message via two different protocols, two RecipientInfos
    are needed - to send one message to different users with one protocol,
    one RecipientInfo can be used.
*/
struct RecipientInfo
{
    //-------------------------------------------------------------------------
    /** The protocol to use for sending ( i.e. &quot;NNTP&quot;, &quot;SMTP&quot;, &quot;VIM&quot; ).
    */
    string ProtocolType;

    //-------------------------------------------------------------------------
    /**the current state of the message.
    */
    com::sun::star::ucb::OutgoingMessageState State;

    //-------------------------------------------------------------------------
    /** the recipient(s) (e.g. e-mail address/es).
    Multiple addresses are separated by commas.
    */
    string To;

    //-------------------------------------------------------------------------
    /** the recipient(s) of a &quot;carbon copy&quot; (e.g. e-mail address/es).
    Multiple addresses are separated by commas.
    */
    string CC;

    //-------------------------------------------------------------------------
    /** the recipient(s) of &quot;blind carbon copy&quot; (e.g. e-mail address/es).
    Multiple addresses are separated by commas.
    */
    string BCC;

    //-------------------------------------------------------------------------
    /** the newsgroup(s) to which an article is be posted.
    Multiple groups are separated by commas.
    */
    string Newsgroups;

    //-------------------------------------------------------------------------
    /** the name of the server to be used for sending the message.
    */
    string Server;

    //-------------------------------------------------------------------------
    /** the user name to be used for authorizing on the send server.
    */
    string Username;

    //-------------------------------------------------------------------------
    /** the password to be used for authorizing on the send server.
    */
    string Password;

    //-------------------------------------------------------------------------
    /** the Post Office Path (VIM only).
    */
    string VIMPostOfficePath;

    //-------------------------------------------------------------------------
    /** String representing the last error (generated by send server).
    */
    string ProtocolErrorString;

    //-------------------------------------------------------------------------
    /**The number representing the last error (generated by send server).
    */
    long ProtocolErrorNumber;

    //-------------------------------------------------------------------------
    /**The count of tries to send a message. This count is 1 if the
        message was sent with the first try and increases with every
        unsuccessful retry.
    */
    long SendTries;

};

//=============================================================================

}; }; }; };

#endif