gecko-dev/mailnews/base/public/nsIMsgAccount.idl
2004-04-17 18:33:16 +00:00

82 lines
2.9 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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 the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "nsIMsgIncomingServer.idl"
#include "nsIMsgIdentity.idl"
#include "nsISupportsArray.idl"
/*
* an account consists of an incoming server and one or more
* outgoing identities
* an account is identitfied by a key, which is the <account> string in
* the account preferences, such as in
* mail.account.<account>.identities
*/
[scriptable, uuid(da368bd0-e624-11d2-b7fc-00805f05ffa5)]
interface nsIMsgAccount : nsISupports {
/* init function */
void init();
/* internal key identifying itself */
attribute string key;
/* incoming server stuff */
attribute nsIMsgIncomingServer incomingServer;
/* outgoing identity list
* array of nsIMsgIdentity's
*/
readonly attribute nsISupportsArray identities;
/* the default identity for this account. */
attribute nsIMsgIdentity defaultIdentity;
/* add a new identity to this account (probably does not work) */
void addIdentity(in nsIMsgIdentity identity);
/* remove an identity from this account (probably does not work) */
void removeIdentity(in nsIMsgIdentity identity);
void clearAllValues();
/* name in javascript */
wstring toString();
};