com.adaptris.core.services.mime

Class InlineMimePartBuilder

java.lang.Object

com.adaptris.core.services.mime.InlineMimePartBuilder

All Implemented Interfaces:

MimePartBuilder

@ComponentProfile(summary="Builds a MIME Body part using a byte array",
                  since="3.9.0")
public class InlineMimePartBuilder
extends java.lang.Object
implements MimePartBuilder

Builds a MIME Body part by rendering a byte array as the content of the part.

Used as part of a MultipartMessageBuilder service; this constructs a MimeBodyPart from the configured body configuration. Depending on your use case you might opt to use ByteArrayFromPayload or ByteArrayFromMetadata to generate the actual contents for the part.

You can also specify the various headers that will be associated with the MimeBodyPart such as the Content-ID, Content-Type or Content-Transfer-Encoding. Additional non standard headers can be added by configuring a setPartHeaderFilter(MetadataFilter) to filter out metadata to include as part of the MimeBodyPart headers.

Since:

3.9.0

In the adapter configuration file this class is aliased as inline-mime-body-part-builder which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
InlineMimePartBuilder()

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.MimeBodyPart	build(AdaptrisMessage msg) Build the body part
MessageWrapper<byte[]>	getBody()
java.lang.String	getContentEncoding()
java.lang.String	getContentId()
java.lang.String	getContentType()
MetadataFilter	getPartHeaderFilter()
void	setBody(MessageWrapper<byte[]> body) Set where the body of the MimeBodyPart is going to come from.
void	setContentEncoding(java.lang.String s) Set the Content-Transfer-Encoding for the part.
void	setContentId(java.lang.String s) Set the Content-ID for the part,
void	setContentType(java.lang.String s) Set the Content-Type for the part.
void	setPartHeaderFilter(MetadataFilter filter) Set any additional headers that need to be set for this nested part.
InlineMimePartBuilder	withBody(MessageWrapper<byte[]> body)
InlineMimePartBuilder	withContentEncoding(java.lang.String s)
InlineMimePartBuilder	withContentId(java.lang.String s)
InlineMimePartBuilder	withContentType(java.lang.String s)
InlineMimePartBuilder	withPartHeaderFilter(MetadataFilter filter)

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineMimePartBuilder

public InlineMimePartBuilder()

Method Detail

build

public javax.mail.internet.MimeBodyPart build(AdaptrisMessage msg)
                                       throws java.lang.Exception

Description copied from interface: MimePartBuilder

Build the body part

Specified by:

build in interface MimePartBuilder

Throws:

java.lang.Exception

getBody

public MessageWrapper<byte[]> getBody()

setBody

public void setBody(MessageWrapper<byte[]> body)

Set where the body of the MimeBodyPart is going to come from.

Parameters:

body - the location of the body for the mime part; the default if not specified is the payload as a byte-array.

See Also:

ByteArrayFromMetadata, ByteArrayFromObjectMetadata, ByteArrayFromPayload

getPartHeaderFilter

public MetadataFilter getPartHeaderFilter()

setPartHeaderFilter

public void setPartHeaderFilter(MetadataFilter filter)

Set any additional headers that need to be set for this nested part.

Parameters:

filter - the metadata filter.

getContentEncoding

public java.lang.String getContentEncoding()

setContentEncoding

public void setContentEncoding(java.lang.String s)

Set the Content-Transfer-Encoding for the part.

Set the encoding of the mime part; if the mime part contains text you probably don't need to specify this; any RFC2045 value is supported such as base64,quoted-printable,uuencode,x-uuencode,x-uue,binary,7bit,8bit and is passed directly to MimeUtility#encode(java.io.OutputStream, String, String).

Parameters:

s - the Content-Transfer-Encoding, which supports the %message{} syntax to resolve metadata, default is 'null', no encoding.

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String s)

Set the Content-Type for the part.

Parameters:

s - the Content-Type, which supports the %message{} syntax to resolve metadata; if not specified defaults to application/octet-stream

getContentId

public java.lang.String getContentId()

setContentId

public void setContentId(java.lang.String s)

Set the Content-ID for the part,

Parameters:

s - the Content-ID, which supports the %message{} syntax to resolve metadata; defaults to a new GUID if no value is specified.

withBody

public InlineMimePartBuilder withBody(MessageWrapper<byte[]> body)

withContentEncoding

public InlineMimePartBuilder withContentEncoding(java.lang.String s)

withContentId

public InlineMimePartBuilder withContentId(java.lang.String s)

withContentType

public InlineMimePartBuilder withContentType(java.lang.String s)

withPartHeaderFilter

public InlineMimePartBuilder withPartHeaderFilter(MetadataFilter filter)