com.extrememessaging.ResponseMaster

Class CMessage

java.lang.Object

com.extrememessaging.ResponseMaster.CMessage

public class CMessage
extends java.lang.Object

Extreme Messaging's wrapper of a Java mail message Manages access to the message fields.

Constructor Summary

Constructors

Constructor and Description
CMessage(jakarta.mail.Message oMsg) Create my message from a java mail message

Method Summary

Modifier and Type	Method and Description
void	Delete() Delete the message from the mailbox
java.lang.String	getField(int eMessageField)
java.lang.String	getField(int eMessageField, boolean convertToLowercase, boolean stripWhitespace) This is used primarily by the categorization rule items.
java.lang.String	getField(java.lang.String FieldName)
java.util.Date	getFieldAsDate(int eMessageField)
java.util.Date	getFieldAsDate(java.lang.String FieldName)
java.lang.Object	getFieldAsObject(int eMessageField)
java.lang.Object	getFieldAsObject(java.lang.String FieldName)
java.lang.String	getFieldNonNull(int eMessageField)
java.lang.String	getFieldNonNull(java.lang.String FieldName)
java.lang.String	getInfoForLogging()
void	SetField(java.lang.String FieldName, java.lang.Object newValue) Set the value of a field used by MessageField objects to set the value of another field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CMessage

public CMessage(jakarta.mail.Message oMsg)
         throws jakarta.mail.MessagingException

Create my message from a java mail message

Parameters:

oMsg - The java message to create our message from

Throws:

jakarta.mail.MessagingException - when PassMessages on the MessageField throws it.

Method Detail

SetField

public void SetField(java.lang.String FieldName,
                     java.lang.Object newValue)

Set the value of a field used by MessageField objects to set the value of another field. For example, the AttachmentBody is set by the Body message field.

Parameters:

FieldName - The name of the field to set

newValue - The new value to set it to

getField

public java.lang.String getField(int eMessageField)

Parameters:

eMessageField - The integer identifier of the field

Returns:

The value of the field as a string

getField

public java.lang.String getField(int eMessageField,
                                 boolean convertToLowercase,
                                 boolean stripWhitespace)

This is used primarily by the categorization rule items. It uses a cache to avoid doing the work several times.

Parameters:

eMessageField - The integer identifier of the field

convertToLowercase - If true, the result is converted to lower case

stripWhitespace - If true, the whitespace is removed from the result

Returns:

The value of the field as a string, optionally converting it to lowercase and/or stripping out the whitespace first.

getFieldNonNull

public java.lang.String getFieldNonNull(int eMessageField)

Parameters:

eMessageField - The integer identifier of the field

Returns:

The value of a field as a string. If the field is null, it returns an empty string.

getFieldNonNull

public java.lang.String getFieldNonNull(java.lang.String FieldName)

Parameters:

FieldName - The name of the field

Returns:

The value of a field as a string. If the field is null, it returns an empty string.

getField

public java.lang.String getField(java.lang.String FieldName)

Parameters:

FieldName - The name of the field

Returns:

The value of the field as a string

getFieldAsDate

public java.util.Date getFieldAsDate(int eMessageField)

Parameters:

eMessageField - The integer identifier of the field

Returns:

The value of the field as a date

getFieldAsDate

public java.util.Date getFieldAsDate(java.lang.String FieldName)

Parameters:

FieldName - The name of the field

Returns:

The value of the field as a date

getFieldAsObject

public java.lang.Object getFieldAsObject(java.lang.String FieldName)

Parameters:

FieldName - The name of the field

Returns:

The value of the field as an object (its native type)

getFieldAsObject

public java.lang.Object getFieldAsObject(int eMessageField)

Parameters:

eMessageField - The integer identifier of the field

Returns:

The value of the field as an object (its native type)

Delete

public void Delete()

Delete the message from the mailbox

getInfoForLogging

public java.lang.String getInfoForLogging()

Returns:

A string that you can use for logging so we know which message is causing a problem in the log.