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#ifndef __com_sun_star_ucb_RecipientInfo_idl__
28#define __com_sun_star_ucb_RecipientInfo_idl__
29
30#ifndef __com_sun_star_ucb_OutgoingMessageState_idl__
31#include <com/sun/star/ucb/OutgoingMessageState.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module ucb {
38
39//=============================================================================
40/** contains all information needed to send a message using one	send protocol.
41
42	<p>To send one message via two different protocols, two RecipientInfos
43	are needed - to send one message to different users with one protocol,
44	one RecipientInfo can be used.
45*/
46published struct RecipientInfo
47{
48	//-------------------------------------------------------------------------
49	/** the protocol to use for sending (i.e. "NNTP", "SMTP", "VIM").
50	*/
51	string ProtocolType;
52
53	//-------------------------------------------------------------------------
54	/** the current state of the message.
55	*/
56	com::sun::star::ucb::OutgoingMessageState State;
57
58	//-------------------------------------------------------------------------
59	/** the recipient(s) (e.g. e-mail address/es).
60
61		<p>Multiple addresses are separated by commas.
62	*/
63	string To;
64
65	//-------------------------------------------------------------------------
66	/** the recipient(s) of a "carbon copy" (e.g. e-mail address/es).
67
68		<p>Multiple addresses are separated by commas.
69	*/
70	string CC;
71
72	//-------------------------------------------------------------------------
73	/** the recipient(s) of "blind carbon copy" (e.g. e-mail address/es).
74
75		<p>Multiple addresses are separated by commas.
76	*/
77	string BCC;
78
79	//-------------------------------------------------------------------------
80	/** the newsgroup(s) to which an article is be posted.
81
82		<p>Multiple addresses are separated by commas.
83	*/
84	string Newsgroups;
85
86	//-------------------------------------------------------------------------
87	/** the name of the server to be used for sending the message.
88	*/
89	string Server;
90
91	//-------------------------------------------------------------------------
92	/** the user name to be used for authorizing on the send server.
93	*/
94	string Username;
95
96	//-------------------------------------------------------------------------
97	/** the password to be used for authorizing on the send server.
98	*/
99	string Password;
100
101	//-------------------------------------------------------------------------
102	/** the Post Office Path (VIM only).
103	*/
104	string VIMPostOfficePath;
105
106	//-------------------------------------------------------------------------
107	/** string representing the last error (generated by send server).
108	*/
109	string ProtocolErrorString;
110
111	//-------------------------------------------------------------------------
112	/** the number representing the last error (generated by send server).
113	*/
114	long ProtocolErrorNumber;
115
116	//-------------------------------------------------------------------------
117	/** the count of tries to send a message. This count is <code>1</code>
118	    if the message was sent with the first try and increases with every
119		unsuccessful retry.
120	*/
121	long SendTries;
122
123};
124
125//=============================================================================
126
127}; }; }; };
128
129#endif
130