ExchangeFileSystem (Ibis AdapterFramework parent 7.9-20230322.102910 API)

java.lang.Object
- nl.nn.adapterframework.filesystem.FileSystemBase<F>
- - nl.nn.adapterframework.filesystem.ConnectedFileSystemBase<M,C>
  - - nl.nn.adapterframework.filesystem.MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
    - - nl.nn.adapterframework.filesystem.ExchangeFileSystem

All Implemented Interfaces:

HasPhysicalDestination, IConfigurationAware, IScopeProvider, HasKeystore, HasTruststore, IBasicFileSystem<ExchangeMessageReference>, IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>, IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
public class ExchangeFileSystem
extends MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
implements HasKeystore, HasTruststore
```
Implementation of a IBasicFileSystem of an Exchange Mail Inbox.
To make use of modern authentication:
1. Create an application in Azure AD -> App Registrations. For more information please read "https://docs.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth"
2. Request the required API permissions within desired scope https://outlook.office365.com/ in Azure AD -> App Registrations -> MyApp -> API Permissions.
3. Create a secret for your application in Azure AD -> App Registrations -> MyApp -> Certificates and Secrets
4. Configure the clientSecret directly as password or as the password of a JAAS entry referred to by authAlias. Only available upon creation of your secret in the previous step.
5. Configure the clientId directly as username or as the username of a JAAS entry referred to by authAlias which could be retrieved from Azure AD -> App Registrations -> MyApp -> Overview
6. Configure the tenantId which could be retrieved from Azure AD -> App Registrations -> MyApp -> Overview
7. Make sure your application is able to reach https://login.microsoftonline.com. Required for token retrieval.
N.B. MS Exchange is susceptible to problems with invalid XML characters, like . To work around these problems, a special streaming XMLInputFactory is configured in METAINF/services/javax.xml.stream.XMLInputFactory as nl.nn.adapterframework.xml.StaxParserFactory
Author:

Peter Leeuwenburgh (as ExchangeMailListener), Gerrit van Brakel

Field Summary
- Fields inherited from class nl.nn.adapterframework.filesystem.FileSystemBase
  log
- Fields inherited from interface nl.nn.adapterframework.filesystem.IMailFileSystem
  BCC_RECEPIENTS_KEY, BEST_REPLY_ADDRESS_KEY, CC_RECEPIENTS_KEY, DATETIME_RECEIVED_KEY, DATETIME_SENT_KEY, FROM_ADDRESS_KEY, MAIL_MESSAGE_ID, REPLY_ADDRESS_FIELDS_DEFAULT, REPLY_TO_RECEPIENTS_KEY, RETURN_PATH_HEADER, SENDER_ADDRESS_KEY, TO_RECEPIENTS_KEY

Constructor Summary

Constructors
Constructor and Description

ExchangeFileSystem()

Constructors
Constructor and Description
`ExchangeFileSystem()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`configure()`
`ExchangeMessageReference`	`copyFile(ExchangeMessageReference f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned)` Copies the file to a another folder.
`protected microsoft.exchange.webservices.data.core.ExchangeService`	`createConnection()` Create a fresh connection to the FileSystem.
`void`	`createFolder(String folderName)`
`void`	`deleteFile(ExchangeMessageReference f)`
`boolean`	`exists(ExchangeMessageReference f)`
`void`	`extractAttachment(ExchangeAttachmentReference ref, SaxElementBuilder attachmentsXml)`
`void`	`extractEmail(ExchangeMessageReference ref, SaxElementBuilder emailXml)`
`microsoft.exchange.webservices.data.property.complex.FolderId`	`findFolder(ExchangeObjectReference reference)`
`microsoft.exchange.webservices.data.property.complex.FolderId`	`findFolder(microsoft.exchange.webservices.data.property.complex.FolderId baseFolderId, String folderName)` find a folder for listFiles(), getNumberOfFilesInFolder(), folderExists.
`boolean`	`folderExists(String folder)`
`void`	`forwardMail(ExchangeMessageReference emailMessage, String destination)`
`Map<String,Object>`	`getAdditionalAttachmentProperties(ExchangeAttachmentReference ref)`
`Map<String,Object>`	`getAdditionalFileProperties(ExchangeMessageReference f)`
`String`	`getAttachmentContentType(ExchangeAttachmentReference a)`
`String`	`getAttachmentFileName(ExchangeAttachmentReference ref)`
`String`	`getAttachmentName(ExchangeAttachmentReference a)`
`long`	`getAttachmentSize(ExchangeAttachmentReference a)`
`microsoft.exchange.webservices.data.property.complex.FolderId`	`getBaseFolderId(String emailAddress, String baseFolderName)`
`String`	`getCanonicalName(ExchangeMessageReference f)`
`protected Date`	`getDateTimeReceived(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)`
`protected Date`	`getDateTimeSent(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)`
`ExchangeMessageReference`	`getFileFromAttachment(ExchangeAttachmentReference ref)`
`long`	`getFileSize(ExchangeMessageReference f)`
`protected String`	`getFrom(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)`
`Message`	`getMimeContent(ExchangeMessageReference ref)`
`Date`	`getModificationTime(ExchangeMessageReference f)`
`String`	`getName(ExchangeMessageReference f)` Get a string representation of an identification of a file.
`int`	`getNumberOfFilesInFolder(String foldername)`
`String`	`getParentFolder(ExchangeMessageReference f)`
`String`	`getPhysicalDestinationName()`
`protected List<String>`	`getReplyTo(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)`
`protected String`	`getSender(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)`
`String`	`getSubject(ExchangeMessageReference ref)`
`Iterator<ExchangeAttachmentReference>`	`listAttachments(ExchangeMessageReference f)`
`DirectoryStream<ExchangeMessageReference>`	`listFiles(String folder)` Lists all files in 'folder' or in the 'root' of the filesystem (when folder is null).
`ExchangeMessageReference`	`moveFile(ExchangeMessageReference f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned)` Moves the file to a another folder.
`void`	`open()`
`Message`	`readAttachment(ExchangeAttachmentReference ref)`
`Message`	`readFile(ExchangeMessageReference f, String charset)`
`protected void`	`releaseConnection(microsoft.exchange.webservices.data.core.ExchangeService service, boolean invalidateConnectionOnRelease)` Release the connection, return it to the pool or invalidate it.
`void`	`removeFolder(String folderName, boolean removeNonEmptyFolder)`
`void`	`setAuthAlias(String authAlias)` Alias used to obtain client ID and secret or username and password for authentication to Exchange mail server.
`void`	`setClientId(String clientId)` Client ID that represents a registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
`void`	`setClientSecret(String clientSecret)` Client secret that belongs to registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Certificates and Secrets
`void`	`setFilter(String filter)` If empty, all mails are retrieved.
`void`	`setMailAddress(String mailAddress)` The mail address of the mailbox connected to (also used for auto discovery)
`void`	`setMailboxObjectSeparator(String separator)` Separator character used when working with multiple mailboxes, specified before the separator in the object name `test@organisation.com\|My sub folder` or `test@organisation.com\|AAMkADljZDMxYzIzLTFlMjYtNGY4Mi1hM2Y1LTc2MjE5ZjIyZmMyNABGAAAAAAAu/9EmV5M6QokBRZwID1Q6BwDXQXY+F44hRbDfTB9v8jRfAAAEUqUVAADXQXY+F44hRbDfTB9v8jRfAAKA4F+pAAA=`.
`void`	`setPassword(String password)` Deprecated.
`void`	`setProxyAuthAlias(String proxyAuthAlias)` proxy authAlias
`void`	`setProxyDomain(String proxyDomain)` proxy domain
`void`	`setProxyHost(String proxyHost)` proxy host
`void`	`setProxyPassword(String proxyPassword)` proxy password
`void`	`setProxyPort(int proxyPort)` proxy port
`void`	`setProxyUsername(String proxyUsername)` proxy username
`void`	`setTenantId(String tenantId)` Tenant ID that represents the tenant in which the registered application exists within Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
`void`	`setUrl(String url)` Url of the Exchange server.
`void`	`setUsername(String username)` Deprecated.
`void`	`setValidateAllRedirectUrls(boolean validateAllRedirectUrls)` When `true`, all redirect uris are accepted when connecting to the server
`ExchangeMessageReference`	`toFile(String filename)` Get a file 'F' representation of an identification of a file.
`ExchangeMessageReference`	`toFile(String folder, String filename)` Creates a reference to a file.

