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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_RecipientInfo_idl__
  20 #define __com_sun_star_ucb_RecipientInfo_idl__
  21
  22 #include <com/sun/star/ucb/OutgoingMessageState.idl>
  23
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** contains all information needed to send a message using one send protocol.
  29
  30     <p>To send one message via two different protocols, two RecipientInfos
  31     are needed - to send one message to different users with one protocol,
  32     one RecipientInfo can be used.
  33 */
  34 published struct RecipientInfo
  35 {
  36     /** the protocol to use for sending (i.e. "NNTP", "SMTP", "VIM").
  37     */
  38     string ProtocolType;
  39
  40     /** the current state of the message.
  41     */
  42     com::sun::star::ucb::OutgoingMessageState State;
  43
  44     /** the recipient(s) (e.g. e-mail address/es).
  45
  46         <p>Multiple addresses are separated by commas.
  47     */
  48     string To;
  49
  50     /** the recipient(s) of a "carbon copy" (e.g. e-mail address/es).
  51
  52         <p>Multiple addresses are separated by commas.
  53     */
  54     string CC;
  55
  56     /** the recipient(s) of "blind carbon copy" (e.g. e-mail address/es).
  57
  58         <p>Multiple addresses are separated by commas.
  59     */
  60     string BCC;
  61
  62     /** the newsgroup(s) to which an article is be posted.
  63
  64         <p>Multiple addresses are separated by commas.
  65     */
  66     string Newsgroups;
  67
  68     /** the name of the server to be used for sending the message.
  69     */
  70     string Server;
  71
  72     /** the user name to be used for authorizing on the send server.
  73     */
  74     string Username;
  75
  76     /** the password to be used for authorizing on the send server.
  77     */
  78     string Password;
  79
  80     /** the Post Office Path (VIM only).
  81     */
  82     string VIMPostOfficePath;
  83
  84     /** string representing the last error (generated by send server).
  85     */
  86     string ProtocolErrorString;
  87
  88     /** the number representing the last error (generated by send server).
  89     */
  90     long ProtocolErrorNumber;
  91
  92     /** the count of tries to send a message. This count is <code>1</code>
  93         if the message was sent with the first try and increases with every
  94         unsuccessful retry.
  95     */
  96     long SendTries;
  97
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */