nsIMsgSearchSession Interface Reference

import "nsIMsgSearchSession.idl";

Collaboration diagram for nsIMsgSearchSession:

List of all members.

Public Member Functions
void	addSearchTerm (in nsMsgSearchAttribValue attrib, in nsMsgSearchOpValue op, in nsIMsgSearchValue value, in boolean BooleanAND, in string customString)
	add a search term to the search session
nsIMsgSearchTerm	createTerm ()
void	appendTerm (in nsIMsgSearchTerm term)
void	registerListener (in nsIMsgSearchNotify listener)
void	unregisterListener (in nsIMsgSearchNotify listener)
void	getNthSearchTerm (in long whichTerm, in nsMsgSearchAttribValue attrib, in nsMsgSearchOpValue op, in nsIMsgSearchValue value)
long	countSearchScopes ()
void	getNthSearchScope (in long which, out nsMsgSearchScopeValue scopeId, out nsIMsgFolder folder)
void	addScopeTerm (in nsMsgSearchScopeValue scope, in nsIMsgFolder folder)
void	addDirectoryScopeTerm (in nsMsgSearchScopeValue scope)
void	clearScopes ()
boolean	ScopeUsesCustomHeaders (in nsMsgSearchScopeValue scope, in voidPtr selection, in boolean forFilters)
boolean	IsStringAttribute (in nsMsgSearchAttribValue attrib)
void	AddAllScopes (in nsMsgSearchScopeValue attrib)
void	search (in nsIMsgWindow aWindow)
void	interruptSearch ()
void	pauseSearch ()
void	resumeSearch ()
nsMsgSearchType	SetSearchParam (in nsMsgSearchType type, in voidPtr param)
void	AddResultElement (in nsMsgResultElement element)
boolean	MatchHdr (in nsIMsgDBHdr aMsgHdr, in nsIMsgDatabase aDatabase)
void	addSearchHit (in nsIMsgDBHdr header, in nsIMsgFolder folder)
Public Attributes
readonly attribute nsISupportsArray	searchTerms
readonly attribute unsigned long	numSearchTerms
readonly attribute nsIMsgSearchAdapter	runningAdapter
readonly attribute voidPtr	searchParam
readonly attribute nsMsgSearchType	searchType
readonly attribute long	numResults
attribute nsIMsgWindow	window
const long	BooleanOR = 0
const long	BooleanAND = 1

---

Member Function Documentation

void nsIMsgSearchSession::AddAllScopes

(

in nsMsgSearchScopeValue

attrib

)

void nsIMsgSearchSession::addDirectoryScopeTerm

(

in nsMsgSearchScopeValue

scope

)

void nsIMsgSearchSession::AddResultElement

(

in nsMsgResultElement

element

)

void nsIMsgSearchSession::addScopeTerm	(	in nsMsgSearchScopeValue	scope,
		in nsIMsgFolder	folder
	)

void nsIMsgSearchSession::addSearchHit	(	in nsIMsgDBHdr	header,
		in nsIMsgFolder	folder
	)

void nsIMsgSearchSession::addSearchTerm	(	in nsMsgSearchAttribValue	attrib,
		in nsMsgSearchOpValue	op,
		in nsIMsgSearchValue	value,
		in boolean	BooleanAND,
		in string	customString
	)

add a search term to the search session

Parameters:

	attrib	search attribute (e.g. nsMsgSearchAttrib::Subject)
	op	search operator (e.g. nsMsgSearchOp::Contains)
	value	search value (e.g. "Dogbert", see nsIMsgSearchValue)
	BooleanAND	set to true if associated boolean operator is AND
	customString	if attrib > nsMsgSearchAttrib::OtherHeader, a user defined arbitrary header if attrib == nsMsgSearchAttrib::Custom, the custom id otherwise ignored

void nsIMsgSearchSession::appendTerm

(

in nsIMsgSearchTerm

term

)

void nsIMsgSearchSession::clearScopes

(

)

long nsIMsgSearchSession::countSearchScopes

(

)

nsIMsgSearchTerm nsIMsgSearchSession::createTerm

(

)

void nsIMsgSearchSession::getNthSearchScope	(	in long	which,
		out nsMsgSearchScopeValue	scopeId,
		out nsIMsgFolder	folder
	)

void nsIMsgSearchSession::getNthSearchTerm	(	in long	whichTerm,
		in nsMsgSearchAttribValue	attrib,
		in nsMsgSearchOpValue	op,
		in nsIMsgSearchValue	value
	)

void nsIMsgSearchSession::interruptSearch

(

)

boolean nsIMsgSearchSession::IsStringAttribute

(

in nsMsgSearchAttribValue

attrib

)

boolean nsIMsgSearchSession::MatchHdr	(	in nsIMsgDBHdr	aMsgHdr,
		in nsIMsgDatabase	aDatabase
	)

void nsIMsgSearchSession::pauseSearch

(

)

void nsIMsgSearchSession::registerListener

(

in nsIMsgSearchNotify

listener

)

void nsIMsgSearchSession::resumeSearch

(

)

boolean nsIMsgSearchSession::ScopeUsesCustomHeaders	(	in nsMsgSearchScopeValue	scope,
		in voidPtr	selection,
		in boolean	forFilters
	)

void nsIMsgSearchSession::search

(

in nsIMsgWindow

aWindow

)

nsMsgSearchType nsIMsgSearchSession::SetSearchParam	(	in nsMsgSearchType	type,
		in voidPtr	param
	)

void nsIMsgSearchSession::unregisterListener

(

in nsIMsgSearchNotify

listener

)

---

Member Data Documentation

const long nsIMsgSearchSession::BooleanAND = 1

const long nsIMsgSearchSession::BooleanOR = 0

readonly attribute long nsIMsgSearchSession::numResults

readonly attribute unsigned long nsIMsgSearchSession::numSearchTerms

readonly attribute nsIMsgSearchAdapter nsIMsgSearchSession::runningAdapter

readonly attribute voidPtr nsIMsgSearchSession::searchParam

readonly attribute nsISupportsArray nsIMsgSearchSession::searchTerms

readonly attribute nsMsgSearchType nsIMsgSearchSession::searchType

attribute nsIMsgWindow nsIMsgSearchSession::window

---

The documentation for this interface was generated from the following file:

• nsIMsgSearchSession.idl