org.apache.james.mime4j.field

Class Fields

java.lang.Object

org.apache.james.mime4j.field.Fields

public class Fields
extends java.lang.Object

Factory for concrete Field instances.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	FIELD_NAME_PATTERN

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Fields()

Method Summary

Modifier and Type	Method and Description
static AddressListField	addressList(java.lang.String fieldName, java.lang.Iterable<? extends Address> addresses) Creates an address-list field from the specified field name and mailbox or group addresses.
private static AddressListField	addressList0(java.lang.String fieldName, java.lang.Iterable<? extends Address> addresses)
static AddressListField	bcc(Address... addresses) Creates a Bcc field for the specified mailbox or group addresses.
static AddressListField	bcc(Address address) Creates a Bcc field for the specified mailbox or group address.
static AddressListField	bcc(java.lang.Iterable<Address> addresses) Creates a Bcc field for the specified mailbox or group addresses.
static AddressListField	cc(Address... addresses) Creates a Cc field for the specified mailbox or group addresses.
static AddressListField	cc(Address address) Creates a Cc field for the specified mailbox or group address.
static AddressListField	cc(java.lang.Iterable<Address> addresses) Creates a Cc field for the specified mailbox or group addresses.
private static void	checkValidFieldName(java.lang.String fieldName)
static ContentDispositionField	contentDisposition(java.lang.String contentDisposition) Creates a Content-Disposition field from the specified raw field value.
static ContentDispositionField	contentDisposition(java.lang.String dispositionType, java.lang.Iterable<NameValuePair> parameters) Creates a Content-Disposition field from the specified disposition type and parameters.
static ContentDispositionField	contentDisposition(java.lang.String dispositionType, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a Content-Disposition field from the specified disposition type and parameters.
static ContentDispositionField	contentDisposition(java.lang.String dispositionType, java.lang.String filename) Creates a Content-Disposition field from the specified disposition type and filename.
static ContentDispositionField	contentDisposition(java.lang.String dispositionType, java.lang.String filename, long size) Creates a Content-Disposition field from the specified values.
static ContentDispositionField	contentDisposition(java.lang.String dispositionType, java.lang.String filename, long size, java.util.Date creationDate, java.util.Date modificationDate, java.util.Date readDate) Creates a Content-Disposition field from the specified values.
static ContentTransferEncodingField	contentTransferEncoding(java.lang.String contentTransferEncoding) Creates a Content-Transfer-Encoding field from the specified raw field value.
static ContentTypeField	contentType(java.lang.String contentType) Creates a Content-Type field from the specified raw field value.
static ContentTypeField	contentType(java.lang.String mimeType, java.lang.Iterable<NameValuePair> parameters) Creates a Content-Type field from the specified MIME type and parameters.
static ContentTypeField	contentType(java.lang.String mimeType, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a Content-Type field from the specified MIME type and parameters.
static ContentTypeField	contentType(java.lang.String mimeType, NameValuePair... parameters) Creates a Content-Type field from the specified MIME type and parameters.
static DateTimeField	date(java.util.Date date) Creates a Date field from the specified Date value.
static DateTimeField	date(java.lang.String fieldName, java.util.Date date) Creates a date field from the specified field name and Date value.
static DateTimeField	date(java.lang.String fieldName, java.util.Date date, java.util.TimeZone zone) Creates a date field from the specified field name, Date and TimeZone values.
private static DateTimeField	date0(java.lang.String fieldName, java.util.Date date, java.util.TimeZone zone)
private static java.lang.String	encodeAddresses(java.lang.Iterable<? extends Address> addresses)
static MailboxListField	from(java.lang.Iterable<Mailbox> mailboxes) Creates a From field for the specified mailbox addresses.
static MailboxListField	from(Mailbox... mailboxes) Creates a From field for the specified mailbox addresses.
static MailboxListField	from(Mailbox mailbox) Creates a From field for the specified mailbox address.
static UnstructuredField	generateMessageId(java.lang.String hostname) Creates a Message-ID field for the specified host name.
private static boolean	isValidDispositionType(java.lang.String dispositionType)
private static boolean	isValidMimeType(java.lang.String mimeType)
static MailboxField	mailbox(java.lang.String fieldName, Mailbox mailbox) Creates a mailbox field from the specified field name and mailbox address.
private static MailboxField	mailbox0(java.lang.String fieldName, Mailbox mailbox)
static MailboxListField	mailboxList(java.lang.String fieldName, java.lang.Iterable<Mailbox> mailboxes) Creates a mailbox-list field from the specified field name and mailbox addresses.
private static MailboxListField	mailboxList0(java.lang.String fieldName, java.lang.Iterable<Mailbox> mailboxes)
static UnstructuredField	messageId(java.lang.String messageId) Creates a Message-ID field with the given message ID.
private static <F extends ParsedField> F	parse(FieldParser<F> parser, java.lang.String fieldName, java.lang.String fieldBody)
static AddressListField	replyTo(Address... addresses) Creates a Reply-To field for the specified mailbox or group addresses.
static AddressListField	replyTo(Address address) Creates a Reply-To field for the specified mailbox or group address.
static AddressListField	replyTo(java.lang.Iterable<Address> addresses) Creates a Reply-To field for the specified mailbox or group addresses.
static MailboxField	sender(Mailbox mailbox) Creates a Sender field for the specified mailbox address.
static UnstructuredField	subject(java.lang.String subject) Creates a Subject field from the specified string value.
static AddressListField	to(Address... addresses) Creates a To field for the specified mailbox or group addresses.
static AddressListField	to(Address address) Creates a To field for the specified mailbox or group address.
static AddressListField	to(java.lang.Iterable<Address> addresses) Creates a To field for the specified mailbox or group addresses.
static MimeVersionField	version(java.lang.String ver)

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME_PATTERN

private static final java.util.regex.Pattern FIELD_NAME_PATTERN

Constructor Detail

Fields

private Fields()

Method Detail

version

public static MimeVersionField version(java.lang.String ver)

contentType

public static ContentTypeField contentType(java.lang.String contentType)

Creates a Content-Type field from the specified raw field value. The specified string gets folded into a multiple-line representation if necessary but is otherwise taken as is.

Parameters:

contentType - raw content type containing a MIME type and optional parameters.

Returns:

the newly created Content-Type field.

contentType

public static ContentTypeField contentType(java.lang.String mimeType,
                                           java.util.Map<java.lang.String,java.lang.String> parameters)

Creates a Content-Type field from the specified MIME type and parameters.

Parameters:

mimeType - a MIME type (such as "text/plain" or "application/octet-stream").

parameters - map containing content-type parameters such as "boundary".

Returns:

the newly created Content-Type field.

contentType

public static ContentTypeField contentType(java.lang.String mimeType,
                                           java.lang.Iterable<NameValuePair> parameters)

Creates a Content-Type field from the specified MIME type and parameters.

Parameters:

mimeType - a MIME type (such as "text/plain" or "application/octet-stream").

parameters - list of content-type parameter name/value pairs.

Returns:

the newly created Content-Type field.

contentType

public static ContentTypeField contentType(java.lang.String mimeType,
                                           NameValuePair... parameters)

Creates a Content-Type field from the specified MIME type and parameters.

Parameters:

mimeType - a MIME type (such as "text/plain" or "application/octet-stream").

parameters - array of content-type parameter name/value pairs.

Returns:

the newly created Content-Type field.

contentTransferEncoding

public static ContentTransferEncodingField contentTransferEncoding(java.lang.String contentTransferEncoding)

Creates a Content-Transfer-Encoding field from the specified raw field value.

Parameters:

contentTransferEncoding - an encoding mechanism such as "7-bit" or "quoted-printable".

Returns:

the newly created Content-Transfer-Encoding field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String contentDisposition)

Creates a Content-Disposition field from the specified raw field value. The specified string gets folded into a multiple-line representation if necessary but is otherwise taken as is.

Parameters:

contentDisposition - raw content disposition containing a disposition type and optional parameters.

Returns:

the newly created Content-Disposition field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String dispositionType,
                                                         java.util.Map<java.lang.String,java.lang.String> parameters)

