com.day.cq.mcm.emailprovider.types

Interface ConnectionParams

All Superinterfaces:

BaseType

public interface ConnectionParams
extends BaseType

This interface manages the connection parameters for an email provider. The getter and setter methods for connection identifier id (username/identifier) are inherited from BaseType

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccountId() This can be used to get the account ID associated with the connection.
String	getKey() Get the key for connection (this would be password or any access key)
String	getProviderName() Get the name of the email provider.
String	getUrl() Get the connection URL.
void	setAccountId(String accountId) This can be used to set the account identifier associated with the connection.
void	setKey(String key) Set the key (this would be password or any access key) for connection parameters
void	setProviderName(String providerName) Get the name of the email provider.
void	setUrl(String url) Set the connection URL.

Methods inherited from interface com.day.cq.mcm.emailprovider.types.BaseType

addParam, getId, getParam, getParams, setId, setParams

Method Detail

getKey

String getKey()

Get the key for connection (this would be password or any access key)

Returns:

The key (password or access key) for connection.

setKey

void setKey(String key)

Set the key (this would be password or any access key) for connection parameters

Parameters:

key - The key which could be password or access key etc.

getUrl

String getUrl()

Get the connection URL. This URL would be used to connect to the email provider.

Returns:

The URL to be used to connect to the email provider.

setUrl

void setUrl(String url)

Set the connection URL. This URL would be used to connect to the email provider.

Parameters:

url - The URL to be used to connect to the email provider.

getAccountId

String getAccountId()

This can be used to get the account ID associated with the connection.

Returns:

account identifier.

setAccountId

void setAccountId(String accountId)

This can be used to set the account identifier associated with the connection. Many email providers support multiple accounts associated with a single client. This parameter can be used to identify such accounts.

Parameters:

accountId - The account ID to be used with connection.

getProviderName

String getProviderName()

Get the name of the email provider. This name will be used to identify an email provider implementation.

Returns:

The name of the email provider.

setProviderName

void setProviderName(String providerName)

Get the name of the email provider. This name will be used to identify an email provider implementation.

Parameters:

providerName - The name of the email provider.