Package org.frankframework.filesystem

Class AbstractMailFileSystem<M,A,C extends AutoCloseable>

java.lang.Object

org.frankframework.filesystem.AbstractFileSystem<M>

org.frankframework.filesystem.AbstractConnectedFileSystem<M,C>

org.frankframework.filesystem.AbstractMailFileSystem<M,A,C>

All Implemented Interfaces:

AutoCloseable, HasPhysicalDestination, IBasicFileSystem<M>, IMailFileSystem<M,A>

Direct Known Subclasses:

ImapFileSystem

public abstract class AbstractMailFileSystem<M,A,C extends AutoCloseable>
extends AbstractConnectedFileSystem<M,C>
implements IMailFileSystem<M,A>

Baseclass for MailFileSystems.

Author:

Gerrit van Brakel

Field Summary

Fields inherited from interface org.frankframework.filesystem.IMailFileSystem

BCC_RECIPIENTS_KEY, BEST_REPLY_ADDRESS_KEY, CC_RECIPIENTS_KEY, DATETIME_RECEIVED_KEY, DATETIME_SENT_KEY, FROM_ADDRESS_KEY, MAIL_MESSAGE_ID, REPLY_ADDRESS_FIELDS_DEFAULT, REPLY_TO_RECIPIENTS_KEY, RETURN_PATH_HEADER, SENDER_ADDRESS_KEY, TO_RECIPIENTS_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractMailFileSystem()

Method Summary

Modifier and Type	Method	Description
String	getPhysicalDestinationName()
void	setAuthAlias(String authAlias)	Alias used to obtain accessToken or username and password for authentication to Exchange mail server.
void	setBaseFolder(String baseFolder)	Folder (subfolder of root or of inbox) to look for mails.
void	setPassword(String password)	Password for authentication to mail server.
void	setReadMimeContents(boolean readMimeContents)	If set true, the contents will be read in MIME format
void	setReplyAddressFields(String replyAddressFields)	Comma separated list of fields to try as response address
void	setUsername(String username)	Username for authentication to mail server.

Methods inherited from class org.frankframework.filesystem.AbstractConnectedFileSystem

close, closeConnection, createConnection, getConnection, open, releaseConnection

Methods inherited from class org.frankframework.filesystem.AbstractFileSystem

getMaxNumberOfMessagesToList, getNumberOfFilesInFolder, isOpen, setMaxNumberOfMessagesToList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

close, configure, copyFile, createFolder, deleteFile, exists, folderExists, getAdditionalFileProperties, getCanonicalName, getCanonicalNameOrErrorMessage, getFileSize, getModificationTime, getName, getNumberOfFilesInFolder, getParentFolder, isFolder, isOpen, list, list, moveFile, open, readFile, removeFolder, toFile, toFile

Methods inherited from interface org.frankframework.filesystem.IMailFileSystem

extractAttachment, extractEmail, forwardMail, getAdditionalAttachmentProperties, getAttachmentContentType, getAttachmentFileName, getAttachmentName, getAttachmentSize, getFileFromAttachment, getMimeContent, getReplyAddressFields, getSubject, listAttachments, readAttachment

Constructor Details

AbstractMailFileSystem

public AbstractMailFileSystem()

Method Details

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setAuthAlias

public void setAuthAlias(String authAlias)

Alias used to obtain accessToken or username and password for authentication to Exchange mail server. If the alias refers to a combination of a username and a password, the deprecated Basic Authentication method is used. If the alias refers to a password without a username, the password is treated as the accessToken.

setUsername

public void setUsername(String username)

Username for authentication to mail server.

setPassword

public void setPassword(String password)

Password for authentication to mail server.

setBaseFolder

public void setBaseFolder(String baseFolder)

Folder (subfolder of root or of inbox) to look for mails. If empty, the inbox folder is used

setReadMimeContents

public void setReadMimeContents(boolean readMimeContents)

If set true, the contents will be read in MIME format

Default value

false

setReplyAddressFields

public void setReplyAddressFields(String replyAddressFields)

Comma separated list of fields to try as response address

Default value

"replyTo,from,sender,Return-Path"<M,A>