gecko-dev/mailnews/base/public/nsIMsgIncomingServer.idl
sspitzer%netscape.com e40911db58 changes to support the new "none" incoming server type.
divorce "pop3" from local mail.  (more to be done here).
general code clean up.
fix #12873 and #12801
1999-09-01 06:08:19 +00:00

89 lines
2.7 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; 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 "nsISupports.idl"
interface nsIFolder;
interface nsIMsgFolderCache;
/*
* Interface for incoming mail/news host
* this is the base interface for all mail server types (imap, pop, nntp, etc)
* often you will want to add extra interfaces that give you server-specific
* attributes and methods.
*/
[scriptable, uuid(60dcb100-e3f2-11d2-b7fc-00805f05ffa5)]
interface nsIMsgIncomingServer : nsISupports {
/* internal pref key */
attribute string key;
/* pretty name - should be "userid on hostname" if this pref is not set */
attribute wstring prettyName;
/* hostname of the server */
attribute string hostName;
/* userid to log into the server */
attribute string username;
/* server type, i.e. "pop3", "imap", "nntp", "none", etc */
attribute string type;
/* should we remember the password? */
attribute boolean rememberPassword;
/* the password to login with (in cleartext for now)
aWithUI is a flag where the caller can decide if they
want us to bring up UI to ask for the password. If you pass
in false, we will return an empty password if we don't know
it already and we will NOT ask the user */
void GetPassword(in boolean aWithUI, out string aPassword);
void SetPassword(in string aPassword);
/* should we download whole messages when biff goes off? */
attribute boolean downloadOnBiff;
/* should we biff the server? */
attribute boolean doBiff;
/* how often to biff */
attribute long biffMinutes;
/* the on-disk path to message storage for this server */
attribute string localPath;
/* the RDF URI for the root mail folder */
readonly attribute string serverURI;
/* the root folder for this server */
attribute nsIFolder RootFolder;
/* are we already getting new Messages on the current server..
This is used to help us prevent multiple get new msg commands from
going off at the same time. */
attribute boolean serverBusy;
/* do a biff */
void PerformBiff();
void WriteToFolderCache(in nsIMsgFolderCache folderCache);
};