gecko-dev/mailnews/base/public/nsIMsgFolder.h

/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIMsgFolder.idl
 */

#ifndef __gen_nsIMsgFolder_h__
#define __gen_nsIMsgFolder_h__

#include "nsISupports.h" /* interface nsISupports */
#include "nsIMsgThread.h" /* interface nsIMsgThread */
#include "nsIMsgIncomingServer.h" /* interface nsIMsgIncomingServer */
#include "MailNewsTypes.h" /* interface MailNewsTypes */
#include "nsICollection.h" /* interface nsICollection */
#include "nsIFolderListener.h" /* interface nsIFolderListener */
#include "nsrootidl.h" /* interface nsrootidl */
#include "nsIEnumerator.h" /* interface nsIEnumerator */
#include "nsIFolder.h" /* interface nsIFolder */
#include "nsFileSpec.h"
#include "nsISupportsArray.h"
#include "nsIMessage.h"

class nsISupportsArray; /* forward decl */
class nsIMessage; /* forward decl */

/* starting interface:    nsIMsgFolder */

/* {85e39ff0-b248-11d2-b7ef-00805f05ffa5} */
#define NS_IMSGFOLDER_IID_STR "85e39ff0-b248-11d2-b7ef-00805f05ffa5"
#define NS_IMSGFOLDER_IID \
  {0x85e39ff0, 0xb248, 0x11d2, \
    { 0xb7, 0xef, 0x00, 0x80, 0x5f, 0x05, 0xff, 0xa5 }}

