Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgProtocolInfo.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIFileSpec;
00041 
00042 %{C++
00043 #define NS_MSGPROTOCOLINFO_CONTRACTID_PREFIX \
00044   "@mozilla.org/messenger/protocol/info;1?type="
00045 %}
00046 
00047 
00048 [scriptable, uuid(53d0214a-689c-11d3-80f5-00a0c900d445)]
00049 interface nsIMsgProtocolInfo : nsISupports
00050 {
00055     attribute nsIFileSpec defaultLocalPath;
00056 
00061     readonly attribute nsIIDPtr serverIID;
00062 
00067     readonly attribute boolean requiresUsername;
00068 
00074     readonly attribute boolean preflightPrettyNameWithEmailAddress;
00075 
00080     readonly attribute boolean canDelete;
00081 
00085     readonly attribute boolean canLoginAtStartUp;
00086 
00091     readonly attribute boolean canDuplicate;
00092 
00093     /* the default port
00094        This is similar to nsIProtocolHanderl.defaultPort,
00095        but for architectural reasons, there is a mail-specific interface to this.
00096        When the input param isSecure is set to true, for all supported protocols, 
00097        the secure port value is returned. If isSecure is set to false the default
00098        port value is returned  */
00099     long getDefaultServerPort(in boolean isSecure);
00100 
00108     readonly attribute boolean canGetMessages;
00109 
00114     readonly attribute boolean canGetIncomingMessages;
00115 
00119     readonly attribute boolean defaultDoBiff;
00120 
00124     readonly attribute boolean showComposeMsgLink;
00125 
00132     readonly attribute boolean needToBuildSpecialFolderURIs;
00133 
00137     readonly attribute boolean specialFoldersDeletionAllowed;
00138 };
00139