com.openexchange.mail.transport.config

Class TransportConfig

java.lang.Object

com.openexchange.mail.api.MailConfig

com.openexchange.mail.transport.config.TransportConfig

public abstract class TransportConfig
extends MailConfig

TransportConfig - The user-specific transport configuration

Provides access to global transport properties.

Author:

Thorben Betten

Nested Class Summary

Nested classes/interfaces inherited from class com.openexchange.mail.api.MailConfig

MailConfig.BoolCapVal, MailConfig.LoginSource, MailConfig.PasswordSource, MailConfig.ServerSource

Method Summary

Methods

Modifier and Type	Method and Description
IMailProperties	getMailProperties() Gets the mail properties for this mail configuration.
static <C extends TransportConfig> C	getTransportConfig(C transportConfig, com.openexchange.session.Session session, int accountId) Gets the user-specific transport configuration
abstract ITransportProperties	getTransportProperties() Gets the transport properties for this transport configuration.
static java.lang.String	getTransportServerURL(com.openexchange.mailaccount.MailAccount mailAccount) Gets the transport server URL appropriate to configured transport server source.
static java.lang.String	getTransportServerURL(com.openexchange.session.Session session, int accountId) Gets the transport server URL appropriate to configured login type
void	setMailProperties(IMailProperties mailProperties) Sets the mail properties for this mail configuration.
abstract void	setTransportProperties(ITransportProperties transportProperties) Sets the transport properties for this transport configuration.

Methods inherited from class com.openexchange.mail.api.MailConfig

applyStandardNames, equals, getAccountId, getCapabilities, getConfig, getLogin, getMailLogin, getMailServerURL, getMailServerURL, getPartModifier, getPassword, getPort, getServer, getSession, getStandardFullNames, getStandardNames, getUserIDsByMailLogin, hashCode, isSecure, parseProtocol, setAccountId, setLogin, setPassword, setPort, setSecure, setServer, setSession, toString, usePartModifier

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTransportConfig

public static final <C extends TransportConfig> C getTransportConfig(C transportConfig,
                                               com.openexchange.session.Session session,
                                               int accountId)
                                                          throws com.openexchange.exception.OXException

Gets the user-specific transport configuration

Parameters:

clazz - The transport configuration type

transportConfig - A newly created transport configuration

session - The session providing needed user data

accountId - The mail account ID

Returns:

The user-specific transport configuration

Throws:

com.openexchange.exception.OXException - If user-specific transport configuration cannot be determined

getTransportServerURL

public static java.lang.String getTransportServerURL(com.openexchange.mailaccount.MailAccount mailAccount)

Gets the transport server URL appropriate to configured transport server source.

Parameters:

mailAccount - The mail account

Returns:

The appropriate transport server URL or null

getTransportServerURL

public static java.lang.String getTransportServerURL(com.openexchange.session.Session session,
                                     int accountId)
                                              throws com.openexchange.exception.OXException

Gets the transport server URL appropriate to configured login type

Parameters:

session - The user session

accountId - The account ID

Returns:

The appropriate transport server URL or null

Throws:

com.openexchange.exception.OXException - If transport server URL cannot be returned

getMailProperties

public IMailProperties getMailProperties()

Description copied from class: MailConfig

Gets the mail properties for this mail configuration.

Specified by:

getMailProperties in class MailConfig

Returns:

The mail properties for this mail configuration

setMailProperties

public void setMailProperties(IMailProperties mailProperties)

Description copied from class: MailConfig

Sets the mail properties for this mail configuration.

Specified by:

setMailProperties in class MailConfig

Parameters:

mailProperties - The mail properties for this mail configuration

getTransportProperties

public abstract ITransportProperties getTransportProperties()

Gets the transport properties for this transport configuration.

Returns:

The transport properties for this transport configuration

setTransportProperties

public abstract void setTransportProperties(ITransportProperties transportProperties)

Sets the transport properties for this transport configuration.

Parameters:

transportProperties - The transport properties for this transport configuration