gecko-dev/mailnews/base/public/nsIMsgProtocolInfo.idl

108 lines
3.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsISupports.idl"
#include "nsIFileSpec.idl"
%{C++
#define NS_MSGPROTOCOLINFO_CONTRACTID_PREFIX \
"@mozilla.org/messenger/protocol/info;1?type="
%}
[scriptable, uuid(53d0214a-689c-11d3-80f5-00a0c900d445)]
interface nsIMsgProtocolInfo : nsISupports
{
/**
* the default path to store local data for this type of
* server. Each server is usually in a subdirectory below this
*/
attribute nsIFileSpec defaultLocalPath;
/**
* the IID of the protocol-specific interface for this server
* usually used from JS to dynamically get server-specific attributes
*/
readonly attribute nsIIDPtr serverIID;
/**
* does this server type require a username?
* for instance, news does not but IMAP/POP do
*/
readonly attribute boolean requiresUsername;
/**
* if the pretty name of the server should
* just be the e-mail address. Otherwise it usually
* ends up being something like "news on hostname"
*/
readonly attribute boolean preflightPrettyNameWithEmailAddress;
/**
* can this type of server be removed from the account manager?
* for instance, local mail is not removable
*/
readonly attribute boolean canDelete;
/**
* can this type of server log in at startup?
*/
readonly attribute boolean canLoginAtStartUp;
/**
* can you duplicate this server?
* for instance, local mail is unique and should not be duplicated.
*/
readonly attribute boolean canDuplicate;
/**
* Whether Fcc/Sent/etc should be on this server or
* on a local server
*/
readonly attribute boolean defaultCopiesAndFoldersPrefsToServer;
/* the default port
This is similar to nsIProtocolHanderl.defaultPort,
but for architectural reasons, there is a mail-specific interface to this.
When the input param isSecure is set to true, for all supported protocols,
the secure port value is returned. If isSecure is set to false the default
port value is returned */
long getDefaultServerPort(in boolean isSecure);
/**
* An attribute that tell us whether on not we can
* get messages for the given server type
*/
readonly attribute boolean canGetMessages;
/**
* do biff by default?
*/
readonly attribute boolean defaultDoBiff;
/**
* do we need to show compose message link in the AccountCentral page ?
*/
readonly attribute boolean showComposeMsgLink;
};