Methods inherited from class nl.nn.adapterframework.filesystem.MailFileSystemBase
setBaseFolder, setReadMimeContents, setReplyAddressFields

Methods inherited from class nl.nn.adapterframework.filesystem.ConnectedFileSystemBase
closeConnection, getConnection, pendingRelease

Methods inherited from class nl.nn.adapterframework.filesystem.FileSystemBase
getMaxNumberOfMessagesToList, isOpen, setMaxNumberOfMessagesToList

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.encryption.HasKeystore
getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware
getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider
getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext

Methods inherited from interface nl.nn.adapterframework.encryption.HasTruststore
getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname, setAllowSelfSignedCertificates, setIgnoreCertificateExpiredException, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setVerifyHostname

Methods inherited from interface nl.nn.adapterframework.filesystem.IMailFileSystem
getReplyAddressFields

Methods inherited from interface nl.nn.adapterframework.filesystem.IBasicFileSystem
isOpen

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination
getDomain

- Constructor Detail
  - ExchangeFileSystem
```
public ExchangeFileSystem()
```
- Method Detail
  - configure
```
public void configure()
               throws ConfigurationException
```
    Specified by:
    
    configure in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    ConfigurationException
  - open
```
public void open()
          throws FileSystemException
```
    Specified by:
    
    open in interface IBasicFileSystem<ExchangeMessageReference>
    
    Overrides:
    
    open in class ConnectedFileSystemBase<ExchangeMessageReference,microsoft.exchange.webservices.data.core.ExchangeService>
    
    Throws:
    
    FileSystemException
  - close
