Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgOfflineImapOperation.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) 2001
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 "MailNewsTypes2.idl"
00040 // #include "nsIImapUrl.idl" // for imapMessageFlagsType
00041 
00042 typedef unsigned short imapMessageFlagsType;
00043 
00044 typedef long nsOfflineImapOperationType;
00045 
00046 [scriptable, uuid(e576dace-db4f-4d23-aa6f-57165504848f)]
00047 
00048 interface nsIMsgOfflineImapOperation : nsISupports
00049 {
00050 // type of stored imap operations
00051   const long kFlagsChanged      = 0x1;
00052   const long kMsgMoved          = 0x2;
00053   const long kMsgCopy           = 0x4;
00054   const long kMoveResult        = 0x8;
00055   const long kAppendDraft       = 0x10;
00056   const long kAddedHeader       = 0x20;
00057   const long kDeletedMsg        = 0x40;
00058   const long kMsgMarkedDeleted     = 0x80;
00059   const long kAppendTemplate    = 0x100;
00060   const long kDeleteAllMsgs     = 0x200;
00061   const long kAddKeywords       = 0x400;
00062   const long kRemoveKeywords    = 0x800;
00063 
00064   attribute nsOfflineImapOperationType operation;
00065   void clearOperation(in nsOfflineImapOperationType operation);
00066   attribute nsMsgKey messageKey;
00067   attribute imapMessageFlagsType flagOperation;
00068   attribute imapMessageFlagsType newFlags; // for kFlagsChanged
00069   attribute string destinationFolderURI; // for move or copy
00070   attribute string sourceFolderURI;
00071   void addKeywordToAdd(in string aKeyword);
00072   void addKeywordToRemove(in string aKeyword);
00073   readonly attribute string keywordsToAdd; 
00074   readonly attribute string keywordsToRemove;
00075   readonly attribute long numberOfCopies;
00076   void addMessageCopyOperation(in string destinationBox);
00077   string getCopyDestination(in long copyIndex);
00078   attribute unsigned long msgSize;
00079 };
00080