public abstract class MailConfig
extends java.lang.Object
MailConfig
- The user-specific mail properties; e.g. containing user's login data.
Provides access to global mail properties.
Modifier and Type | Class and Description |
---|---|
static class |
MailConfig.BoolCapVal |
static class |
MailConfig.LoginSource |
static class |
MailConfig.PasswordSource |
static class |
MailConfig.ServerSource |
Modifier and Type | Method and Description |
---|---|
void |
applyStandardNames(com.openexchange.mailaccount.MailAccount mailAccount)
Applies folder name information from given mail account
|
boolean |
equals(java.lang.Object obj) |
int |
getAccountId()
Gets the account ID.
|
abstract MailCapabilities |
getCapabilities()
Gets the mail system's capabilities
|
static <C extends MailConfig> |
getConfig(C mailConfig,
com.openexchange.session.Session session,
int accountId)
Gets the user-specific mail configuration.
|
java.lang.String |
getLogin()
Gets the login.
|
static java.lang.String |
getMailLogin(com.openexchange.mailaccount.MailAccount mailAccount,
java.lang.String userLoginInfo)
Gets the mail login with respect to configured login source.
|
abstract IMailProperties |
getMailProperties()
Gets the mail properties for this mail configuration.
|
static java.lang.String |
getMailServerURL(com.openexchange.mailaccount.MailAccount mailAccount)
Gets the mail server URL appropriate to configured mail server source.
|
static java.lang.String |
getMailServerURL(com.openexchange.session.Session session,
int accountId)
Gets the mail server URL appropriate to configured mail server source.
|
static PartModifier |
getPartModifier()
Gets the part modifier.
|
java.lang.String |
getPassword()
Gets the password.
|
abstract int |
getPort()
Gets the optional port of the server.
|
abstract java.lang.String |
getServer()
Gets the host name or IP address of the server.
|
com.openexchange.session.Session |
getSession()
Gets the session.
|
java.lang.String[] |
getStandardFullNames()
Gets the standard full names.
|
java.lang.String[] |
getStandardNames()
Gets the standard names.
|
static int[] |
getUserIDsByMailLogin(java.lang.String pattern,
boolean isDefaultAccount,
java.lang.String serverUrl,
com.openexchange.groupware.contexts.Context ctx)
Resolves the user IDs by specified pattern dependent on configuration's setting for mail login source.
|
int |
hashCode() |
abstract boolean |
isSecure()
Checks if a secure connection shall be established.
|
static java.lang.String[] |
parseProtocol(java.lang.String server)
Parses protocol out of specified server string according to URL specification; e.g.
|
void |
setAccountId(int accountId)
Sets the account ID (externally).
|
void |
setLogin(java.lang.String login)
Sets the login (externally).
|
abstract void |
setMailProperties(IMailProperties mailProperties)
Sets the mail properties for this mail configuration.
|
void |
setPassword(java.lang.String password)
Sets the password (externally).
|
abstract void |
setPort(int port)
Sets the port (externally).
|
abstract void |
setSecure(boolean secure)
Sets (externally) whether a secure connection should be established or not.
|
abstract void |
setServer(java.lang.String server)
Sets the host name or IP address of the server (externally).
|
void |
setSession(com.openexchange.session.Session session)
Sets the session
|
java.lang.String |
toString() |
static boolean |
usePartModifier()
Checks if a part modifier shall be used, that is
PartModifier.getInstance() is not null and not
assignment-compatible to DummyPartModifier (which does nothing at all). |
public static final <C extends MailConfig> C getConfig(C mailConfig, com.openexchange.session.Session session, int accountId) throws com.openexchange.exception.OXException
C
- The return value typemailConfig
- A newly created mail configuration
session
- The session providing needed user dataaccountId
- The mail account IDcom.openexchange.exception.OXException
- If user-specific mail configuration cannot be determinedpublic static final java.lang.String getMailLogin(com.openexchange.mailaccount.MailAccount mailAccount, java.lang.String userLoginInfo)
mailAccount
- The mail account used to determine the loginuserLoginInfo
- The login information of the userpublic static final java.lang.String getMailServerURL(com.openexchange.mailaccount.MailAccount mailAccount)
mailAccount
- The usernull
public static final java.lang.String getMailServerURL(com.openexchange.session.Session session, int accountId) throws com.openexchange.exception.OXException
session
- The user sessionaccountId
- The account IDnull
com.openexchange.exception.OXException
- If mail server URL cannot be returnedpublic static final PartModifier getPartModifier()
public static int[] getUserIDsByMailLogin(java.lang.String pattern, boolean isDefaultAccount, java.lang.String serverUrl, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
pattern
- The patternserverUrl
- The server URL; e.g. "mail.company.org:143"
ctx
- The contextcom.openexchange.exception.OXException
- If resolving user by specified pattern failspublic static final java.lang.String[] parseProtocol(java.lang.String server)
server
- The server stringString
with length 2
. The first element is the protocol and the second the server. If no
protocol pattern could be found null
is returned; meaning no protocol is present in specified server string.public static final boolean usePartModifier()
PartModifier.getInstance()
is not null
and not
assignment-compatible to DummyPartModifier
(which does nothing at all).true
if part modifier shall be used; otherwise false
public java.lang.String[] getStandardNames()
public java.lang.String[] getStandardFullNames()
public void applyStandardNames(com.openexchange.mailaccount.MailAccount mailAccount)
mailAccount
- The mail accountpublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int getAccountId()
public com.openexchange.session.Session getSession()
public abstract MailCapabilities getCapabilities()
public final java.lang.String getLogin()
public final java.lang.String getPassword()
public abstract int getPort()
getServer()
or -1
if no port needed.public abstract java.lang.String getServer()
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public abstract boolean isSecure()
true
if a secure connection shall be established; otherwise false
public void setAccountId(int accountId)
accountId
- The account IDpublic void setSession(com.openexchange.session.Session session)
session
- The sessionpublic void setLogin(java.lang.String login)
login
- The loginpublic void setPassword(java.lang.String password)
password
- The passwordpublic abstract void setPort(int port)
port
- The portpublic abstract void setSecure(boolean secure)
secure
- true
if a secure connection should be established; otherwise false
public abstract void setServer(java.lang.String server)
server
- The host name or IP address of the serverpublic abstract IMailProperties getMailProperties()
public abstract void setMailProperties(IMailProperties mailProperties)
mailProperties
- The mail properties for this mail configuration