Class BodyPartBuilder

java.lang.Object

org.apache.james.mime4j.internal.AbstractEntityBuilder

org.apache.james.mime4j.message.BodyPartBuilder

public class BodyPartBuilder
extends AbstractEntityBuilder

BodyPart builder.

Field Summary

Fields

Modifier and Type	Field	Description
private BodyFactory	bodyFactory

Constructor Summary

Constructors

Constructor	Description
BodyPartBuilder()

Method Summary

Modifier and Type	Method	Description
AbstractEntityBuilder	addField(Field field)	Adds a field to the end of the list of fields.
BodyPart	build()
static BodyPartBuilder	create()
AbstractEntityBuilder	removeFields(String name)	Removes all Fields having the specified field name.
BodyPartBuilder	setBody(byte[] bin, String mimeType)	Sets binary content of this message with the given MIME type.
BodyPartBuilder	setBody(String text, String subtype, Charset charset)	Sets text of this message with the given MIME subtype and charset.
BodyPartBuilder	setBody(String text, Charset charset)	Sets text of this message with the charset.
BodyPartBuilder	setBody(BinaryBody binaryBody)	Sets binaryBody of this message.
BodyPartBuilder	setBody(Body body)	Sets body of this message.
BodyPartBuilder	setBody(Message message)	Sets body of this message.
BodyPartBuilder	setBody(Multipart multipart)	Sets body of this message.
BodyPartBuilder	setBody(TextBody textBody)	Sets body of this message.
BodyPartBuilder	setContentDisposition(String dispositionType)	Sets content disposition of this message to the specified disposition type.
BodyPartBuilder	setContentDisposition(String dispositionType, String filename)	Sets content disposition of this message to the specified disposition type and filename.
BodyPartBuilder	setContentDisposition(String dispositionType, String filename, long size)	Sets content disposition of this message to the specified values.
BodyPartBuilder	setContentDisposition(String dispositionType, String filename, long size, Date creationDate, Date modificationDate, Date readDate)	Sets content disposition of this message to the specified values.
BodyPartBuilder	setContentTransferEncoding(String contentTransferEncoding)	Sets transfer encoding of this message.
BodyPartBuilder	setContentType(String mimeType, NameValuePair... parameters)	Sets transfer encoding of this message.
BodyPartBuilder	setField(Field field)	Sets or replaces a field.
BodyPartBuilder	use(BodyFactory bodyFactory)	Sets BodyFactory that will be used to generate message body.

Methods inherited from class AbstractEntityBuilder

clearFields, containsField, getBody, getCharset, getContentTransferEncoding, getCreationDate, getDispositionType, getField, getField, getFields, getFields, getFields, getFilename, getMimeType, getModificationDate, getReadDate, getSize, obtainField, setBody, setBody, setBody

Methods inherited from class Object

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

Field Details

bodyFactory

private BodyFactory bodyFactory

Constructor Details

BodyPartBuilder

public BodyPartBuilder()

Method Details

create

public static BodyPartBuilder create()

use

public BodyPartBuilder use(BodyFactory bodyFactory)

Sets BodyFactory that will be used to generate message body.

Parameters:

bodyFactory - body factory.

setField

public BodyPartBuilder setField(Field field)

Description copied from class: AbstractEntityBuilder

Sets or replaces a field. This method is useful for header fields such as Subject or Message-ID that should not occur more than once in a message. If this builder does not already contain a header field of the same name as the given field then it is added to the end of the list of fields (same behavior as AbstractEntityBuilder.addField(org.apache.james.mime4j.stream.Field)). Otherwise the first occurrence of a field with the same name is replaced by the given field and all further occurrences are removed.

Overrides:

setField in class AbstractEntityBuilder

Parameters:

field - the field to set.

addField

public AbstractEntityBuilder addField(Field field)

Description copied from class: AbstractEntityBuilder

Adds a field to the end of the list of fields.

Overrides:

addField in class AbstractEntityBuilder

Parameters:

field - the field to add.

removeFields

public AbstractEntityBuilder removeFields(String name)

Description copied from class: AbstractEntityBuilder

Removes all Fields having the specified field name.

Overrides:

removeFields in class AbstractEntityBuilder

Parameters:

name - the field name (e.g. From, Subject).

setContentTransferEncoding

public BodyPartBuilder setContentTransferEncoding(String contentTransferEncoding)

Description copied from class: AbstractEntityBuilder

Sets transfer encoding of this message.

Overrides:

setContentTransferEncoding in class AbstractEntityBuilder

Parameters:

contentTransferEncoding - transfer encoding to use.

