com.atlassian.confluence.mail
Class AbstractMailAccount

java.lang.Object
  com.atlassian.confluence.mail.AbstractMailAccount

All Implemented Interfaces:

MailAccount, java.io.Serializable

Direct Known Subclasses:

ImapMailAccount, PopMailAccount

public abstract class AbstractMailAccount
extends java.lang.Object
implements MailAccount, java.io.Serializable

See Also:

Serialized Form

Field Summary

protected java.lang.String	description
protected boolean	enabled
protected java.lang.String	hostname
protected int	id
protected java.lang.String	name
protected java.lang.String	password
protected int	port
protected boolean	secure
protected boolean	status
protected java.lang.String	username

Fields inherited from interface com.atlassian.confluence.mail.MailAccount

DEFAULT_FOLDER, IMAP_PROTOCOL, POP_PROTOCOL, SECURE_IMAP_PROTOCOL, SECURE_POP_PROTOCOL

Constructor Summary

protected	AbstractMailAccount()
protected	AbstractMailAccount(int id, java.lang.String name, java.lang.String description, java.lang.String hostname, java.lang.String username, java.lang.String password, int port, boolean secure)

Method Summary

void	disable() Prevent this account from retrieving mail in the future
void	enable() Set this account to be retrieving mail.
java.lang.String	getDescription()
java.lang.String	getHostname()
int	getId()
java.lang.String	getName()
java.lang.String	getPassword()
int	getPort()
boolean	getStatus() Returns the status of this mail account the last time an attempt was made to connect to it.
java.lang.String	getUsername()
boolean	isDisabled() Should this account be used to retrieve mail?
boolean	isEnabled() Should this account be used to retrieve mail?
boolean	isSecure()
java.lang.String	lockName() A lock identifier for ensuring Confluence only connects once to a given user/host/port combination.
void	setDescription(java.lang.String description)
void	setEnabled(boolean b)
void	setHostname(java.lang.String hostname)
void	setId(int id)
void	setName(java.lang.String name)
void	setPassword(java.lang.String password)
void	setPort(int port)
void	setSecure(boolean secure)
void	setStatus(boolean status)
void	setUsername(java.lang.String username)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.mail.MailAccount

getFolderName, getProtocol

Field Detail

id

protected int id

name

protected java.lang.String name

description

protected java.lang.String description

hostname

protected java.lang.String hostname

username

protected java.lang.String username

password

protected java.lang.String password

port

protected int port

secure

protected boolean secure

status

protected boolean status

enabled

protected boolean enabled

Constructor Detail

AbstractMailAccount

protected AbstractMailAccount()

AbstractMailAccount

protected AbstractMailAccount(int id,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String hostname,
                              java.lang.String username,
                              java.lang.String password,
                              int port,
                              boolean secure)

Method Detail

getId

public int getId()

Specified by:

getId in interface MailAccount

setId

public void setId(int id)

Specified by:

setId in interface MailAccount

getName

public java.lang.String getName()

Specified by:

getName in interface MailAccount

setName

public void setName(java.lang.String name)

Specified by:

setName in interface MailAccount

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface MailAccount

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface MailAccount

getHostname

public java.lang.String getHostname()

Specified by:

getHostname in interface MailAccount

setHostname

public void setHostname(java.lang.String hostname)

Specified by:

setHostname in interface MailAccount

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface MailAccount

setUsername

public void setUsername(java.lang.String username)

Specified by:

setUsername in interface MailAccount

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface MailAccount

setPassword

public void setPassword(java.lang.String password)

Specified by:

setPassword in interface MailAccount

getPort

public int getPort()

Specified by:

getPort in interface MailAccount

setPort

public void setPort(int port)

Specified by:

setPort in interface MailAccount

isSecure

public boolean isSecure()

Specified by:

isSecure in interface MailAccount

setSecure

public void setSecure(boolean secure)

Specified by:

setSecure in interface MailAccount

getStatus

public boolean getStatus()

Description copied from interface: MailAccount

Returns the status of this mail account the last time an attempt was made to connect to it. To update this call MailAccountManager.updateStatus() on this mail account.

Specified by:

getStatus in interface MailAccount

Returns:

true if the last attempt to poll or check was successful, false otherwise

setStatus

public void setStatus(boolean status)

Specified by:

setStatus in interface MailAccount

enable

public void enable()

Description copied from interface: MailAccount

Set this account to be retrieving mail.

Specified by:

enable in interface MailAccount

disable

public void disable()

Description copied from interface: MailAccount

Prevent this account from retrieving mail in the future

Specified by:

disable in interface MailAccount

isEnabled

public boolean isEnabled()

Description copied from interface: MailAccount

Should this account be used to retrieve mail?

Specified by:

isEnabled in interface MailAccount

Returns:

true if the account is active and allowed to retrieve mail, false otherwise

setEnabled

public void setEnabled(boolean b)

Specified by:

setEnabled in interface MailAccount

isDisabled

public boolean isDisabled()

Description copied from interface: MailAccount

Should this account be used to retrieve mail?

Specified by:

isDisabled in interface MailAccount

Returns:

false if the account is active and allowed to retrieve mail, true otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

lockName

public java.lang.String lockName()

A lock identifier for ensuring Confluence only connects once to a given user/host/port combination.

Specified by:

lockName in interface MailAccount