com.atlassian.confluence.mail
Interface MailAccount

All Known Implementing Classes:

AbstractMailAccount

public interface MailAccount

Field Summary

static String	DEFAULT_FOLDER
static String	IMAP_PROTOCOL
static String	POP_PROTOCOL
static String	SECURE_IMAP_PROTOCOL
static String	SECURE_POP_PROTOCOL

Method Summary

void	disable() Prevent this account from retrieving mail in the future
void	enable() Set this account to be retrieving mail.
String	getDescription()
String	getFolderName()
String	getHostname()
int	getId()
String	getName()
String	getPassword()
int	getPort()
String	getProtocol()
boolean	getStatus() Returns the status of this mail account the last time an attempt was made to connect to it.
String	getUsername()
boolean	isDisabled() Should this account be used to retrieve mail?
boolean	isEnabled() Should this account be used to retrieve mail?
boolean	isSecure()
String	lockName()
void	setDescription(String description)
void	setEnabled(boolean b)
void	setHostname(String hostname)
void	setId(int id)
void	setName(String name)
void	setPassword(String password)
void	setPort(int port)
void	setSecure(boolean secure)
void	setStatus(boolean status)
void	setUsername(String username)

Field Detail

POP_PROTOCOL

public static final String POP_PROTOCOL

See Also:

Constant Field Values

SECURE_POP_PROTOCOL

public static final String SECURE_POP_PROTOCOL

See Also:

Constant Field Values

IMAP_PROTOCOL

public static final String IMAP_PROTOCOL

See Also:

Constant Field Values

SECURE_IMAP_PROTOCOL

public static final String SECURE_IMAP_PROTOCOL

See Also:

Constant Field Values

DEFAULT_FOLDER

public static final String DEFAULT_FOLDER

See Also:

Constant Field Values

Method Detail

getId

public int getId()

setId

public void setId(int id)

getProtocol

public String getProtocol()

getFolderName

public String getFolderName()

Returns:

the name of the folder to open once a connection can be established with this account

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public int getPort()

setPort

public void setPort(int port)

getStatus

public boolean getStatus()

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.

Returns:

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

setStatus

public void setStatus(boolean status)

enable

public void enable()

Set this account to be retrieving mail.

disable

public void disable()

Prevent this account from retrieving mail in the future

setEnabled

public void setEnabled(boolean b)

isEnabled

public boolean isEnabled()

Should this account be used to retrieve mail?

Returns:

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

isDisabled

public boolean isDisabled()

Should this account be used to retrieve mail?

Returns:

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

isSecure

public boolean isSecure()

setSecure

public void setSecure(boolean secure)

lockName

public String lockName()