```
public void close()
           throws FileSystemException
```
    Specified by:
    
    close in interface IBasicFileSystem<ExchangeMessageReference>
    
    Overrides:
    
    close in class ConnectedFileSystemBase<ExchangeMessageReference,microsoft.exchange.webservices.data.core.ExchangeService>
    
    Throws:
    
    FileSystemException
  - getBaseFolderId
```
public microsoft.exchange.webservices.data.property.complex.FolderId getBaseFolderId(String emailAddress,
                                                                                     String baseFolderName)
                                                                              throws FileSystemException
```
    Throws:
    
    FileSystemException
  - createConnection
```
protected microsoft.exchange.webservices.data.core.ExchangeService createConnection()
                                                                             throws FileSystemException
```
    Description copied from class: ConnectedFileSystemBase
    
    Create a fresh connection to the FileSystem.
    
    Specified by:
    
    createConnection in class ConnectedFileSystemBase<ExchangeMessageReference,microsoft.exchange.webservices.data.core.ExchangeService>
    
    Throws:
    
    FileSystemException
  - findFolder
```
public microsoft.exchange.webservices.data.property.complex.FolderId findFolder(ExchangeObjectReference reference)
                                                                         throws FileSystemException
```
    Throws:
    
    FileSystemException
  - findFolder
```
public microsoft.exchange.webservices.data.property.complex.FolderId findFolder(microsoft.exchange.webservices.data.property.complex.FolderId baseFolderId,
                                                                                String folderName)
                                                                         throws FileSystemException
```
    find a folder for listFiles(), getNumberOfFilesInFolder(), folderExists. If folderName is empty, the result defaults to the baseFolder. If baseFolder is null, the folder is searched in the root of the message folder hierarchy. If the folder is not found, null is returned.
    
    Throws:
    
    FileSystemException
  - toFile
```
public ExchangeMessageReference toFile(String filename)
                                throws FileSystemException
```
    Description copied from interface: IBasicFileSystem
    
    Get a file 'F' representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.getName(Object).
    
    Specified by:
    
    toFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - toFile
```
public ExchangeMessageReference toFile(String folder,
                                       String filename)
                                throws FileSystemException
```
    Description copied from interface: IBasicFileSystem
    
    Creates a reference to a file. If filename is not absolute, it will be created in 'defaultFolder'.
    
    Specified by:
    
    toFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - exists
```
public boolean exists(ExchangeMessageReference f)
               throws FileSystemException
```
    Specified by:
    
    exists in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - listFiles
```
public DirectoryStream<ExchangeMessageReference> listFiles(String folder)
                                                    throws FileSystemException
```
    Description copied from interface: IBasicFileSystem
    
    Lists all files in 'folder' or in the 'root' of the filesystem (when folder is null). Should list only 'files', no folders.
    
    Specified by:
    
    listFiles in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getNumberOfFilesInFolder
