dca::ZlaClassifier Class Reference

#include <zla_classifier.h>

Detailed Description

ZLA classifier object for ZLA classification.

See also

ZlaClassification, ZlaClassificationResult

The following sample shows the ZLA classification workflow:

// assume we have a valid DcaInstance (myDca) and License (myLicense)
 
// initialize the ZLA Classification module
dca::ZlaClassification myZlaClassification = 
        dca::ZlaClassification::create( myDca, myLicense );
 
// create a ZLA Classifier
dca::ZlaClassifier myZlaClassifier = myZlaClassification.createClassifier();
 
// create an email object
// assume we have the contents of a valid RFC 2822 conform email in 
// std::string myEmailContent
dca::Email myEmail = dca::Email::create( myDca, myEmailContent );
 
// declare the classification results
dca::ZlaClassificationResult myZlaClassificationResult;
 
// run the classification
dca::FunctionResult myResult = 
        myZlaClassifier.classify( myEmail, myZlaClassificationResult );
 
// if myResult returns false an error occurred
if( !myResult ) {
        std::cout << "Received error from ZLA Classification (Error code: " <<
                myResult.getReturnCode() << ", Description: " <<
                myResult.getDescription() << ")." << std::endl;
        return;
}
 
std::cout << "Result=" << myZlaClassificationResult.result() << 
        ", Module=" << myZlaClassificationResult.module();
 
if( myZlaClassificationResult.result() == ZLA_SPAM ) {
        std::cout << " SPAM";
}
else if( myZlaClassificationResult.result() == ZLA_HAM ) {
        std::cout << " HAM";
}
else if( myZlaClassificationResult.result() == ZLA_NDR ) {
        std::cout << " NDR";
}
else if( myZlaClassificationResult.result() == ZLA_UNKNOWN ) {
        std::cout << " UNKNOWN";
}
 

Definition at line 32 of file zla_classifier.h.

Public Member Functions
FunctionResult	classify (const Email &anEmail, ZlaClassificationResult &aZlaResult) const
	The email classification method. The method takes an initialized Email object and returns the results in a ZlaClassificationResult object. More...

Member Function Documentation

classify()

FunctionResult dca::ZlaClassifier::classify	(	const Email &	anEmail,
		ZlaClassificationResult &	aZlaResult
	)		const

The email classification method. The method takes an initialized Email object and returns the results in a ZlaClassificationResult object.

Parameters

[in]	anEmail	The Email object to be classified
[out]	aZlaResult	The result of the ZLA Email classification

Returns

DCA_SUCCESS or one of the following error codes

• DCA Generic Error Codes

See also

ZlaClassification, Email, ZlaClassificationResult

---

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

• zla_classifier.h