/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * 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):
 */

#include "nsISupports.idl"
#include "nsIMsgFolder.idl"

interface nsIMsgWindow;
interface nsINntpIncomingServer;

[scriptable, uuid(3716abe4-f6d4-11d2-86d5-004005263078)]
interface nsIMsgNewsFolder : nsISupports {
  attribute string groupUsername;
  attribute string groupPassword;

  /** the ascii name for the newsgroup.  
   *  newsgroup names are always ascii, and this can help simply
   *  the code, to prevent use from having to get the name (as a wstring)
   *  and then converting it back to ascii.
   */
  readonly attribute string asciiName;
  readonly attribute nsINntpIncomingServer nntpServer;
  attribute boolean saveArticleOffline;
   
  string getGroupPasswordWithUI(in wstring aPromptString, in wstring aPromptTitle, in nsIMsgWindow aMsgWindow);
  string getGroupUsernameWithUI(in wstring aPromptString, in wstring aPromptTitle, in nsIMsgWindow aMsgWindow);

  void forgetGroupUsername();
  void forgetGroupPassword();

  nsIMsgFolder addNewsgroup(in string newsgroupName, in string setStr);

  void getReadSetStr(out string setStr);

  attribute string cachedNewsrcLine;
  readonly attribute string newsrcLine;
  readonly attribute string optionLines;
  readonly attribute string unsubscribedNewsgroupLines;
  void SetNewsrcHasChanged(in boolean newsrcHasChanged);
  void updateSummaryFromNNTPInfo(in long oldest, in long youngest, in long total);
  void removeMessage(in nsMsgKey key); 
  void cancelComplete();
  void cancelFailed();

  string getMessageIdForKey(in nsMsgKey key);

  void getNextNMessages(in nsIMsgWindow aMsgWindow);
  void notifyDownloadedLine(in string line, in nsMsgKey key);
};