setContentType

public BodyPartBuilder setContentType(String mimeType,
 NameValuePair... parameters)

Description copied from class: AbstractEntityBuilder

Sets transfer encoding of this message.

Overrides:

setContentType in class AbstractEntityBuilder

Parameters:

mimeType - MIME type of this message the MIME type to use.

parameters - content type parameters to use.

setContentDisposition

public BodyPartBuilder setContentDisposition(String dispositionType)

Description copied from class: AbstractEntityBuilder

Sets content disposition of this message to the specified disposition type. No filename, size or date parameters are included in the content disposition.

Overrides:

setContentDisposition in class AbstractEntityBuilder

Parameters:

dispositionType - disposition type value (usually inline or attachment).

setContentDisposition

public BodyPartBuilder setContentDisposition(String dispositionType,
 String filename)

Description copied from class: AbstractEntityBuilder

Sets content disposition of this message to the specified disposition type and filename. No size or date parameters are included in the content disposition.

Overrides:

setContentDisposition in class AbstractEntityBuilder

Parameters:

dispositionType - disposition type value (usually inline or attachment).

filename - filename parameter value or null if the parameter should not be included.

setContentDisposition

public BodyPartBuilder setContentDisposition(String dispositionType,
 String filename,
 long size)

Description copied from class: AbstractEntityBuilder

Sets content disposition of this message to the specified values. No date parameters are included in the content disposition.

Overrides:

setContentDisposition in class AbstractEntityBuilder

Parameters:

dispositionType - disposition type value (usually inline or attachment).

filename - filename parameter value or null if the parameter should not be included.

size - size parameter value or -1 if the parameter should not be included.

setContentDisposition

public BodyPartBuilder setContentDisposition(String dispositionType,
 String filename,
 long size,
 Date creationDate,
 Date modificationDate,
 Date readDate)

Description copied from class: AbstractEntityBuilder

Sets content disposition of this message to the specified values.

Overrides:

setContentDisposition in class AbstractEntityBuilder

Parameters:

dispositionType - disposition type value (usually inline or attachment).

filename - filename parameter value or null if the parameter should not be included.

size - size parameter value or -1 if the parameter should not be included.

creationDate - creation-date parameter value or null if the parameter should not be included.

modificationDate - modification-date parameter value or null if the parameter should not be included.

readDate - read-date parameter value or null if the parameter should not be included.

setBody

public BodyPartBuilder setBody(Body body)

Description copied from class: AbstractEntityBuilder

Sets body of this message. Also sets the content type based on properties of the given Body.

Overrides:

setBody in class AbstractEntityBuilder

Parameters:

body - the body.

setBody

public BodyPartBuilder setBody(TextBody textBody)

Description copied from class: AbstractEntityBuilder

Sets body of this message. Also sets the content type based on properties of the given Body.

Overrides:

setBody in class AbstractEntityBuilder

Parameters:

textBody - the body.

setBody

public BodyPartBuilder setBody(BinaryBody binaryBody)

Description copied from class: AbstractEntityBuilder

Sets binaryBody of this message. Also sets the content type based on properties of the given Body.

Overrides:

setBody in class AbstractEntityBuilder

Parameters:

binaryBody - the binaryBody.

setBody

public BodyPartBuilder setBody(Multipart multipart)

Description copied from class: AbstractEntityBuilder

Sets body of this message. Also sets the content type based on properties of the given Multipart.

Overrides:

setBody in class AbstractEntityBuilder

Parameters:

multipart - the body.

setBody

public BodyPartBuilder setBody(Message message)

Description copied from class: AbstractEntityBuilder

Sets body of this message. Also sets the content type based on properties of the given Message.

Overrides:

setBody in class AbstractEntityBuilder

Parameters:

message - the body.

setBody

public BodyPartBuilder setBody(String text,
 Charset charset)
                        throws IOException

Sets text of this message with the charset.

Parameters:

text - the text.

charset - the charset of the text.

Throws:

IOException

setBody

public BodyPartBuilder setBody(String text,
 String subtype,
 Charset charset)
                        throws IOException

Sets text of this message with the given MIME subtype and charset.

Parameters:

text - the text.

subtype - the text subtype (e.g. "plain", "html" or "xml").

charset - the charset of the text.

Throws:

IOException

setBody

public BodyPartBuilder setBody(byte[] bin,
 String mimeType)
                        throws IOException

Sets binary content of this message with the given MIME type.

Parameters:

bin - the body.

mimeType - the MIME media type of the specified body ("type/subtype").

Throws:

IOException

build

public BodyPart build()