```
public int getNumberOfFilesInFolder(String foldername)
                             throws FileSystemException
```
    Specified by:
    
    getNumberOfFilesInFolder in interface IBasicFileSystem<ExchangeMessageReference>
    
    Overrides:
    
    getNumberOfFilesInFolder in class FileSystemBase<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - folderExists
```
public boolean folderExists(String folder)
                     throws FileSystemException
```
    Specified by:
    
    folderExists in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - readFile
```
public Message readFile(ExchangeMessageReference f,
                        String charset)
                 throws FileSystemException,
                        IOException
```
    Specified by:
    
    readFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
    
    IOException
  - deleteFile
```
public void deleteFile(ExchangeMessageReference f)
                throws FileSystemException
```
    Specified by:
    
    deleteFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - moveFile
```
public ExchangeMessageReference moveFile(ExchangeMessageReference f,
                                         String destinationFolder,
                                         boolean createFolder,
                                         boolean resultantMustBeReturned)
                                  throws FileSystemException
```
    Description copied from interface: IBasicFileSystem
    
    Moves the file to a another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the moved file, or null if no file was moved or there is no reference to the moved file.
    If the reference to the moved file is unknown after the move, then:
    if resultantMustBeReturned is set, then an Exception must be thrown, preferably before the file is moved;
    if resultantMustBeReturned is not set, then a null result returned might also mean the file was moved successfully, but with unknown destination;
    
    Specified by:
    
    moveFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    resultantMustBeReturned - TODO
    
    Throws:
    
    FileSystemException
  - copyFile
```
public ExchangeMessageReference copyFile(ExchangeMessageReference f,
                                         String destinationFolder,
                                         boolean createFolder,
                                         boolean resultantMustBeReturned)
                                  throws FileSystemException
```
    Description copied from interface: IBasicFileSystem
    
    Copies the file to a another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the copied file, or null if no file was copied or there is no reference to the copied file. If the reference to the copied file is unknown after the copy, then:
    if resultantMustBeReturned is set, then an Exception must be thrown, preferably before the file is copied;
    if resultantMustBeReturned is not set, then a null result returned might also mean the file was copied successfully, but with unknown destination;
    
    Specified by:
    
    copyFile in interface IBasicFileSystem<ExchangeMessageReference>
    
    resultantMustBeReturned - TODO
    
    Throws:
    
    FileSystemException
  - getFileSize
```
public long getFileSize(ExchangeMessageReference f)
                 throws FileSystemException
```
    Specified by:
    
    getFileSize in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getName
```
public String getName(ExchangeMessageReference f)
```
    Description copied from interface: IBasicFileSystem
    
    Get a string representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.toFile(String). Can reflect name a file has in its folder, is not expected to be unique over folders.
    
    Specified by:
    
    getName in interface IBasicFileSystem<ExchangeMessageReference>
  - getParentFolder
```
public String getParentFolder(ExchangeMessageReference f)
                       throws FileSystemException
```
    Specified by:
    
    getParentFolder in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getCanonicalName
```
public String getCanonicalName(ExchangeMessageReference f)
                        throws FileSystemException
```
    Specified by:
    
    getCanonicalName in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getModificationTime
```
public Date getModificationTime(ExchangeMessageReference f)
                         throws FileSystemException
```
    Specified by:
    
    getModificationTime in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getAdditionalFileProperties
```
public Map<String,Object> getAdditionalFileProperties(ExchangeMessageReference f)
                                               throws FileSystemException
```
    Specified by:
    
    getAdditionalFileProperties in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - forwardMail
```
public void forwardMail(ExchangeMessageReference emailMessage,
                        String destination)
                 throws FileSystemException
```
    Specified by:
    
    forwardMail in interface IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - listAttachments
```
public Iterator<ExchangeAttachmentReference> listAttachments(ExchangeMessageReference f)
                                                      throws FileSystemException
```
    Specified by:
    
    listAttachments in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getAttachmentName
```
public String getAttachmentName(ExchangeAttachmentReference a)
```
    Specified by:
    
    getAttachmentName in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
  - readAttachment
```
public Message readAttachment(ExchangeAttachmentReference ref)
                       throws FileSystemException,
                              IOException
```
    Specified by:
    
    readAttachment in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
    
    IOException
  - getFileFromAttachment
```
public ExchangeMessageReference getFileFromAttachment(ExchangeAttachmentReference ref)
                                               throws FileSystemException
```
    Specified by:
    
    getFileFromAttachment in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getAttachmentSize
