pjs/mailnews/local/public/nsIMailboxUrl.h

105 строки
3.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#ifndef nsIMailboxUrl_h___
#define nsIMailboxUrl_h___
#include "nscore.h"
#include "MailNewsTypes.h"
#include "nsIMsgMailNewsUrl.h"
#include "nsISupports.h"
#include "nsFileSpec.h"
/* include all of our event sink interfaces */
#include "nsIStreamListener.h"
/* C272A1C1-C166-11d2-804E-006008128C4E */
#define NS_IMAILBOXURL_IID \
{ 0xc272a1c1, 0xc166, 0x11d2, \
{ 0x80, 0x4e, 0x0, 0x60, 0x8, 0x12, 0x8c, 0x4e } }
/* 46EFCB10-CB6D-11d2-8065-006008128C4E */
#define NS_MAILBOXURL_CID \
{ 0x46efcb10, 0xcb6d, 0x11d2, \
{ 0x80, 0x65, 0x0, 0x60, 0x8, 0x12, 0x8c, 0x4e } }
typedef enum {
nsMailboxActionParseMailbox = 0,
nsMailboxActionDisplayMessage,
nsMailboxActionCopyMessage,
nsMailboxActionMoveMessage
} nsMailboxAction;
class nsIMsgDBHdr;
class nsIMailboxUrl : public nsIMsgMailNewsUrl
{
public:
static const nsIID& GetIID() {
static nsIID iid = NS_IMAILBOXURL_IID;
return iid;
}
///////////////////////////////////////////////////////////////////////////////
// Getters and Setters for the mailbox specific event sinks to bind to to your url
///////////////////////////////////////////////////////////////////////////////
// Mailbox urls which parse a mailbox folder require a consumer of the stream which
// will represent the mailbox. This consumer is the mailbox parser. As data from
// the mailbox folder is read in, the data will be written to a stream and the consumer
// will be notified through nsIStreamListenter::OnDataAvailable that the stream has data
// available...
// mscott: I wonder if the caller should be allowed to create and set the stream they want
// the data written to as well? Hmm....
NS_IMETHOD SetMailboxParser(nsIStreamListener * aConsumer) = 0;
NS_IMETHOD GetMailboxParser(nsIStreamListener ** aConsumer) = 0;
///////////////////////////////////////////////////////////////////////////////
// Copy/Move mailbox urls require a mailbox copy handler which actually performs
// the copy.
///////////////////////////////////////////////////////////////////////////////
NS_IMETHOD SetMailboxCopyHandler(nsIStreamListener * aConsumer) = 0;
NS_IMETHOD GetMailboxCopyHandler(nsIStreamListener ** aConsumer) = 0;
///////////////////////////////////////////////////////////////////////////////
// Getters and Setters for the mailbox url state
///////////////////////////////////////////////////////////////////////////////
NS_IMETHOD GetFilePath(const nsFileSpec ** aFilePath) = 0;
// if the mailbox url represents a single message, than this interface will
// return a message db header for that message.
NS_IMETHOD GetMessageHeader(nsIMsgDBHdr ** aMsgHdr) = 0;
// Some mailbox urls include a message key for the message in question.
NS_IMETHOD GetMessageKey(nsMsgKey& aMessageID) = 0;
// mailbox urls to fetch a mail message can specify the size of the message...
// this saves us the trouble of having to open up the msg db and ask ourselves...
NS_IMETHOD SetMessageSize(PRUint32 aMessageSize) = 0;
NS_IMETHOD GetMailboxAction(nsMailboxAction * aMailboxAction) = 0;
NS_IMETHOD SetMailboxAction(nsMailboxAction aMailboxAction) = 0;
};
#endif /* nsIMailboxUrl_h___ */