Creates a Content-Disposition field from the specified disposition type and parameters.

Parameters:

dispositionType - a disposition type (usually "inline" or "attachment").

parameters - map containing disposition parameters such as "filename".

Returns:

the newly created Content-Disposition field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String dispositionType,
                                                         java.lang.Iterable<NameValuePair> parameters)

Creates a Content-Disposition field from the specified disposition type and parameters.

Parameters:

dispositionType - a disposition type (usually "inline" or "attachment").

parameters - list of disposition parameter name/value pairs.

Returns:

the newly created Content-Disposition field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String dispositionType,
                                                         java.lang.String filename)

Creates a Content-Disposition field from the specified disposition type and filename.

Parameters:

dispositionType - a disposition type (usually "inline" or "attachment").

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

Returns:

the newly created Content-Disposition field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String dispositionType,
                                                         java.lang.String filename,
                                                         long size)

Creates a Content-Disposition field from the specified values.

Parameters:

dispositionType - a disposition type (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.

Returns:

the newly created Content-Disposition field.

contentDisposition

public static ContentDispositionField contentDisposition(java.lang.String dispositionType,
                                                         java.lang.String filename,
                                                         long size,
                                                         java.util.Date creationDate,
                                                         java.util.Date modificationDate,
                                                         java.util.Date readDate)

Creates a Content-Disposition field from the specified values.

Parameters:

dispositionType - a disposition type (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.

Returns:

the newly created Content-Disposition field.

date

public static DateTimeField date(java.util.Date date)

Creates a Date field from the specified Date value. The default time zone of the host is used to format the date.

Parameters:

date - date value for the header field.

Returns:

the newly created Date field.

date

public static DateTimeField date(java.lang.String fieldName,
                                 java.util.Date date)

Creates a date field from the specified field name and Date value. The default time zone of the host is used to format the date.

Parameters:

fieldName - a field name such as Date or Resent-Date.

date - date value for the header field.

Returns:

the newly created date field.

date

public static DateTimeField date(java.lang.String fieldName,
                                 java.util.Date date,
                                 java.util.TimeZone zone)

Creates a date field from the specified field name, Date and TimeZone values.

Parameters:

fieldName - a field name such as Date or Resent-Date.

date - date value for the header field.

zone - the time zone to be used for formatting the date.

Returns:

the newly created date field.

generateMessageId

public static UnstructuredField generateMessageId(java.lang.String hostname)

Creates a Message-ID field for the specified host name.

Parameters:

hostname - host name to be included in the message ID or null if no host name should be included.

Returns:

the newly created Message-ID field.

messageId

public static UnstructuredField messageId(java.lang.String messageId)

Creates a Message-ID field with the given message ID.

Parameters:

message - ID message ID value.

subject

public static UnstructuredField subject(java.lang.String subject)

Creates a Subject field from the specified string value. The specified string may contain non-ASCII characters.

Parameters:

subject - the subject string.

Returns:

the newly created Subject field.

sender

public static MailboxField sender(Mailbox mailbox)

Creates a Sender field for the specified mailbox address.

Parameters:

mailbox - address to be included in the field.

Returns:

the newly created Sender field.

from

public static MailboxListField from(Mailbox mailbox)

Creates a From field for the specified mailbox address.

Parameters:

mailbox - address to be included in the field.

Returns:

the newly created From field.

from

public static MailboxListField from(Mailbox... mailboxes)

Creates a From field for the specified mailbox addresses.

Parameters:

mailboxes - addresses to be included in the field.

Returns:

the newly created From field.

from

public static MailboxListField from(java.lang.Iterable<Mailbox> mailboxes)

Creates a From field for the specified mailbox addresses.

Parameters:

mailboxes - addresses to be included in the field.

Returns:

the newly created From field.

to

public static AddressListField to(Address address)

Creates a To field for the specified mailbox or group address.

Parameters:

address - mailbox or group address to be included in the field.

Returns:

the newly created To field.

to

public static AddressListField to(Address... addresses)

Creates a To field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created To field.

to

public static AddressListField to(java.lang.Iterable<Address> addresses)

Creates a To field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created To field.

cc

public static AddressListField cc(Address address)

Creates a Cc field for the specified mailbox or group address.

Parameters:

address - mailbox or group address to be included in the field.

Returns:

the newly created Cc field.

cc

public static AddressListField cc(Address... addresses)

Creates a Cc field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Cc field.

cc

public static AddressListField cc(java.lang.Iterable<Address> addresses)

Creates a Cc field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Cc field.

bcc

public static AddressListField bcc(Address address)

Creates a Bcc field for the specified mailbox or group address.

Parameters:

address - mailbox or group address to be included in the field.

Returns:

the newly created Bcc field.

bcc

public static AddressListField bcc(Address... addresses)

Creates a Bcc field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Bcc field.

bcc

public static AddressListField bcc(java.lang.Iterable<Address> addresses)

Creates a Bcc field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Bcc field.

replyTo

public static AddressListField replyTo(Address address)

Creates a Reply-To field for the specified mailbox or group address.

Parameters:

address - mailbox or group address to be included in the field.

Returns:

the newly created Reply-To field.

replyTo

public static AddressListField replyTo(Address... addresses)

Creates a Reply-To field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Reply-To field.

replyTo

public static AddressListField replyTo(java.lang.Iterable<Address> addresses)

Creates a Reply-To field for the specified mailbox or group addresses.

Parameters:

addresses - mailbox or group addresses to be included in the field.

Returns:

the newly created Reply-To field.

mailbox

public static MailboxField mailbox(java.lang.String fieldName,
                                   Mailbox mailbox)

Creates a mailbox field from the specified field name and mailbox address. Valid field names are Sender and Resent-Sender.

Parameters:

fieldName - the name of the mailbox field (Sender or Resent-Sender).

mailbox - mailbox address for the field value.

Returns:

the newly created mailbox field.

mailboxList

public static MailboxListField mailboxList(java.lang.String fieldName,
                                           java.lang.Iterable<Mailbox> mailboxes)

Creates a mailbox-list field from the specified field name and mailbox addresses. Valid field names are From and Resent-From.

Parameters:

fieldName - the name of the mailbox field (From or Resent-From).

mailboxes - mailbox addresses for the field value.

Returns:

the newly created mailbox-list field.

addressList

public static AddressListField addressList(java.lang.String fieldName,
                                           java.lang.Iterable<? extends Address> addresses)

Creates an address-list field from the specified field name and mailbox or group addresses. Valid field names are To, Cc, Bcc, Reply-To, Resent-To, Resent-Cc and Resent-Bcc.

Parameters:

fieldName - the name of the mailbox field (To, Cc, Bcc, Reply-To, Resent-To, Resent-Cc or Resent-Bcc).

addresses - mailbox or group addresses for the field value.

Returns:

the newly created address-list field.

date0

private static DateTimeField date0(java.lang.String fieldName,
                                   java.util.Date date,
                                   java.util.TimeZone zone)

mailbox0

private static MailboxField mailbox0(java.lang.String fieldName,
                                     Mailbox mailbox)

mailboxList0

private static MailboxListField mailboxList0(java.lang.String fieldName,
                                             java.lang.Iterable<Mailbox> mailboxes)

addressList0

private static AddressListField addressList0(java.lang.String fieldName,
                                             java.lang.Iterable<? extends Address> addresses)

checkValidFieldName

private static void checkValidFieldName(java.lang.String fieldName)

isValidMimeType

private static boolean isValidMimeType(java.lang.String mimeType)

isValidDispositionType

private static boolean isValidDispositionType(java.lang.String dispositionType)

parse

private static <F extends ParsedField> F parse(FieldParser<F> parser,
                                               java.lang.String fieldName,
                                               java.lang.String fieldBody)

encodeAddresses

private static java.lang.String encodeAddresses(java.lang.Iterable<? extends Address> addresses)