```
public long getAttachmentSize(ExchangeAttachmentReference a)
                       throws FileSystemException
```
    Specified by:
    
    getAttachmentSize in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getAttachmentContentType
```
public String getAttachmentContentType(ExchangeAttachmentReference a)
                                throws FileSystemException
```
    Specified by:
    
    getAttachmentContentType in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getAttachmentFileName
```
public String getAttachmentFileName(ExchangeAttachmentReference ref)
                             throws FileSystemException
```
    Specified by:
    
    getAttachmentFileName in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getAdditionalAttachmentProperties
```
public Map<String,Object> getAdditionalAttachmentProperties(ExchangeAttachmentReference ref)
                                                     throws FileSystemException
```
    Specified by:
    
    getAdditionalAttachmentProperties in interface IWithAttachments<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - createFolder
```
public void createFolder(String folderName)
                  throws FileSystemException
```
    Specified by:
    
    createFolder in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - removeFolder
```
public void removeFolder(String folderName,
                         boolean removeNonEmptyFolder)
                  throws FileSystemException
```
    Specified by:
    
    removeFolder in interface IBasicFileSystem<ExchangeMessageReference>
    
    Throws:
    
    FileSystemException
  - getFrom
```
protected String getFrom(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)
```
  - getSender
```
protected String getSender(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)
```
  - getReplyTo
```
protected List<String> getReplyTo(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)
```
  - getDateTimeSent
```
protected Date getDateTimeSent(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)
```
  - getDateTimeReceived
```
protected Date getDateTimeReceived(microsoft.exchange.webservices.data.core.service.item.EmailMessage emailMessage)
```
  - getSubject
```
public String getSubject(ExchangeMessageReference ref)
                  throws FileSystemException
```
    Specified by:
    
    getSubject in interface IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getMimeContent
```
public Message getMimeContent(ExchangeMessageReference ref)
                       throws FileSystemException
```
    Specified by:
    
    getMimeContent in interface IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - extractEmail
```
public void extractEmail(ExchangeMessageReference ref,
                         SaxElementBuilder emailXml)
                  throws FileSystemException
```
    Specified by:
    
    extractEmail in interface IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - extractAttachment
```
public void extractAttachment(ExchangeAttachmentReference ref,
                              SaxElementBuilder attachmentsXml)
                       throws FileSystemException
```
    Specified by:
    
    extractAttachment in interface IMailFileSystem<ExchangeMessageReference,ExchangeAttachmentReference>
    
    Throws:
    
    FileSystemException
  - getPhysicalDestinationName
```
public String getPhysicalDestinationName()
```
    Specified by:
    
    getPhysicalDestinationName in interface HasPhysicalDestination
    
    Overrides:
    
    getPhysicalDestinationName in class MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
  - releaseConnection
```
protected void releaseConnection(microsoft.exchange.webservices.data.core.ExchangeService service,
                                 boolean invalidateConnectionOnRelease)
```
    Description copied from class: ConnectedFileSystemBase
    
    Release the connection, return it to the pool or invalidate it.
    
    Overrides:
    
    releaseConnection in class ConnectedFileSystemBase<ExchangeMessageReference,microsoft.exchange.webservices.data.core.ExchangeService>
  - setMailAddress
```
public void setMailAddress(String mailAddress)
```
    The mail address of the mailbox connected to (also used for auto discovery)
  - setValidateAllRedirectUrls
```
public void setValidateAllRedirectUrls(boolean validateAllRedirectUrls)
```
    When true, all redirect uris are accepted when connecting to the server
    
    Default value
    
    true
  - setUrl
```
public void setUrl(String url)
```
    Url of the Exchange server. Set to e.g. https://outlook.office365.com/EWS/Exchange.asmx to speed up startup, leave empty to use autodiscovery
  - setClientId
```
public void setClientId(String clientId)
```
    Client ID that represents a registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    Client secret that belongs to registered application in Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Certificates and Secrets
  - setTenantId
```
public void setTenantId(String tenantId)
```
    Tenant ID that represents the tenant in which the registered application exists within Azure AD which could be found at Azure AD -> App Registrations -> MyApp -> Overview.
  - setAuthAlias
```
public void setAuthAlias(String authAlias)
```
    Alias used to obtain client ID and secret or username and password for authentication to Exchange mail server. If the attribute tenantId is empty, the deprecated Basic Authentication method is used. If the attribute tenantId is not empty, the username and password are treated as the client ID and secret.
    
    Overrides:
    
    setAuthAlias in class MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
  - setUsername
