/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla 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/MPL/
 *
 * 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 the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

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

interface nsIURI;

[scriptable, uuid(29F76AC4-51FF-4081-A268-B43CACDF4BFF)]
interface nsIPop3Sink : nsISupports {

  attribute boolean userAuthenticated;
  attribute string mailAccountURL;
  attribute boolean buildMessageUri;
  attribute string messageUri;
  attribute string baseMessageUri;

  /// message uri for header-only message version
  attribute ACString origMessageUri;

  boolean BeginMailDelivery(in boolean uidlDownload, in nsIMsgWindow msgWindow);
  void endMailDelivery(in nsIPop3Protocol protocol);
  void AbortMailDelivery(in nsIPop3Protocol protocol);

  /* returns a closure ? */
  [noscript] voidPtr IncorporateBegin(in string uidlString, in nsIURI aURL,
                                      in unsigned long flags);

  [noscript] void IncorporateWrite(in string block,
                                   in long length);

  [noscript] void IncorporateComplete(in nsIMsgWindow aMsgWindow, in PRInt32 aSize);
  [noscript] void IncorporateAbort(in boolean uidlDownload);

  void BiffGetNewMail();

  void SetBiffStateAndUpdateFE(in unsigned long biffState, in long numNewMessages, in boolean notify);

  [noscript] void SetSenderAuthedFlag(in voidPtr closure, in boolean authed);

  attribute nsIPop3IncomingServer popServer;
  attribute nsIMsgFolder folder;

};
