gecko-dev/mailnews/news/public/nsINNTPNewsgroupPost.idl

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * The contents of this file are subject to the Netscape Public
 * 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.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 */

/* This object represents the stream of data which will be sent to an
   NNTP server. You basically set up all the RFC850 required headers, etc,
   then pass it to something that reads off the nsIInputStream interface.
*/

#include "nsISupports.idl"
#include "nsIFileSpec.idl"

[scriptable, uuid(c4164a20-bc74-11d2-b7f2-00805f05ffa5)]
interface nsINNTPNewsgroupPost : nsISupports {
    
    /* from RFC850 */
    /* section 2.1 - required headers */
    attribute string relayVersion;
    attribute string postingVersion;
    attribute string from;
    attribute string date;
    
    void AddNewsgroup(in string newsgroupName);
    readonly attribute string newsgroups;
    
    attribute string subject;
    readonly attribute string messageID;
    attribute string path;

    boolean isValid();
    
    /* Secion 2.2 - optional headers */
    attribute string replyTo;
    attribute string sender;
    attribute string followupTo;
    attribute string dateRecieved;
    attribute string expires;

    void AddReference(in string referenceID);
    readonly attribute string references;

    attribute string control;
    attribute string distribution;
    attribute string organization;

    /* the message itself */
    attribute string body;

    /* the path to the message */
    /* attribute nsFilePath postMessageFile; */
        
    /* control messages */
    void MakeControlCancel(in string messageID);
    /* probably don't need these
       void MakeControlNewgroup(in string groupname);
       void MakeControlRmgroup(in string groupname);
       void MakeControlSendsys();
       void MakeControlSenduuname();
       void MakeControlVersion();
    */
    /* is this a control message? */
    readonly attribute boolean isControl;

    /* this should return a pointer to the full text of the RFC850 message
     * that gets sent to the NNTP server
     * return a reference so that we are not strdup()ing an entire message
     * Each call to getFullMessage will destroy the last reference and return
     * a new one by reassembling the message.
     * A better solution would just be to give this message an nsIOutputStream
     * to write to so that it can better manage the assembled message.
     */
    string GetFullMessage();

    attribute nsIFileSpec postMessageFile;
};