```
@Deprecated
 @ConfigurationWarning(value="Authentication to Exchange Web Services with username and password will be disabled 2021-Q3. Please migrate to modern authentication using clientId and clientSecret!")
public void setUsername(String username)
```
    Deprecated.
    
    Username for authentication to Exchange mail server. Ignored when tenantId is also specified
    
    Overrides:
    
    setUsername in class MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
  - setPassword
```
@Deprecated
 @ConfigurationWarning(value="Authentication to Exchange Web Services with username and password will be disabled 2021-Q3. Please migrate to modern authentication using clientId and clientSecret!")
public void setPassword(String password)
```
    Deprecated.
    
    Password for authentication to Exchange mail server. Ignored when tenantId is also specified
    
    Overrides:
    
    setPassword in class MailFileSystemBase<ExchangeMessageReference,ExchangeAttachmentReference,microsoft.exchange.webservices.data.core.ExchangeService>
  - setFilter
```
public void setFilter(String filter)
```
    If empty, all mails are retrieved. If set to NDR only Non-Delivery Report mails ('bounces') are retrieved
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    proxy host
  - setProxyPort
```
public void setProxyPort(int proxyPort)
```
    proxy port
    
    Default value
    
    8080
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    proxy username
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    proxy password
  - setProxyAuthAlias
```
public void setProxyAuthAlias(String proxyAuthAlias)
```
    proxy authAlias
  - setProxyDomain
```
public void setProxyDomain(String proxyDomain)
```
    proxy domain
  - setMailboxObjectSeparator
```
public void setMailboxObjectSeparator(String separator)
```
    Separator character used when working with multiple mailboxes, specified before the separator in the object name test@organisation.com|My sub folder or test@organisation.com|AAMkADljZDMxYzIzLTFlMjYtNGY4Mi1hM2Y1LTc2MjE5ZjIyZmMyNABGAAAAAAAu/9EmV5M6QokBRZwID1Q6BwDXQXY+F44hRbDfTB9v8jRfAAAEUqUVAADXQXY+F44hRbDfTB9v8jRfAAKA4F+pAAA=. Please consider when moving emails across mailboxes that there will be a null value returned instead of the newly created identifier.
    
    Default value
    
    |

Class ExchangeFileSystem

Field Summary

Fields inherited from class nl.nn.adapterframework.filesystem.FileSystemBase

Fields inherited from interface nl.nn.adapterframework.filesystem.IMailFileSystem

Constructor Summary

Method Summary

Methods inherited from class nl.nn.adapterframework.filesystem.MailFileSystemBase

Methods inherited from class nl.nn.adapterframework.filesystem.ConnectedFileSystemBase

Methods inherited from class nl.nn.adapterframework.filesystem.FileSystemBase

Methods inherited from class java.lang.Object

Methods inherited from interface nl.nn.adapterframework.encryption.HasKeystore

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

Methods inherited from interface org.springframework.context.ApplicationContextAware

Methods inherited from interface nl.nn.adapterframework.encryption.HasTruststore

Methods inherited from interface nl.nn.adapterframework.filesystem.IMailFileSystem

Methods inherited from interface nl.nn.adapterframework.filesystem.IBasicFileSystem

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

Constructor Detail

ExchangeFileSystem

Method Detail

configure

open

close

getBaseFolderId

createConnection

findFolder

findFolder

toFile

toFile

exists

listFiles

getNumberOfFilesInFolder

folderExists

readFile

deleteFile

moveFile

copyFile

getFileSize

getName

getParentFolder

getCanonicalName

getModificationTime

getAdditionalFileProperties

forwardMail

listAttachments

getAttachmentName

readAttachment

getFileFromAttachment

getAttachmentSize

getAttachmentContentType

getAttachmentFileName

getAdditionalAttachmentProperties

createFolder

removeFolder

getFrom

getSender

getReplyTo

getDateTimeSent

getDateTimeReceived

getSubject

getMimeContent

extractEmail

extractAttachment

getPhysicalDestinationName

releaseConnection

setMailAddress

setValidateAllRedirectUrls

setUrl

setClientId

setClientSecret

setTenantId

setAuthAlias

setUsername

setPassword

setFilter

setProxyHost

setProxyPort

setProxyUsername

setProxyPassword