com.googlecode.kevinarpe.papaya.java_mail

Interface EmailMessageBinaryAttachmentBuilder

All Known Implementing Classes:

EmailMessageBinaryAttachmentBuilderImp

public interface EmailMessageBinaryAttachmentBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Method Summary

Modifier and Type	Method and Description
EmailMessageBinaryAttachmentBuilder	attachBinaryData(byte[] byteArr, IsEmptyAllowed isEmptyAllowed) Adds new attachment to the parent builder.
EmailMessageBinaryAttachmentBuilder	attachBinaryFile(File filePath, IsEmptyAllowed isEmptyAllowed) Immediately reads the contents of the file as binary data, then adds new attachment to the parent builder.
EmailMessageBinaryAttachmentBuilder	attachBinaryInputStream(InputStream inputStream, IsEmptyAllowed isEmptyAllowed) Immediately reads the contents of the InputStream as binary data, then adds new attachment to the parent builder.
EmailMessageBinaryAttachmentBuilder	attachmentFileName(String attachmentFileName) This is the most common attachment type.
EmailMessageBinaryAttachmentBuilder	attachMessage(javax.mail.Message message) Converts a MIME message to binary data, then adds new attachment to the parent builder.
EmailMessageBinaryAttachmentBuilder	inline() RARE: Sets the attachment type to EmailMessageAttachmentType.INLINE and clears the attachment file name.
EmailMessageBinaryAttachmentBuilder	mimeType(String mimeType) Sets the MIME type.
EmailMessageBuilder	parent() Access the parent email message builder

Method Detail

parent

EmailMessageBuilder parent()

Access the parent email message builder

attachmentFileName

EmailMessageBinaryAttachmentBuilder attachmentFileName(String attachmentFileName)

This is the most common attachment type.

Sets the attachment type to EmailMessageAttachmentType.ATTACHMENT and sets the attachment file name.

Parameters:

attachmentFileName - only a file name -- does not include a parent path
Ex: "binary_data.bin"

Returns:

self for fluent interface / method chaining

See Also:

inline()

inline

EmailMessageBinaryAttachmentBuilder inline()

RARE: Sets the attachment type to EmailMessageAttachmentType.INLINE and clears the attachment file name.

Returns:

self for fluent interface / method chaining

See Also:

attachmentFileName(String)

mimeType

EmailMessageBinaryAttachmentBuilder mimeType(String mimeType)

Sets the MIME type. A good default for binary attachments is "application/octet-stream".

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

Returns:

self for fluent interface / method chaining

attachMessage

EmailMessageBinaryAttachmentBuilder attachMessage(javax.mail.Message message)
                                           throws Exception

Converts a MIME message to binary data, then adds new attachment to the parent builder.

Parameters:

message - MIME message to attach

Returns:

self for fluent interface / method chaining

Throws:

Exception - on I/O exception

See Also:

JavaMailMessageService.getMimeContentAsByteArr(Message), attachBinaryFile(File, IsEmptyAllowed), attachBinaryInputStream(InputStream, IsEmptyAllowed), attachBinaryData(byte[], IsEmptyAllowed)

attachBinaryFile

EmailMessageBinaryAttachmentBuilder attachBinaryFile(File filePath,
                                                     IsEmptyAllowed isEmptyAllowed)
                                              throws Exception

Immediately reads the contents of the file as binary data, then adds new attachment to the parent builder.

Parameters:

filePath - path to file with text

isEmptyAllowed - normally, use IsEmptyAllowed.NO

Returns:

self for fluent interface / method chaining

Throws:

Exception - on I/O exception
if isEmptyAllowed is IsEmptyAllowed.NO and the file is empty

See Also:

attachMessage(Message), attachBinaryInputStream(InputStream, IsEmptyAllowed), attachBinaryData(byte[], IsEmptyAllowed)

attachBinaryInputStream

EmailMessageBinaryAttachmentBuilder attachBinaryInputStream(InputStream inputStream,
                                                            IsEmptyAllowed isEmptyAllowed)
                                                     throws Exception

Immediately reads the contents of the InputStream as binary data, then adds new attachment to the parent builder.

Parameters:

inputStream - unlike most Java APIs, the input stream is closed after reading. This is the source or many hidden bugs!
See: InputStream.close()

isEmptyAllowed - normally, use IsEmptyAllowed.NO

Returns:

self for fluent interface / method chaining

Throws:

Exception - on I/O exception
if isEmptyAllowed is IsEmptyAllowed.NO and inputStream is empty

See Also:

attachMessage(Message), attachBinaryFile(File, IsEmptyAllowed), attachBinaryData(byte[], IsEmptyAllowed)

attachBinaryData

EmailMessageBinaryAttachmentBuilder attachBinaryData(byte[] byteArr,
                                                     IsEmptyAllowed isEmptyAllowed)

Adds new attachment to the parent builder.

Parameters:

byteArr - byte array for attachment

isEmptyAllowed - normally, use IsEmptyAllowed.NO

Returns:

self for fluent interface / method chaining

Throws:

IllegalArgumentException - if isEmptyAllowed is IsEmptyAllowed.NO and byteArr is empty

See Also:

attachMessage(Message), attachBinaryFile(File, IsEmptyAllowed), attachBinaryInputStream(InputStream, IsEmptyAllowed)