com.googlecode.kevinarpe.papaya.java_mail

Class EmailMessageAttachment

java.lang.Object

com.googlecode.kevinarpe.papaya.java_mail.EmailMessageAttachment

@FullyTested
public final class EmailMessageAttachment
extends Object

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
EmailMessageAttachmentType	attachmentType
byte[]	byteArr Data for attachment
String	mimeType Ex(Text): "text/plain; charset=utf-8"
String	nullableFileName Never null when attachmentType is EmailMessageAttachmentType.ATTACHMENT.

Constructor Summary

Constructors

Constructor and Description
EmailMessageAttachment(EmailMessageAttachmentType attachmentType, String nullableFileName, String mimeType, byte[] byteArr, IsEmptyAllowed isEmptyAllowed) Instead of direct access, API users should use EmailMessageBuilder.builderForTextAttachment() or EmailMessageBuilder.builderForBinaryAttachment().

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

attachmentType

public final EmailMessageAttachmentType attachmentType

nullableFileName

@Nullable
public String nullableFileName

Never null when attachmentType is EmailMessageAttachmentType.ATTACHMENT.

Always null when attachmentType is EmailMessageAttachmentType.INLINE.

Ex(Text): "log.txt"

Ex(Binary): "binary_data.bin"

mimeType

public final String mimeType

Ex(Text): "text/plain; charset=utf-8"

Ex(Binary): "application/octet-stream"

byteArr

public final byte[] byteArr

Data for attachment

Constructor Detail

EmailMessageAttachment

public EmailMessageAttachment(EmailMessageAttachmentType attachmentType,
                              @Nullable
                              String nullableFileName,
                              String mimeType,
                              byte[] byteArr,
                              IsEmptyAllowed isEmptyAllowed)

Instead of direct access, API users should use EmailMessageBuilder.builderForTextAttachment() or EmailMessageBuilder.builderForBinaryAttachment().

Parameters:

attachmentType - most users will expect EmailMessageAttachmentType.ATTACHMENT

nullableFileName - when attachmentType is EmailMessageAttachmentType.ATTACHMENT, must not be empty or all whitespace
when attachmentType is EmailMessageAttachmentType.INLINE, always null

mimeType - MIME type for attachment
See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

byteArr - array of bytes for the attachment
if isEmptyAllowed is IsEmptyAllowed.NO, this array must not be empty.

isEmptyAllowed - normally, this is IsEmptyAllowed.NO

Throws:

IllegalArgumentException - if attachmentType is EmailMessageAttachmentType.ATTACHMENT and nullableFileName is empty or all whitespace
if mimeType is empty or all whitespace
if isEmptyAllowed is IsEmptyAllowed.NO and byteArr is empty