Interface Field

All Known Subinterfaces:
AddressListField, ContentDescriptionField, ContentDispositionField, ContentIdField, ContentLanguageField, ContentLengthField, ContentLocationField, ContentMD5Field, ContentTransferEncodingField, ContentTypeField, DateTimeField, MailboxField, MailboxListField, MimeVersionField, ParsedField, UnstructuredField
All Known Implementing Classes:
AbstractField, AddressListFieldImpl, AddressListFieldLenientImpl, ContentDescriptionFieldImpl, ContentDispositionFieldImpl, ContentDispositionFieldLenientImpl, ContentIdFieldImpl, ContentLanguageFieldImpl, ContentLanguageFieldLenientImpl, ContentLengthFieldImpl, ContentLocationFieldImpl, ContentLocationFieldLenientImpl, ContentMD5FieldImpl, ContentTransferEncodingFieldImpl, ContentTypeFieldImpl, ContentTypeFieldLenientImpl, DateTimeFieldImpl, DateTimeFieldLenientImpl, MailboxFieldImpl, MailboxFieldLenientImpl, MailboxListFieldImpl, MailboxListFieldLenientImpl, MimeVersionFieldImpl, MimeVersionFieldLenientImpl, RawField, UnstructuredFieldImpl

public interface Field

This interface represents an abstract MIME field. A MIME field must have a non null name and a content body (unfolded but unparsed and possibly encoded). Optionally implementing classes may also retain the original (raw) representation in a form of ByteSequence.

Specific implementations of this interface may also use a richer model to represent the field if its body can be parsed into a set of constituent elements.

  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the unparsed and possibly encoded (see RFC 2047) field body string.
    Returns the name of the field.
    default String
    Returns the name of the field in lower case.
    Gets original (raw) representation of the field, if available, null otherwise.
  • Method Details

    • getName

      String getName()
      Returns the name of the field.
    • getNameLowerCase

      default String getNameLowerCase()
      Returns the name of the field in lower case.
    • getBody

      String getBody()
      Gets the unparsed and possibly encoded (see RFC 2047) field body string.
      Returns:
      the unparsed field body string.
    • getRaw

      ByteSequence getRaw()
      Gets original (raw) representation of the field, if available, null otherwise.