com.googlecode.kevinarpe.papaya.java_mail

Class EmailMessageBinaryAttachmentBuilderImp

java.lang.Object

com.googlecode.kevinarpe.papaya.java_mail.EmailMessageBinaryAttachmentBuilderImp

All Implemented Interfaces:

EmailMessageBinaryAttachmentBuilder

@FullyTested
public final class EmailMessageBinaryAttachmentBuilderImp
extends Object
implements EmailMessageBinaryAttachmentBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com) See: EmailMessageBuilderImpTest

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Constructor Summary

Constructors

Constructor and Description
EmailMessageBinaryAttachmentBuilderImp(EmailMessageBuilder parentBuilder)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailMessageBinaryAttachmentBuilderImp

public EmailMessageBinaryAttachmentBuilderImp(EmailMessageBuilder parentBuilder)

Method Detail

parent

public EmailMessageBuilder parent()

Access the parent email message builder

Specified by:

parent in interface EmailMessageBinaryAttachmentBuilder

attachmentFileName

public EmailMessageBinaryAttachmentBuilder attachmentFileName(String attachmentFileName)

This is the most common attachment type.

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

Specified by:

attachmentFileName in interface EmailMessageBinaryAttachmentBuilder

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:

EmailMessageBinaryAttachmentBuilder.inline()

inline

public EmailMessageBinaryAttachmentBuilder inline()

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

Specified by:

inline in interface EmailMessageBinaryAttachmentBuilder

Returns:

self for fluent interface / method chaining

See Also:

EmailMessageBinaryAttachmentBuilder.attachmentFileName(String)

mimeType

public 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

Specified by:

mimeType in interface EmailMessageBinaryAttachmentBuilder

Returns:

self for fluent interface / method chaining

attachMessage

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

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

Specified by:

attachMessage in interface EmailMessageBinaryAttachmentBuilder

Parameters:

message - MIME message to attach

Returns:

self for fluent interface / method chaining

Throws:

Exception - on I/O exception

See Also:

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

attachBinaryFile

public 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.

Specified by:

attachBinaryFile in interface EmailMessageBinaryAttachmentBuilder

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:

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

attachBinaryInputStream

public 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.

Specified by:

attachBinaryInputStream in interface EmailMessageBinaryAttachmentBuilder

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:

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

attachBinaryData

public EmailMessageBinaryAttachmentBuilder attachBinaryData(byte[] byteArr,
                                                            IsEmptyAllowed isEmptyAllowed)

Adds new attachment to the parent builder.

Specified by:

attachBinaryData in interface EmailMessageBinaryAttachmentBuilder

Parameters:

byteArr - byte array for attachment

isEmptyAllowed - normally, use IsEmptyAllowed.NO

Returns:

self for fluent interface / method chaining

See Also:

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