/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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"
interface nsIArray;
interface nsIMsgWindow;
interface nsIUrlListener;
interface nsIMsgDatabase;
interface nsIMsgDBHdr;
interface nsIMsgFolder;
interface nsIMsgCopyServiceListener;

[ptr] native nsLocalFolderScanState(nsLocalFolderScanState);

%{C++
/* flags for markMsgsOnPop3Server */
#define POP3_NONE 0
#define POP3_DELETE 1
#define POP3_FETCH_BODY 2
#define POP3_FORCE_DEL 3

struct nsLocalFolderScanState;
%}

[scriptable, uuid(d3c496fa-9847-4f1c-94dd-0ce92b598ae3)]
interface nsIMsgLocalMailFolder : nsISupports {
  /**
   * set the default flags on the subfolders of this folder, such as
   * Drafts, Templates, etc
   * you should bitwise OR all the flags all mailboxes you want to flag,
   * this function will be smart and find the right names.
   * like nsMsgFolderFlags::Inbox | nsMsgFolderFlags::Drafts | etc
   */
  void setFlagsOnDefaultMailboxes(in unsigned long flags);

  /* 
   * This will return null if the db is out of date
   */
  nsIMsgDatabase getDatabaseWOReparse();

  /*
   * This will kick off a url to reparse the db if it's out of date.
   * If aReparseUrlListener isn ull, folder will use itself as the listener
   */
  nsIMsgDatabase getDatabaseWithReparse(in nsIUrlListener aReparseUrlListener, in nsIMsgWindow aMsgWindow);
  void parseFolder(in nsIMsgWindow aMsgWindow, in nsIUrlListener listener);
  void copyFolderLocal(in nsIMsgFolder srcFolder, in boolean isMove, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener );
  void copyAllSubFolders(in nsIMsgFolder srcFolder, in nsIMsgWindow msgWindow, in nsIMsgCopyServiceListener listener );
  void onCopyCompleted(in nsISupports aSrcSupport, in boolean aMoveCopySucceeded);
  attribute boolean checkForNewMessagesAfterParsing;
  void markMsgsOnPop3Server(in nsIArray aMessages, in PRInt32 aMark);
  void refreshSizeOnDisk(); // file size on disk has possibly changed - update and notify

  /**
   * Creates a subfolder to the current folder with the passed in folder name.
   * @param aFolderName name of the folder to create.
   *
   * @return newly created folder.
   */
  nsIMsgFolder createLocalSubfolder(in AString aFolderName);

  // this adds a message to the end of the folder, parsing it as it goes, and
  // applying filters, if applicable.
  void addMessage(in string aMessage);
  /**
   * Add one or more messages to the end of the folder in a single batch.  Each
   * batch requires an fsync() on the mailbox file so it is a good idea to
   * try and minimize the number of calls you make to this method or addMessage.
   *
   * Filters are applied, if applicable.
   *
   * @param aMessageCount The number of messages.
   * @param aMessages An array of pointers to strings containing entire message
   *     bodies.
   */
  void addMessageBatch(in PRUint32 aMessageCount,
                       [array, size_is(aMessageCount)] in string aMessages);

  /**
   * functions for updating the UI while running DownloadMessagesForOffline:
   * delete the old message before adding its newly downloaded body, and
   * select the new message after it has replaced the old one
   */
  void deleteDownloadMsg(in nsIMsgDBHdr aMsgHdr, out boolean aDoSelect);
  void selectDownloadMsg();
  void notifyDelete();

  /**
   * functions for grubbing thru a folder to find the Uidl for a
   * given msgDBHdr
   */
  [noscript] void getFolderScanState(in nsLocalFolderScanState aState);
  [noscript] void getUidlFromFolder(in nsLocalFolderScanState aState, in nsIMsgDBHdr aMsgHdr);

  boolean warnIfLocalFileTooBig(in nsIMsgWindow aWindow);

  /**
   * Update properties on a new header from an old header, for cases where
   * a partial message will be replaced with a full message.
   *
   * @param   aOldHdr  message header used as properties source
   * @param   aNewHdr  message header used as properties destination
   */
  void updateNewMsgHdr(in nsIMsgDBHdr aOldHdr, in nsIMsgDBHdr aNewHdr);
};
