com.openexchange.messaging
Interface MessagingService

All Known Subinterfaces:

ConfigProvidingMessagingService

public interface MessagingService

MessagingService - The messaging service.

Since:

Open-Xchange v6.16

Author:

Francisco Laguna, Thorben Betten

Method Summary

MessagingAccountAccess	getAccountAccess(int accountId, com.openexchange.session.Session session) Gets the account access for specified account identifier.
MessagingAccountManager	getAccountManager() Gets the account manager for this messaging service.
MessagingAccountTransport	getAccountTransport(int accountId, com.openexchange.session.Session session) Gets the account transport for specified account identifier.
java.lang.String	getDisplayName() Gets the display name.
com.openexchange.datatypes.genericonf.DynamicFormDescription	getFormDescription() Get the form description.
java.lang.String	getId() Gets the identifier of this messaging service.
java.util.List<MessagingAction>	getMessageActions() Gets the list of message actions of this messaging service.
java.util.Set<java.lang.String>	getSecretProperties() Gets those properties from configuration which should be encrypted.
int[]	getStaticRootPermissions() Gets the static root folder permissions.

Method Detail

getId

java.lang.String getId()

Gets the identifier of this messaging service.

Returns:

The identifier

getMessageActions

java.util.List<MessagingAction> getMessageActions()

Gets the list of message actions of this messaging service.

Returns:

The list of message actions

getDisplayName

java.lang.String getDisplayName()

Gets the display name.

Returns:

The display name

getFormDescription

com.openexchange.datatypes.genericonf.DynamicFormDescription getFormDescription()

Get the form description.

Returns:

The form description

getSecretProperties

java.util.Set<java.lang.String> getSecretProperties()

Gets those properties from configuration which should be encrypted.

Returns:

Those properties from configuration which should be encrypted

getStaticRootPermissions

int[] getStaticRootPermissions()

Gets the static root folder permissions.

Returns:

The static root folder permissions or null

getAccountManager

MessagingAccountManager getAccountManager()

Gets the account manager for this messaging service.

Returns:

The account manager

getAccountAccess

MessagingAccountAccess getAccountAccess(int accountId,
                                        com.openexchange.session.Session session)
                                        throws MessagingException

Gets the account access for specified account identifier.

Parameters:

accountId - The account identifier

session - The session providing needed user data

Returns:

The account access for specified account identifier

Throws:

MessagingException - If account access cannot be returned for given account identifier

getAccountTransport

MessagingAccountTransport getAccountTransport(int accountId,
                                              com.openexchange.session.Session session)
                                              throws MessagingException

Gets the account transport for specified account identifier.

Parameters:

accountId - The account identifier

session - The session providing needed user data

Returns:

The account transport for specified account identifier

Throws:

MessagingException - If account transport cannot be returned for given account identifier