Class ExchangeMailListener

java.lang.Object

org.frankframework.filesystem.AbstractFileSystemListener<MailItemId, ExchangeFileSystem>

org.frankframework.filesystem.AbstractMailListener<MailItemId, MailMessage, ExchangeFileSystem>

org.frankframework.receivers.ExchangeMailListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState<MailItemId>, IListener<MailItemId>, IProvidesMessageBrowsers<MailItemId>, IPullingListener<MailItemId>, IScopeProvider, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(ADVANCED)
public class ExchangeMailListener
extends AbstractMailListener<MailItemId, MailMessage, ExchangeFileSystem>

Implementation of a AbstractFileSystemSender that enables to manipulate messages in an Exchange folder. Uses the MS Graph API to manage a mailbox. Compared to older versions of the Frank!Framework the DELETE action was a soft delete. Now it's a hard delete and thus no longer moves the mail item to the Archive or Deleted items.

See Also:

• MS Graph API

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMailListener

AbstractMailListener.MessageType

Nested classes/interfaces inherited from class AbstractFileSystemListener

AbstractFileSystemListener.IMessageType

Field Summary

Fields inherited from class AbstractFileSystemListener

FILENAME_KEY, FILEPATH_KEY, ORIGINAL_FILENAME_KEY

Constructor Summary

Constructors

Constructor	Description
ExchangeMailListener()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
protected ExchangeFileSystem	createFileSystem()
void	setAllowSelfSignedCertificates(boolean allowSelfSignedCertificates)
void	setAuthAlias(String authAlias)
void	setBaseFolder(String baseFolder)
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)
void	setKeyManagerAlgorithm(String keyManagerAlgorithm)
void	setKeystore(String keystore)
void	setKeystoreAlias(String keystoreAlias)
void	setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)
void	setKeystoreAliasPassword(String keystoreAliasPassword)
void	setKeystoreAuthAlias(String keystoreAuthAlias)
void	setKeystorePassword(String keystorePassword)
void	setKeystoreType(KeystoreType keystoreType)
void	setMailAddress(String mailAddress)
void	setProxyAuthAlias(String proxyAuthAlias)
void	setProxyDomain(String domain)
void	setProxyHost(String proxyHost)
void	setProxyPassword(String proxyPassword)
void	setProxyPort(int proxyPort)
void	setProxyUsername(String proxyUsername)
void	setReplyAddressFields(String replyAddressFields)
void	setTenantId(String tenantId)
void	setTrustManagerAlgorithm(String trustManagerAlgorithm)
void	setTruststore(String truststore)
void	setTruststoreAuthAlias(String truststoreAuthAlias)
void	setTruststorePassword(String truststorePassword)
void	setTruststoreType(KeystoreType truststoreType)
void	setVerifyHostname(boolean verifyHostname)

Methods inherited from class AbstractMailListener

extractMessage, getMessageType, setMessageType

Methods inherited from class AbstractFileSystemListener

afterMessageProcessed, changeProcessState, checkForExistenceOfFolder, closeThread, extractMessageProperties, getMessageBrowser, getPhysicalDestinationName, getRawMessage, getStateFolder, knownProcessStates, openThread, setCharset, setCreateFolders, setDelete, setDisableMessageBrowsers, setErrorFolder, setExcludeWildcard, setFileTimeSensitive, setHoldFolder, setInProcessFolder, setInputFolder, setLogFolder, setMessageIdPropertyKey, setMessageType, setMinStableTime, setName, setNumberOfBackups, setOutputFormat, setOverwrite, setProcessedFolder, setStoreMetadataInSessionKey, setWildcard, start, stop, targetProcessStates

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Constructor Details

ExchangeMailListener

public ExchangeMailListener()

Method Details

createFileSystem

protected ExchangeFileSystem createFileSystem()

Specified by:

createFileSystem in class AbstractFileSystemListener<MailItemId, ExchangeFileSystem>

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractFileSystemListener<MailItemId, ExchangeFileSystem>

Throws:

ConfigurationException - in case it was not able to configure the component.

setMailAddress

@ReferTo(ExchangeFileSystem.class)
public void setMailAddress(String mailAddress)

setClientId

@ReferTo(ExchangeFileSystem.class)
public void setClientId(String clientId)

setClientSecret

@ReferTo(ExchangeFileSystem.class)
public void setClientSecret(String clientSecret)

setTenantId

@ReferTo(ExchangeFileSystem.class)
public void setTenantId(String tenantId)

setAuthAlias

@ReferTo(ExchangeFileSystem.class)
public void setAuthAlias(String authAlias)

setBaseFolder

@ReferTo(AbstractMailFileSystem.class)
public void setBaseFolder(String baseFolder)

setReplyAddressFields

@ReferTo(AbstractMailFileSystem.class)
public void setReplyAddressFields(String replyAddressFields)

setProxyHost

@ReferTo(ExchangeFileSystem.class)
public void setProxyHost(String proxyHost)

setProxyPort

@ReferTo(ExchangeFileSystem.class)
public void setProxyPort(int proxyPort)

setProxyUsername

@ReferTo(ExchangeFileSystem.class)
public void setProxyUsername(String proxyUsername)

setProxyPassword

@ReferTo(ExchangeFileSystem.class)
public void setProxyPassword(String proxyPassword)

setProxyAuthAlias

@ReferTo(ExchangeFileSystem.class)
public void setProxyAuthAlias(String proxyAuthAlias)

setProxyDomain

@ReferTo(ExchangeFileSystem.class)
public void setProxyDomain(String domain)

setKeystore

@ReferTo(HasKeystore.class)
public void setKeystore(String keystore)

setKeystoreType

@ReferTo(HasKeystore.class)
public void setKeystoreType(KeystoreType keystoreType)

setKeystoreAuthAlias

@ReferTo(HasKeystore.class)
public void setKeystoreAuthAlias(String keystoreAuthAlias)

setKeystorePassword

@ReferTo(HasKeystore.class)
public void setKeystorePassword(String keystorePassword)

setKeyManagerAlgorithm

@ReferTo(HasKeystore.class)
public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

setKeystoreAlias

@ReferTo(HasKeystore.class)
public void setKeystoreAlias(String keystoreAlias)

setKeystoreAliasAuthAlias

@ReferTo(HasKeystore.class)
public void setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)

setKeystoreAliasPassword

@ReferTo(HasKeystore.class)
public void setKeystoreAliasPassword(String keystoreAliasPassword)

setTruststore

@ReferTo(HasTruststore.class)
public void setTruststore(String truststore)

setTruststoreType

@ReferTo(HasTruststore.class)
public void setTruststoreType(KeystoreType truststoreType)

setTruststoreAuthAlias

@ReferTo(HasTruststore.class)
public void setTruststoreAuthAlias(String truststoreAuthAlias)

setTruststorePassword

@ReferTo(HasTruststore.class)
public void setTruststorePassword(String truststorePassword)

setTrustManagerAlgorithm

@ReferTo(HasTruststore.class)
public void setTrustManagerAlgorithm(String trustManagerAlgorithm)

setVerifyHostname

@ReferTo(HasTruststore.class)
public void setVerifyHostname(boolean verifyHostname)

setAllowSelfSignedCertificates

@ReferTo(HasTruststore.class)
public void setAllowSelfSignedCertificates(boolean allowSelfSignedCertificates)

setIgnoreCertificateExpiredException

@ReferTo(HasTruststore.class)
public void setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)