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
A bean to store IMAP mailbox data.
- Since:
- 1.0
- Version:
- 10.5
- Author:
- Luke
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionIMAPConfiguration
(int id, String addr) Creates a new e-mail configuration bean. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a new alias to this mailbox.boolean
Returns if the mailbox is active.Returns the primary e-mail address.Returns all aliases for this mailbox.boolean
Returns if this mailbox allows direct SMTP connetions.Returns the object ID for this auditable object.Returns the mailbox maildir directory.int
getQuota()
Returns the mailbox quota.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
Creates a new e-mail configuration bean.- Parameters:
id
- the Pilot's database IDaddr
- the primary e-mail address- Throws:
NullPointerException
- if addr is null- See Also:
-
-
Method Details
-
getAddress
-
getQuota
public int getQuota()Returns the mailbox quota.- Returns:
- the quota size in bytes
- See Also:
-
getMailDirectory
Returns the mailbox maildir directory.- Returns:
- the maildir path
- See Also:
-
getActive
public boolean getActive()Returns if the mailbox is active.- Returns:
- TRUE if the mailbox is active, otherwise FALSE
- See Also:
-
getAllowSMTP
public boolean getAllowSMTP()Returns if this mailbox allows direct SMTP connetions.- Returns:
- TRUE if SMTP connections allowed, otherwise FALSE
- See Also:
-
getAliases
Returns all aliases for this mailbox.- Returns:
- a Collection of alias addresses
- See Also:
-
addAlias
Adds a new alias to this mailbox.- Parameters:
alias
- the new address- Throws:
NullPointerException
- if alias is null- See Also:
-
setAliases
Updates the aliases for this mailbox.- Parameters:
aliases
- a new Collection of alias addresses- Throws:
NullPointerException
- if any element is null- See Also:
-
setAddress
Updates the primary address for this mailbox.- Parameters:
addr
- the address- Throws:
NullPointerException
- if addr is null- See Also:
-
setQuota
public void setQuota(int quota) Updates the size quota for this mailbox.- Parameters:
quota
- the quota in bytes- See Also:
-
setMailDirectory
Updates the mailbox directory.- Parameters:
path
- the mail directory- Throws:
NullPointerException
- if path is null- See Also:
-
setActive
public void setActive(boolean active) Marks this mailbox as active.- Parameters:
active
- TRUE if the mailbox is active, otherwise FALSE- See Also:
-
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:
-
getRowClassName
Description copied from interface:ViewEntry
Returns the CSS class for this object if rendered in a view table.- Specified by:
getRowClassName
in interfaceViewEntry
- Returns:
- the CSS class name, or NULL if none
-
getAuditID
Description copied from interface:Auditable
Returns the object ID for this auditable object.- Specified by:
getAuditID
in interfaceAuditable
- Returns:
- the ID
-