Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIJunkMailPlugin Interface Reference

import "nsIMsgFilterPlugin.idl";

Inheritance diagram for nsIJunkMailPlugin:
Inheritance graph
[legend]
Collaboration diagram for nsIJunkMailPlugin:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void classifyMessage (in string aMsgURI, in nsIMsgWindow aMsgWindow, in nsIJunkMailClassificationListener aListener)
 Given a message URI, determine what its current classification is according to the current training set.
void classifyMessages (in unsigned long aCount,[array, size_is(aCount)] in string aMsgURIs, in nsIMsgWindow aMsgWindow, in nsIJunkMailClassificationListener aListener)
void setMessageClassification (in string aMsgURI, in nsMsgJunkStatus aOldUserClassification, in nsMsgJunkStatus aNewClassification, in nsIMsgWindow aMsgWindow, in nsIJunkMailClassificationListener aListener)
 Called when a user forces the classification of a message.
void resetTrainingData ()
 Removes the training file and clears out any in memory training tokens.
void shutdown ()
 Do any necessary cleanup: flush and close any open files, etc.

Public Attributes

const nsMsgJunkStatus UNCLASSIFIED = 0
 Message classifications.
const nsMsgJunkStatus GOOD = 1
const nsMsgJunkStatus JUNK = 2
readonly attribute boolean userHasClassified
readonly attribute boolean shouldDownloadAllHeaders
 Some protocols (ie IMAP) can, as an optimization, avoid downloading all message header lines.

Detailed Description

Definition at line 81 of file nsIMsgFilterPlugin.idl.


Member Function Documentation

Given a message URI, determine what its current classification is according to the current training set.

void nsIJunkMailPlugin::classifyMessages ( in unsigned long  aCount,
[array, size_is(aCount)] in string  aMsgURIs,
in nsIMsgWindow  aMsgWindow,
in nsIJunkMailClassificationListener  aListener 
)

Removes the training file and clears out any in memory training tokens.

User must retrain after doing this.

void nsIJunkMailPlugin::setMessageClassification ( in string  aMsgURI,
in nsMsgJunkStatus  aOldUserClassification,
in nsMsgJunkStatus  aNewClassification,
in nsIMsgWindow  aMsgWindow,
in nsIJunkMailClassificationListener  aListener 
)

Called when a user forces the classification of a message.

Should cause the training set to be updated appropriately.

  • aMsgURI URI of the message to be classified
  • aOldUserClassification Was it previous manually classified by the user? If so, how?
  • aNewClassification New manual classification.
  • aListener Callback

Do any necessary cleanup: flush and close any open files, etc.


Member Data Documentation

Definition at line 87 of file nsIMsgFilterPlugin.idl.

Definition at line 88 of file nsIMsgFilterPlugin.idl.

Some protocols (ie IMAP) can, as an optimization, avoid downloading all message header lines.

If your plugin doesn't need any more than the minimal set, it can return false for this attribute.

Definition at line 65 of file nsIMsgFilterPlugin.idl.

Message classifications.

Definition at line 86 of file nsIMsgFilterPlugin.idl.

Definition at line 118 of file nsIMsgFilterPlugin.idl.


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