Package org.frankframework.filesystem

Interface IMailFileSystem<M,A>

All Superinterfaces:

AutoCloseable, HasPhysicalDestination, IBasicFileSystem<M>

All Known Implementing Classes:

AbstractMailFileSystem, ImapFileSystem

public interface IMailFileSystem<M,A>
extends IBasicFileSystem<M>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BCC_RECIPIENTS_KEY
static final String	BEST_REPLY_ADDRESS_KEY
static final String	CC_RECIPIENTS_KEY
static final String	DATETIME_RECEIVED_KEY
static final String	DATETIME_SENT_KEY
static final String	FROM_ADDRESS_KEY
static final String	MAIL_MESSAGE_ID
static final String	REPLY_ADDRESS_FIELDS_DEFAULT
static final String	REPLY_TO_RECIPIENTS_KEY
static final String	RETURN_PATH_HEADER
static final String	SENDER_ADDRESS_KEY
static final String	TO_RECIPIENTS_KEY

Method Summary

Modifier and Type	Method	Description
void	extractAttachment(A attachment, SaxElementBuilder attachmentsXml)
void	extractEmail(M emailMessage, SaxElementBuilder emailXml)
void	forwardMail(M emailMessage, String destination)
Map<String,Object>	getAdditionalAttachmentProperties(A a)
String	getAttachmentContentType(A a)
String	getAttachmentFileName(A a)
String	getAttachmentName(A a)
long	getAttachmentSize(A a)
M	getFileFromAttachment(A a)
Message	getMimeContent(M emailMessage)
String	getReplyAddressFields()
String	getSubject(M emailMessage)
Iterator<A>	listAttachments(M f)
Message	readAttachment(A a)

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getPhysicalDestinationName

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

Field Details

MAIL_MESSAGE_ID

static final String MAIL_MESSAGE_ID

See Also:

• Constant Field Values

RETURN_PATH_HEADER

static final String RETURN_PATH_HEADER

See Also:

• Constant Field Values

TO_RECIPIENTS_KEY

static final String TO_RECIPIENTS_KEY

See Also:

• Constant Field Values

CC_RECIPIENTS_KEY

static final String CC_RECIPIENTS_KEY

See Also:

• Constant Field Values

BCC_RECIPIENTS_KEY

static final String BCC_RECIPIENTS_KEY

See Also:

• Constant Field Values

FROM_ADDRESS_KEY

static final String FROM_ADDRESS_KEY

See Also:

• Constant Field Values

SENDER_ADDRESS_KEY

static final String SENDER_ADDRESS_KEY

See Also:

• Constant Field Values

REPLY_TO_RECIPIENTS_KEY

static final String REPLY_TO_RECIPIENTS_KEY

See Also:

• Constant Field Values

DATETIME_SENT_KEY

static final String DATETIME_SENT_KEY

See Also:

• Constant Field Values

DATETIME_RECEIVED_KEY

static final String DATETIME_RECEIVED_KEY

See Also:

• Constant Field Values

BEST_REPLY_ADDRESS_KEY

static final String BEST_REPLY_ADDRESS_KEY

See Also:

• Constant Field Values

REPLY_ADDRESS_FIELDS_DEFAULT

static final String REPLY_ADDRESS_FIELDS_DEFAULT

See Also:

• Constant Field Values

Method Details

getSubject

String getSubject(M emailMessage)
           throws FileSystemException

Throws:

FileSystemException

getMimeContent

Message getMimeContent(M emailMessage)
                throws FileSystemException

Throws:

FileSystemException

forwardMail

void forwardMail(M emailMessage,
 String destination)
          throws FileSystemException

Throws:

FileSystemException

extractEmail

void extractEmail(M emailMessage,
 SaxElementBuilder emailXml)
           throws FileSystemException,
SAXException

Throws:

FileSystemException

SAXException

extractAttachment

void extractAttachment(A attachment,
 SaxElementBuilder attachmentsXml)
                throws FileSystemException,
SAXException

Throws:

FileSystemException

SAXException

getReplyAddressFields

String getReplyAddressFields()

listAttachments

Iterator<A> listAttachments(M f)
                     throws FileSystemException

Throws:

FileSystemException

getAttachmentName

String getAttachmentName(A a)
                  throws FileSystemException

Throws:

FileSystemException

readAttachment

Message readAttachment(A a)
                throws FileSystemException,
IOException

Throws:

FileSystemException

IOException

getAttachmentSize

long getAttachmentSize(A a)
                throws FileSystemException

Throws:

FileSystemException

getAttachmentContentType

String getAttachmentContentType(A a)
                         throws FileSystemException

Throws:

FileSystemException

getAttachmentFileName

String getAttachmentFileName(A a)
                      throws FileSystemException

Throws:

FileSystemException

getFileFromAttachment

M getFileFromAttachment(A a)
                 throws FileSystemException

Throws:

FileSystemException

getAdditionalAttachmentProperties

Map<String,Object> getAdditionalAttachmentProperties(A a)
                                              throws FileSystemException

Throws:

FileSystemException