class nsIMsgFolder : public nsIFolder {
 public: 
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMSGFOLDER_IID)

  /* void AddUnique (in nsISupports element); */
  NS_IMETHOD AddUnique(nsISupports *element) = 0;

  /* void ReplaceElement (in nsISupports element, in nsISupports newElement); */
  NS_IMETHOD ReplaceElement(nsISupports *element, nsISupports *newElement) = 0;

  /* nsIEnumerator GetMessages (); */
  NS_IMETHOD GetMessages(nsIEnumerator **_retval) = 0;

  /* nsIEnumerator GetThreads (); */
  NS_IMETHOD GetThreads(nsIEnumerator **_retval) = 0;

  /* nsIMsgThread GetThreadForMessage (in nsIMessage message); */
  NS_IMETHOD GetThreadForMessage(nsIMessage *message, nsIMsgThread **_retval) = 0;

  /* boolean HasMessage (in nsIMessage message); */
  NS_IMETHOD HasMessage(nsIMessage *message, PRBool *_retval) = 0;

  /* nsIEnumerator GetVisibleSubFolders (); */
  NS_IMETHOD GetVisibleSubFolders(nsIEnumerator **_retval) = 0;

  /* attribute string prettyName; */
  NS_IMETHOD GetPrettyName(char * *aPrettyName) = 0;
  NS_IMETHOD SetPrettyName(char * aPrettyName) = 0;

  /* readonly attribute string prettiestName; */
  NS_IMETHOD GetPrettiestName(char * *aPrettiestName) = 0;

  /* string BuildFolderURL (); */
  NS_IMETHOD BuildFolderURL(char **_retval) = 0;

  /* readonly attribute boolean deleteIsMoveToTrash; */
  NS_IMETHOD GetDeleteIsMoveToTrash(PRBool *aDeleteIsMoveToTrash) = 0;

  /* readonly attribute boolean showDeletedMessages; */
  NS_IMETHOD GetShowDeletedMessages(PRBool *aShowDeletedMessages) = 0;

  /* readonly attribute nsIMsgIncomingServer server; */
  NS_IMETHOD GetServer(nsIMsgIncomingServer * *aServer) = 0;

  /* void OnCloseFolder (); */
  NS_IMETHOD OnCloseFolder() = 0;

  /* void Delete (); */
  NS_IMETHOD Delete() = 0;

  /* void DeleteSubFolders (in nsISupportsArray folders); */
  NS_IMETHOD DeleteSubFolders(nsISupportsArray *folders) = 0;

  /* void PropagateDelete (in nsIMsgFolder folder, in boolean deleteStorage); */
  NS_IMETHOD PropagateDelete(nsIMsgFolder *folder, PRBool deleteStorage) = 0;

  /* void RecursiveDelete (in boolean deleteStorage); */
  NS_IMETHOD RecursiveDelete(PRBool deleteStorage) = 0;

  /* void CreateSubfolder (in string folderName); */
  NS_IMETHOD CreateSubfolder(const char *folderName) = 0;

  /* void Rename (in string name); */
  NS_IMETHOD Rename(const char *name) = 0;

  /* void Adopt (in nsIMsgFolder srcFolder, out unsigned long outPos); */
  NS_IMETHOD Adopt(nsIMsgFolder *srcFolder, PRUint32 *outPos) = 0;

  /* boolean ContainsChildNamed (in string name); */
  NS_IMETHOD ContainsChildNamed(const char *name, PRBool *_retval) = 0;

  /* boolean IsAncestorOf (in nsIMsgFolder folder); */
  NS_IMETHOD IsAncestorOf(nsIMsgFolder *folder, PRBool *_retval) = 0;

  /* string GenerateUniqueSubfolderName (in string prefix, in nsIMsgFolder otherFolder); */
  NS_IMETHOD GenerateUniqueSubfolderName(const char *prefix, nsIMsgFolder *otherFolder, char **_retval) = 0;

  /* attribute unsigned long depth; */
  NS_IMETHOD GetDepth(PRUint32 *aDepth) = 0;
  NS_IMETHOD SetDepth(PRUint32 aDepth) = 0;

  /* void UpdateSummaryTotals (); */
  NS_IMETHOD UpdateSummaryTotals() = 0;

  /* void SummaryChanged (); */
  NS_IMETHOD SummaryChanged() = 0;

  /* long GetNumUnread (in boolean deep); */
  NS_IMETHOD GetNumUnread(PRBool deep, PRInt32 *_retval) = 0;

  /* long GetTotalMessages (in boolean deep); */
  NS_IMETHOD GetTotalMessages(PRBool deep, PRInt32 *_retval) = 0;

  /* readonly attribute unsigned long expungedBytesCount; */
  NS_IMETHOD GetExpungedBytesCount(PRUint32 *aExpungedBytesCount) = 0;

  /* readonly attribute boolean deletable; */
  NS_IMETHOD GetDeletable(PRBool *aDeletable) = 0;

  /* readonly attribute boolean canCreateChildren; */
  NS_IMETHOD GetCanCreateChildren(PRBool *aCanCreateChildren) = 0;

  /* readonly attribute boolean canBeRenamed; */
  NS_IMETHOD GetCanBeRenamed(PRBool *aCanBeRenamed) = 0;

  /* readonly attribute boolean requiresCleanup; */
  NS_IMETHOD GetRequiresCleanup(PRBool *aRequiresCleanup) = 0;

  /* void ClearRequiresCleanup (); */
  NS_IMETHOD ClearRequiresCleanup() = 0;

  /* readonly attribute boolean knowsSearchNntpExtension; */
  NS_IMETHOD GetKnowsSearchNntpExtension(PRBool *aKnowsSearchNntpExtension) = 0;

  /* readonly attribute boolean allowsPosting; */
  NS_IMETHOD GetAllowsPosting(PRBool *aAllowsPosting) = 0;

  /* boolean DisplayRecipients (); */
  NS_IMETHOD DisplayRecipients(PRBool *_retval) = 0;

  /* readonly attribute string relativePathName; */
  NS_IMETHOD GetRelativePathName(char * *aRelativePathName) = 0;

  /* readonly attribute unsigned long sizeOnDisk; */
  NS_IMETHOD GetSizeOnDisk(PRUint32 *aSizeOnDisk) = 0;

  /* void RememberPassword (in string password); */
  NS_IMETHOD RememberPassword(const char *password) = 0;

  /* string GetRememberedPassword (); */
  NS_IMETHOD GetRememberedPassword(char **_retval) = 0;

  /* boolean UserNeedsToAuthenticateForFolder (in boolean displayOnly); */
  NS_IMETHOD UserNeedsToAuthenticateForFolder(PRBool displayOnly, PRBool *_retval) = 0;

  /* string GetUsersName (); */
  NS_IMETHOD GetUsersName(char **_retval) = 0;

  /* string GetHostName (); */
  NS_IMETHOD GetHostName(char **_retval) = 0;

  /* void SetFlag (in unsigned long flag); */
  NS_IMETHOD SetFlag(PRUint32 flag) = 0;

  /* void ClearFlag (in unsigned long flag); */
  NS_IMETHOD ClearFlag(PRUint32 flag) = 0;

  /* boolean GetFlag (in unsigned long flag); */
  NS_IMETHOD GetFlag(PRUint32 flag, PRBool *_retval) = 0;

  /* void ToggleFlag (in unsigned long flag); */
  NS_IMETHOD ToggleFlag(PRUint32 flag) = 0;

  /* void OnFlagChange (in unsigned long flag); */
  NS_IMETHOD OnFlagChange(PRUint32 flag) = 0;

  /* unsigned long GetFlags (); */
  NS_IMETHOD GetFlags(PRUint32 *_retval) = 0;

  /* void GetFoldersWithFlag (in unsigned long flags, out nsIMsgFolder result, in unsigned long resultsize, out unsigned long numFolders); */
  NS_IMETHOD GetFoldersWithFlag(PRUint32 flags, nsIMsgFolder **result, PRUint32 resultsize, PRUint32 *numFolders) = 0;

  /* void GetExpansionArray (in nsISupportsArray expansionArray); */
  NS_IMETHOD GetExpansionArray(nsISupportsArray *expansionArray) = 0;

  /* void DeleteMessages (in nsISupportsArray message); */
  NS_IMETHOD DeleteMessages(nsISupportsArray *message) = 0;

  /* void AcquireSemaphore (in nsISupports semHolder); */
  NS_IMETHOD AcquireSemaphore(nsISupports *semHolder) = 0;

  /* void ReleaseSemaphore (in nsISupports semHolder); */
  NS_IMETHOD ReleaseSemaphore(nsISupports *semHolder) = 0;

  /* boolean TestSemaphore (in nsISupports semHolder); */
  NS_IMETHOD TestSemaphore(nsISupports *semHolder, PRBool *_retval) = 0;

  /* boolean IsLocked (); */
  NS_IMETHOD IsLocked(PRBool *_retval) = 0;

  /* nsIMessage CreateMessageFromMsgDBHdr (in nsIMsgDBHdr msgDBHdr); */
  NS_IMETHOD CreateMessageFromMsgDBHdr(nsIMsgDBHdr *msgDBHdr, nsIMessage **_retval) = 0;

  /* void GetNewMessages (); */
  NS_IMETHOD GetNewMessages() = 0;

  /* attribute wstring charset; */
  NS_IMETHOD GetCharset(PRUnichar * *aCharset) = 0;
  NS_IMETHOD SetCharset(PRUnichar * aCharset) = 0;
};

