offapi/com/sun/star/ucb/RecipientInfo.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: RecipientInfo.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_RecipientInfo_idl__
  31 #define __com_sun_star_ucb_RecipientInfo_idl__
  32
  33 #ifndef __com_sun_star_ucb_OutgoingMessageState_idl__
  34 #include <com/sun/star/ucb/OutgoingMessageState.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** contains all information needed to send a message using one send protocol.
  44
  45     <p>To send one message via two different protocols, two RecipientInfos
  46     are needed - to send one message to different users with one protocol,
  47     one RecipientInfo can be used.
  48 */
  49 published struct RecipientInfo
  50 {
  51     //-------------------------------------------------------------------------
  52     /** the protocol to use for sending (i.e. "NNTP", "SMTP", "VIM").
  53     */
  54     string ProtocolType;
  55
  56     //-------------------------------------------------------------------------
  57     /** the current state of the message.
  58     */
  59     com::sun::star::ucb::OutgoingMessageState State;
  60
  61     //-------------------------------------------------------------------------
  62     /** the recipient(s) (e.g. e-mail address/es).
  63
  64         <p>Multiple addresses are separated by commas.
  65     */
  66     string To;
  67
  68     //-------------------------------------------------------------------------
  69     /** the recipient(s) of a "carbon copy" (e.g. e-mail address/es).
  70
  71         <p>Multiple addresses are separated by commas.
  72     */
  73     string CC;
  74
  75     //-------------------------------------------------------------------------
  76     /** the recipient(s) of "blind carbon copy" (e.g. e-mail address/es).
  77
  78         <p>Multiple addresses are separated by commas.
  79     */
  80     string BCC;
  81
  82     //-------------------------------------------------------------------------
  83     /** the newsgroup(s) to which an article is be posted.
  84
  85         <p>Multiple addresses are separated by commas.
  86     */
  87     string Newsgroups;
  88
  89     //-------------------------------------------------------------------------
  90     /** the name of the server to be used for sending the message.
  91     */
  92     string Server;
  93
  94     //-------------------------------------------------------------------------
  95     /** the user name to be used for authorizing on the send server.
  96     */
  97     string Username;
  98
  99     //-------------------------------------------------------------------------
 100     /** the password to be used for authorizing on the send server.
 101     */
 102     string Password;
 103
 104     //-------------------------------------------------------------------------
 105     /** the Post Office Path (VIM only).
 106     */
 107     string VIMPostOfficePath;
 108
 109     //-------------------------------------------------------------------------
 110     /** string representing the last error (generated by send server).
 111     */
 112     string ProtocolErrorString;
 113
 114     //-------------------------------------------------------------------------
 115     /** the number representing the last error (generated by send server).
 116     */
 117     long ProtocolErrorNumber;
 118
 119     //-------------------------------------------------------------------------
 120     /** the count of tries to send a message. This count is <code>1</code>
 121         if the message was sent with the first try and increases with every
 122         unsuccessful retry.
 123     */
 124     long SendTries;
 125
 126 };
 127
 128 //=============================================================================
 129
 130 }; }; }; };
 131
 132 #endif