Back to index

lightning-sunbird  0.9+nobinonly
nsIImportMailboxDescriptor.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; 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 /*
00039 
00040   Interface for importing mail - ui provided by the import module.  If
00041   you wish to provide your own UI then implement the nsIImportGeneric
00042   interface.
00043   
00044  */
00045 
00046 #include "nsISupports.idl"
00047 
00048 interface nsIFileSpec;
00049 
00050 [scriptable, uuid(d92056c0-184d-11d3-a206-00a0cc26da63)]
00051 interface nsIImportMailboxDescriptor : nsISupports
00052 {      
00053        attribute unsigned long            identifier;
00054        attribute unsigned long                   depth;
00055        attribute unsigned long                   size;
00056        
00057        wstring       GetDisplayName();
00058        void   SetDisplayName( [const] in wstring name);
00059        
00060        attribute boolean                         import;
00061        readonly attribute nsIFileSpec     fileSpec;
00062 };
00063        
00064 
00065 
00066 %{ C++
00067 
00068 /*
00069        The default implementation can be obtained from
00070        nsIImportService::CreateNewMailboxDescriptor();
00071        
00072        You should only be interested in using this class if you implement
00073        the nsIImportMail interface in which case, just using the service to
00074        create new ones should work fine for you.  If not, implement your
00075        own.
00076 */
00077 
00078 %}