com.googlecode.kevinarpe.papaya.java_mail

Interface EmailMessageTextAttachmentBuilder

All Known Implementing Classes:

EmailMessageTextAttachmentBuilderImp

public interface EmailMessageTextAttachmentBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Method Summary

Modifier and Type	Method and Description
EmailMessageTextAttachmentBuilder	attachmentFileName(String attachmentFileName) This is the most common attachment type.
EmailMessageTextAttachmentBuilder	attachText(String text, EmailMessageAttachmentTextNewLine newLine, IsEmptyAllowed isEmptyAllowed) Converts text new-lines (if necessary), then adds new attachment to the parent builder.
EmailMessageTextAttachmentBuilder	attachTextFile(File filePath, Charset fileCharset, EmailMessageAttachmentTextNewLine newLine, IsEmptyAllowed isEmptyAllowed) Immediately reads the contents of the file as text, converts text new-lines (if necessary), then adds new attachment to the parent builder.
EmailMessageTextAttachmentBuilder	attachTextInputStream(InputStream inputStream, Charset inputStreamCharset, EmailMessageAttachmentTextNewLine newLine, IsEmptyAllowed isEmptyAllowed) Immediately reads the contents of the InputStream as text, converts text new-lines (if necessary), then adds new attachment to the parent builder.
EmailMessageTextAttachmentBuilder	customTextMimeSubType(String customTextMimeSubType) RARE: Sets the text MIME sub-type to a custom value.
EmailMessageTextAttachmentBuilder	inline() RARE: Sets the attachment type to EmailMessageAttachmentType.INLINE and clears the attachment file name.
EmailMessageBuilder	parent() Access the parent email message builder
EmailMessageTextAttachmentBuilder	textMimeSubType(TextMimeSubType textMimeSubType) Sets the text MIME sub-type to a common value -- text or plain.

Method Detail

parent

EmailMessageBuilder parent()

Access the parent email message builder

attachmentFileName

EmailMessageTextAttachmentBuilder 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: "log.txt"

Returns:

self for fluent interface / method chaining

See Also:

inline()

inline

EmailMessageTextAttachmentBuilder 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)

textMimeSubType

EmailMessageTextAttachmentBuilder textMimeSubType(TextMimeSubType textMimeSubType)

Sets the text MIME sub-type to a common value -- text or plain.

For custom types, see: customTextMimeSubType(String).

Returns:

self for fluent interface / method chaining

See Also:

customTextMimeSubType(String)

customTextMimeSubType

EmailMessageTextAttachmentBuilder customTextMimeSubType(String customTextMimeSubType)

RARE: Sets the text MIME sub-type to a custom value.

For common types, see textMimeSubType(TextMimeSubType).

Returns:

self for fluent interface / method chaining

See Also:

textMimeSubType(TextMimeSubType)

attachTextFile

EmailMessageTextAttachmentBuilder attachTextFile(File filePath,
                                                 Charset fileCharset,
                                                 EmailMessageAttachmentTextNewLine newLine,
                                                 IsEmptyAllowed isEmptyAllowed)
                                          throws Exception

Immediately reads the contents of the file as text, converts text new-lines (if necessary), then adds new attachment to the parent builder.

Implementation note: Regardless of fileCharset, the text is always re-encoded using StandardCharsets.UTF_8 before attachment. Why? In 2020, everything should be UTF-8!

Parameters:

filePath - path to file with text

fileCharset - charset used to read text from filePath

newLine - for internal emails at large corporations, EmailMessageAttachmentTextNewLine.WINDOWS is probably most friendly towards Microsoft Windows and Microsoft Outlook users
When inline() is used, this option may be irrelevant. Multiple tests showed the new-lines for inline text on received emails to always be Microsoft Windows new-lines.

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:

attachTextInputStream(InputStream, Charset, EmailMessageAttachmentTextNewLine, IsEmptyAllowed), attachText(String, EmailMessageAttachmentTextNewLine, IsEmptyAllowed)

attachTextInputStream

EmailMessageTextAttachmentBuilder attachTextInputStream(InputStream inputStream,
                                                        Charset inputStreamCharset,
                                                        EmailMessageAttachmentTextNewLine newLine,
                                                        IsEmptyAllowed isEmptyAllowed)
                                                 throws Exception

Immediately reads the contents of the InputStream as text, converts text new-lines (if necessary), then adds new attachment to the parent builder.

Implementation note: Regardless of fileCharset, the text is always re-encoded using StandardCharsets.UTF_8 before attachment. Why? In 2020, everything should be UTF-8!

Parameters:

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

inputStreamCharset - charset used to read text from inputStream

newLine - for internal emails at large corporations, EmailMessageAttachmentTextNewLine.WINDOWS is probably most friendly towards Microsoft Windows and Microsoft Outlook users
When inline() is used, this option may be irrelevant. Multiple tests showed the new-lines for inline text on received emails to always be Microsoft Windows new-lines.

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:

attachTextFile(File, Charset, EmailMessageAttachmentTextNewLine, IsEmptyAllowed), attachText(String, EmailMessageAttachmentTextNewLine, IsEmptyAllowed)

attachText

EmailMessageTextAttachmentBuilder attachText(String text,
                                             EmailMessageAttachmentTextNewLine newLine,
                                             IsEmptyAllowed isEmptyAllowed)

Converts text new-lines (if necessary), then adds new attachment to the parent builder.

Implementation note: Regardless of fileCharset, the text is always re-encoded using StandardCharsets.UTF_8 before attachment. Why? In 2020, everything should be UTF-8!

Parameters:

text - text for attachment

newLine - for internal emails at large corporations, EmailMessageAttachmentTextNewLine.WINDOWS is probably most friendly towards Microsoft Windows and Microsoft Outlook users
When inline() is used, this option may be irrelevant. Multiple tests showed the new-lines for inline text on received emails to always be Microsoft Windows new-lines.

isEmptyAllowed - normally, use IsEmptyAllowed.NO

Returns:

self for fluent interface / method chaining

Throws:

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

See Also:

attachTextFile(File, Charset, EmailMessageAttachmentTextNewLine, IsEmptyAllowed), attachTextInputStream(InputStream, Charset, EmailMessageAttachmentTextNewLine, IsEmptyAllowed)