/* starting interface:    nsIMsgLocalMailFolder */

/* {27D2DE40-BAF1-11d2-9578-00805F8AC615} */
#define NS_IMSGLOCALMAILFOLDER_IID_STR "27D2DE40-BAF1-11d2-9578-00805F8AC615"
#define NS_IMSGLOCALMAILFOLDER_IID \
  {0x27D2DE40, 0xBAF1, 0x11d2, \
    { 0x95, 0x78, 0x00, 0x80, 0x5F, 0x8A, 0xC6, 0x15 }}

class nsIMsgLocalMailFolder : public nsISupports {
 public: 
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMSGLOCALMAILFOLDER_IID)
};

/* starting interface:    nsIMsgNewsFolder */

/* {3716abe4-f6d4-11d2-86d5-004005263078} */
#define NS_IMSGNEWSFOLDER_IID_STR "3716abe4-f6d4-11d2-86d5-004005263078"
#define NS_IMSGNEWSFOLDER_IID \
  {0x3716abe4, 0xf6d4, 0x11d2, \
    { 0x86, 0xd5, 0x00, 0x40, 0x05, 0x26, 0x30, 0x78 }}

class nsIMsgNewsFolder : public nsISupports {
 public: 
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMSGNEWSFOLDER_IID)
};

/* starting interface:    nsIMsgImapMailFolder */

/* {FBFEBE79-C1DD-11d2-8A40-0060B0FC04D2} */
#define NS_IMSGIMAPMAILFOLDER_IID_STR "FBFEBE79-C1DD-11d2-8A40-0060B0FC04D2"
#define NS_IMSGIMAPMAILFOLDER_IID \
  {0xFBFEBE79, 0xC1DD, 0x11d2, \
    { 0x8A, 0x40, 0x00, 0x60, 0xB0, 0xFC, 0x04, 0xD2 }}

class nsIMsgImapMailFolder : public nsISupports {
 public: 
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IMSGIMAPMAILFOLDER_IID)
};

#endif /* __gen_nsIMsgFolder_h__ */