com.atlassian.confluence.mail.archive
Interface MailAccount

All Known Implementing Classes:
AbstractMailAccount, ImapMailAccount, PopMailAccount

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

static final String POP_PROTOCOL
See Also:
Constant Field Values

SECURE_POP_PROTOCOL

static final String SECURE_POP_PROTOCOL
See Also:
Constant Field Values

IMAP_PROTOCOL

static final String IMAP_PROTOCOL
See Also:
Constant Field Values

SECURE_IMAP_PROTOCOL

static final String SECURE_IMAP_PROTOCOL
See Also:
Constant Field Values

DEFAULT_FOLDER

static final String DEFAULT_FOLDER
See Also:
Constant Field Values
Method Detail

getId

int getId()

setId

void setId(int id)

getProtocol

String getProtocol()

getFolderName

String getFolderName()
Returns:
the name of the folder to open once a connection can be established with this account

getName

String getName()

setName

void setName(String name)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getHostname

String getHostname()

setHostname

void setHostname(String hostname)

getUsername

String getUsername()

setUsername

void setUsername(String username)

getPassword

String getPassword()

setPassword

void setPassword(String password)

getPort

int getPort()

setPort

void setPort(int port)

getStatus

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

void setStatus(boolean status)

enable

void enable()
Set this account to be retrieving mail.


disable

void disable()
Prevent this account from retrieving mail in the future


setEnabled

void setEnabled(boolean b)

isEnabled

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

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

boolean isSecure()

setSecure

void setSecure(boolean secure)

lockName

String lockName()


Copyright © 2003–2015 Atlassian. All rights reserved.