gecko-dev/mailnews/base/public/nsIMsgFolder.idl
putterman%netscape.com 357b3bff79 More work on threads.
1999-04-07 02:50:25 +00:00

139 lines
4.1 KiB
Plaintext

/* -*- 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.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#include "nsISupportsArray.idl"
#include "nsISupports.idl"
#include "nsIFolder.idl"
#include "nsIMessage.idl"
#include "nsIMsgThread.idl"
%{ C++
#include "nsFileSpec.h"
%}
native nsNativeFileSpec(nsNativeFileSpec*);
[uuid(85e39ff0-b248-11d2-b7ef-00805f05ffa5)]
interface nsIMsgFolder : nsIFolder {
/* already exists in nsIFolder */
/* readonly attribute string name; */
/* void SetName(in string name); */
/* XXX should these 2 go on nsIFolder or nsICollection? */
void AddUnique(in nsISupports element);
void ReplaceElement(in nsISupports element, in nsISupports newElement);
nsIEnumerator GetMessages();
nsIEnumerator GetThreads();
nsIMsgThread GetThreadForMessage(in nsIMessage message);
nsIEnumerator GetVisibleSubFolders();
attribute string prettyName;
readonly attribute string prettiestName;
string BuildFolderURL();
readonly attribute boolean deleteIsMoveToTrash;
readonly attribute boolean showDeletedMessages;
void OnCloseFolder ();
void Delete ();
void PropagateDelete(inout nsIMsgFolder folder, in boolean deleteStorage);
void RecursiveDelete(in boolean deleteStorage);
void CreateSubfolder(in string leafNameFromUser, out nsIMsgFolder outFolder, out unsigned long outPos);
void Rename(in string name);
void Adopt(in nsIMsgFolder srcFolder, out unsigned long outPos);
boolean ContainsChildNamed(in string name);
nsIMsgFolder FindParentOf(in nsIMsgFolder childFolder);
boolean IsParentOf(in nsIMsgFolder folder, in boolean deep);
string GenerateUniqueSubfolderName(in string prefix, in nsIMsgFolder otherFolder);
attribute unsigned long depth;
void UpdateSummaryTotals();
void SummaryChanged();
unsigned long GetNumUnread(in boolean deep);
unsigned long GetTotalMessages(in boolean deep);
readonly attribute unsigned long expungedBytesCount;
readonly attribute boolean deletable;
readonly attribute boolean canCreateChildren;
readonly attribute boolean canBeRenamed;
readonly attribute boolean requiresCleanup;
void ClearRequiresCleanup();
readonly attribute boolean knowsSearchNntpExtension;
readonly attribute boolean allowsPosting;
boolean DisplayRecipients();
void ReadDBFolderInfo(in boolean force);
readonly attribute string relativePathName;
readonly attribute unsigned long sizeOnDisk;
void RememberPassword(in string password);
string GetRememberedPassword();
boolean UserNeedsToAuthenticateForFolder(in boolean displayOnly);
string GetUsersName();
string GetHostName();
void SetFlag(in unsigned long flag);
void ClearFlag(in unsigned long flag);
boolean GetFlag(in unsigned long flag);
void ToggleFlag (in unsigned long flag);
void OnFlagChange (in unsigned long flag);
unsigned long GetFlags();
void GetFoldersWithFlag(in unsigned long flags, out nsIMsgFolder result,
in unsigned long resultsize, out unsigned long numFolders);
void GetExpansionArray(in nsISupportsArray expansionArray);
void DeleteMessage(in nsIMessage message);
void AcquireSemaphore (in nsISupports semHolder);
void ReleaseSemaphore (in nsISupports semHolder);
boolean TestSemaphore (in nsISupports semHolder);
boolean IsLocked();
};
[uuid(27D2DE40-BAF1-11d2-9578-00805F8AC615)]
interface nsIMsgLocalMailFolder : nsISupports {
};
[uuid(FBFEBE79-C1DD-11d2-8A40-0060B0FC04D2)]
interface nsIMsgImapMailFolder : nsISupports {
readonly attribute nsNativeFileSpec pathName;
};