Package org.deltava.beans.system

Class IMAPConfiguration

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.system.IMAPConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Object>, Auditable, IDBean, ViewEntry, Cacheable

public class IMAPConfiguration
extends DatabaseBean
implements Auditable, ViewEntry

A bean to store IMAP mailbox data.

Since:

1.0

Version:

10.5

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IMAPConfiguration(int id, String addr)	Creates a new e-mail configuration bean.

Method Summary

Modifier and Type	Method	Description
void	addAlias(String alias)	Adds a new alias to this mailbox.
boolean	getActive()	Returns if the mailbox is active.
String	getAddress()	Returns the primary e-mail address.
Collection<String>	getAliases()	Returns all aliases for this mailbox.
boolean	getAllowSMTP()	Returns if this mailbox allows direct SMTP connetions.
String	getAuditID()	Returns the object ID for this auditable object.
String	getMailDirectory()	Returns the mailbox maildir directory.
int	getQuota()	Returns the mailbox quota.
String	getRowClassName()	Returns the CSS class for this object if rendered in a view table.
void	setActive(boolean active)	Marks this mailbox as active.
void	setAddress(String addr)	Updates the primary address for this mailbox.
void	setAliases(Collection<String> aliases)	Updates the aliases for this mailbox.
void	setAllowSMTP(boolean allowSMTP)	Marks this mailbox as allowing direct SMTP access.
void	setMailDirectory(String path)	Updates the mailbox directory.
void	setQuota(int quota)	Updates the size quota for this mailbox.

Methods inherited from class org.deltava.beans.DatabaseBean

cacheKey, compareTo, equals, getHexID, getID, hashCode, setID, validateID, validateID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.beans.Auditable

getAuditType, isCrossApp

Constructor Details

IMAPConfiguration

public IMAPConfiguration(int id,
 String addr)

Creates a new e-mail configuration bean.

Parameters:

id - the Pilot's database ID

addr - the primary e-mail address

Throws:

NullPointerException - if addr is null

See Also:

• setAddress(String)

Method Details

getAddress

public String getAddress()

Returns the primary e-mail address.

Returns:

the address

See Also:

• setAddress(String)

getQuota

public int getQuota()

Returns the mailbox quota.

Returns:

the quota size in bytes

See Also:

• setQuota(int)

getMailDirectory

public String getMailDirectory()

Returns the mailbox maildir directory.

Returns:

the maildir path

See Also:

• setMailDirectory(String)

getActive

public boolean getActive()

Returns if the mailbox is active.

Returns:

TRUE if the mailbox is active, otherwise FALSE

See Also:

• setActive(boolean)

getAllowSMTP

public boolean getAllowSMTP()

Returns if this mailbox allows direct SMTP connetions.

Returns:

TRUE if SMTP connections allowed, otherwise FALSE

See Also:

• setAllowSMTP(boolean)

getAliases

public Collection<String> getAliases()

Returns all aliases for this mailbox.

Returns:

a Collection of alias addresses

See Also:

• setAliases(Collection)
• addAlias(String)

addAlias

public void addAlias(String alias)

Adds a new alias to this mailbox.

Parameters:

alias - the new address

Throws:

NullPointerException - if alias is null

See Also:

• getAliases()
• setAliases(Collection)

setAliases

public void setAliases(Collection<String> aliases)

Updates the aliases for this mailbox.

Parameters:

aliases - a new Collection of alias addresses

Throws:

NullPointerException - if any element is null

See Also:

• addAlias(String)
• getAliases()

setAddress

public void setAddress(String addr)

Updates the primary address for this mailbox.

Parameters:

addr - the address

Throws:

NullPointerException - if addr is null

See Also:

• getAddress()

setQuota

public void setQuota(int quota)

Updates the size quota for this mailbox.

Parameters:

quota - the quota in bytes

See Also:

• getQuota()

setMailDirectory

public void setMailDirectory(String path)

Updates the mailbox directory.

Parameters:

path - the mail directory

Throws:

NullPointerException - if path is null

See Also:

• getMailDirectory()

setActive

public void setActive(boolean active)

Marks this mailbox as active.

Parameters:

active - TRUE if the mailbox is active, otherwise FALSE

See Also:

• getActive()

setAllowSMTP

public void setAllowSMTP(boolean allowSMTP)

Marks this mailbox as allowing direct SMTP access.

Parameters:

allowSMTP - TRUE if direct SMTP connections allowed, otherwise FALSE

See Also:

• getAllowSMTP()

getRowClassName

public String getRowClassName()

Description copied from interface: ViewEntry

Returns the CSS class for this object if rendered in a view table.

Specified by:

getRowClassName in interface ViewEntry

Returns:

the CSS class name, or NULL if none

getAuditID

public String getAuditID()

Description copied from interface: Auditable

Returns the object ID for this auditable object.

Specified by:

getAuditID in interface Auditable

Returns:

the ID