com.ibm.commerce.emarketing.engine

Interface BouncedEmailReporter

All Known Implementing Classes:

POP3BouncedEmailReporter

public interface BouncedEmailReporter

Defines the interface requirements for a class to be considered a bounced e-mail reporter. It is assumed that classes implementing this interface will connect to an e-mail server and retreive the bounce back e-mail messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright.

Method Summary

Modifier and Type	Method and Description
BouncedEmailReport[]	getBouncedEmailReport() Reports the detected bounced messages from email activities.
void	setDeleteMessages(boolean delete) Set to true if the reporter should delete the email messages after it parses them.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright.

See Also:

Constant Field Values

Method Detail

getBouncedEmailReport

BouncedEmailReport[] getBouncedEmailReport()
                                    throws java.net.UnknownHostException,
                                           java.io.IOException

Reports the detected bounced messages from email activities.

Returns:

An array of BouncedEmailReport objects that contains the detected email addresses that bounced for email activities.

Throws:

java.net.UnknownHostException - Thrown when the host name used to connect to the email server is invalid.

java.io.IOException - Thrown when retrieval of email messages from the email server fails.

setDeleteMessages

void setDeleteMessages(boolean delete)

Set to true if the reporter should delete the email messages after it parses them. Default value should be false.

Parameters:

delete - set to true if the reporter should delete the e-mail it parses them.