com.isti.quakewatch.alertemail
Interface AlertEmailSenderInterface

All Superinterfaces:
AlertSenderInterface
All Known Implementing Classes:
AlertEmailSender

public interface AlertEmailSenderInterface
extends AlertSenderInterface

Interface SenderInterface defines an email sender interface.


Method Summary
 AlertMsgDateFormatterInterface getAlertMsgDateFormatter()
          Gets the alert message date formatter.
 JavaMailUtil getJavaMailUtilObj()
          Returns the JavaMail utility object.
 LocationPlacesInterface getLocationPlaces()
          Gets the location places.
 java.lang.String getProgramRevisionText()
          Gets the program revision text.
 boolean isTestMode()
          Determines if in test mode and test messages are to be used.
 boolean sendEmailMessage(AlertEmailRecipientInterface recipObj, AlertEmailMessageInterface emailMsgObj)
          Sends an email message using the given parameters.
 
Methods inherited from interface com.isti.quakewatch.alert.AlertSenderInterface
getDisplayStr, getMaxSendMessageRetries, sendMessage
 

Method Detail

getAlertMsgDateFormatter

AlertMsgDateFormatterInterface getAlertMsgDateFormatter()
Gets the alert message date formatter.

Returns:
the alert message date formatter

getLocationPlaces

LocationPlacesInterface getLocationPlaces()
Gets the location places.

Returns:
the location places.

getJavaMailUtilObj

JavaMailUtil getJavaMailUtilObj()
Returns the JavaMail utility object.

Returns:
The JavaMail utility object.

getProgramRevisionText

java.lang.String getProgramRevisionText()
Gets the program revision text.

Returns:
the program revision text.

isTestMode

boolean isTestMode()
Determines if in test mode and test messages are to be used.

Returns:
true for test messages, false otherwise.

sendEmailMessage

boolean sendEmailMessage(AlertEmailRecipientInterface recipObj,
                         AlertEmailMessageInterface emailMsgObj)
Sends an email message using the given parameters. A "date" header showing the current date will be included in the message. If the previous send attempt failed then this method may perform a wait-delay before sending the message.

Parameters:
recipObj - the alert recipient for the message.
emailMsgObj - the message object for holding the message.
Returns:
true if successful; false if not (in which case a warning message will be logged).