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