Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgAccount.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 #include "nsIMsgIncomingServer.idl"
00040 #include "nsIMsgIdentity.idl"
00041 #include "nsISupportsArray.idl"
00042 
00043 /*
00044  * an account consists of an incoming server and one or more
00045  * outgoing identities
00046  * an account is identitfied by a key, which is the <account> string in
00047  * the account preferences, such as in
00048  * mail.account.<account>.identities
00049  */
00050 
00051 [scriptable, uuid(da368bd0-e624-11d2-b7fc-00805f05ffa5)]
00052 interface nsIMsgAccount : nsISupports {
00053   
00054   /* init function */
00055   void init();
00056 
00057   /* internal key identifying itself */
00058   attribute string key;
00059   
00060   /* incoming server stuff */
00061   attribute nsIMsgIncomingServer incomingServer;
00062 
00063   /* outgoing identity list
00064    * array of nsIMsgIdentity's
00065    */
00066   readonly attribute nsISupportsArray identities;
00067 
00068   /* the default identity for this account. */
00069   attribute nsIMsgIdentity defaultIdentity;
00070 
00071   /* add a new identity to this account (probably does not work) */
00072   void addIdentity(in nsIMsgIdentity identity);
00073 
00074   /* remove an identity from this account (probably does not work) */
00075   void removeIdentity(in nsIMsgIdentity identity);
00076 
00077   void clearAllValues();
00078   
00079   /* name in javascript */
00080   wstring toString();
00081 };