org.wcb.autohome.implementations
Class EmailHeaderBean

java.lang.Object
  org.wcb.autohome.implementations.EmailHeaderBean

All Implemented Interfaces:

java.io.Serializable

public class EmailHeaderBean

extends java.lang.Object

implements java.io.Serializable

Copyright (C) 1999 Walter Bogaardt This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 EmailHeaderBean.java Created on February 2, 2004, 7:59 PM

Author:

wbogaardt Project: Home Automation Interface Filename: $Id: EmailHeaderBean.java,v 1.2 2004/02/27 01:29:52 wbogaardt Exp $ Abstract: This allows persistence of centeralized values accross the sessions and gateways. $Log: EmailHeaderBean.java,v $ Revision 1.2 2004/02/27 01:29:52 wbogaardt modified classes so they conform to Checkstyle format in readability Revision 1.1 2004/02/02 23:40:03 wbogaardt Adding header bean which simplifies saving and geting values from config.ini file

See Also:

Serialized Form

Constructor Summary

EmailHeaderBean(java.lang.String sTo, java.lang.String sFrom, java.lang.String sHost)
This class is suppose to be a wrapper for the interfaces between the AutoHomeSession and the HAGateway and the final properties file.

Method Summary

EmailAuthenticator	getEmailAuthenticator() Gets the email authenticator object.
java.lang.String	getEmailFromAddress() Returns the email from address from the HASConfig.ini file
java.lang.String	getEmailHost() The user's email smtp host that is used to send email messages through.
java.lang.String	getEmailNoticeFreq() Email Notice frequency which is either never, on event, hourly, 12 hours, daily, weekly.
java.lang.String	getEmailToAddress() Gets the email address that notifications are sent to, and which the user has saved through configuring it.
void	setEmailAuthenticator(EmailAuthenticator auth) Allows setting of email authentication since the user email account may require authentication
void	setEmailFromAddress(java.lang.String sFrom) This sets the from address in the email so it does not always have to come from the default address of alice@localhost The user can set this to what ever address they want.
void	setEmailHost(java.lang.String sHost) The user can save the SMTP host to the HASConfig.ini file.
void	setEmailNoticeFreq(java.lang.String sFreq) Allows the user to save the frequency of events as never, on event, hourly, 12 hours, daily, weekly.
void	setEmailToAddress(java.lang.String sTo) Gets the email address that notifications are sent to, and which the user has saved through configuring it.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailHeaderBean

public EmailHeaderBean(java.lang.String sTo,
                       java.lang.String sFrom,
                       java.lang.String sHost)

This class is suppose to be a wrapper for the interfaces between the AutoHomeSession and the HAGateway and the final properties file. This class makes it easier for the different properties to be passed around.

Parameters:

sTo - the to address for email

sFrom - the from address for email

sHost - the smtp host address

Method Detail

setEmailToAddress

public void setEmailToAddress(java.lang.String sTo)

Gets the email address that notifications are sent to, and which the user has saved through configuring it.

Parameters:

sTo - send to address

setEmailFromAddress

public void setEmailFromAddress(java.lang.String sFrom)

This sets the from address in the email so it does not always have to come from the default address of alice@localhost The user can set this to what ever address they want.

Parameters:

sFrom - user defined email from address

setEmailHost

public void setEmailHost(java.lang.String sHost)

The user can save the SMTP host to the HASConfig.ini file.

Parameters:

sHost - Email host address

setEmailAuthenticator

public void setEmailAuthenticator(EmailAuthenticator auth)

Allows setting of email authentication since the user email account may require authentication

Parameters:

auth - The email authenticator object which extends the Java mail Authenticator

setEmailNoticeFreq

public void setEmailNoticeFreq(java.lang.String sFreq)

Allows the user to save the frequency of events as never, on event, hourly, 12 hours, daily, weekly.

Parameters:

sFreq - never, onevent, hourly, 12hours, daily, weekly

getEmailToAddress

public java.lang.String getEmailToAddress()

Gets the email address that notifications are sent to, and which the user has saved through configuring it.

Returns:

Email send to address

getEmailFromAddress

public java.lang.String getEmailFromAddress()

Returns the email from address from the HASConfig.ini file

Returns:

The saved from email address

getEmailHost

public java.lang.String getEmailHost()

The user's email smtp host that is used to send email messages through.

Returns:

The saved SMTP host name

getEmailAuthenticator

public EmailAuthenticator getEmailAuthenticator()

Gets the email authenticator object.

Returns:

The email requires authentication. This extends the Java mail Authenticator

getEmailNoticeFreq

public java.lang.String getEmailNoticeFreq()

Email Notice frequency which is either never, on event, hourly, 12 hours, daily, weekly.

Returns:

String of never, onevent, hourly, 12hours, daily, weekly