Apache James Mime4j

https://james.apache.org/mime4j/
Admin
Apache James Mime4j is a parser for e-mail message streams in RFC822 and MIME format that provides a...
Tokens:313,296
Snippets:2,616
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Parse a MIME stream

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/MimeStreamParser.html

Example showing the typical setup and execution flow for parsing a MIME message from an InputStream.

```java
      ContentHandler handler = new MyHandler();
      MimeConfig config = new MimeConfig();
      MimeStreamParser parser = new MimeStreamParser(config);
      parser.setContentHandler(handler);
      InputStream instream = new FileInputStream("mime.msg");
      try {
          parser.parse(instream);
      } finally {
          instream.close();
      }
```

--------------------------------

### Initialize ThresholdStorageProvider

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/ThresholdStorageProvider.html

Example of configuring a ThresholdStorageProvider with a backend and a specific memory threshold.

```java
 StorageProvider tempStore = new TempFileStorageProvider();
 StorageProvider provider = new ThresholdStorageProvider(tempStore, 4096);
 DefaultStorageProvider.setInstance(provider);
```

--------------------------------

### Example Message Creation

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Demonstrates creating a simple plain text message.

```APIDOC
## TextPlainMessage

### Description
This example generates a message very similar to the one from RFC 5322 Appendix A.1.1.

### Constructors
- `TextPlainMessage()`: Default constructor.
```

--------------------------------

### Example Usage of TempFileStorageProvider

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/TempFileStorageProvider.html

Demonstrates how to set up a TempFileStorageProvider with a custom directory and use it as the default storage provider.

```java
File directory = new File("/tmp/mime4j");
StorageProvider provider = new TempFileStorageProvider(directory);
DefaultStorageProvider.setInstance(provider);
```

--------------------------------

### CipherStorageProvider Usage Example

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/CipherStorageProvider.html

Demonstrates how to wrap a storage provider with encryption and set it as the default provider.

```java
 StorageProvider mistrusted = new TempFileStorageProvider();
 StorageProvider enciphered = new CipherStorageProvider(mistrusted);
 StorageProvider provider = new ThresholdStorageProvider(enciphered);
 DefaultStorageProvider.setInstance(provider);
```

--------------------------------

### Base64OutputStreamBench Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/Base64OutputStreamBench.html

Initializes a new instance of the Base64OutputStreamBench class. No specific setup is required.

```java
public
Base64OutputStreamBench()
```

--------------------------------

### DefaultStorageProvider - getInstance()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the singleton instance of the default StorageProvider.

```APIDOC
## DefaultStorageProvider - getInstance()

### Description
Returns the default `StorageProvider` instance.

### Method
`getInstance()`

### Class
`org.apache.james.mime4j.storage.DefaultStorageProvider`
```

--------------------------------

### QuotedPrintableOutputStreamBench Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/QuotedPrintableOutputStreamBench.html

Initializes a new instance of the QuotedPrintableOutputStreamBench class. No specific setup or constraints are mentioned.

```java
public QuotedPrintableOutputStreamBench()

```

--------------------------------

### QuotedPrintableInputStreamBench Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/QuotedPrintableInputStreamBench.html

Initializes a new instance of the QuotedPrintableInputStreamBench class. No specific setup or constraints are mentioned.

```java
public QuotedPrintableInputStreamBench()
```

--------------------------------

### values() Method Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/codec/EncoderUtil.Usage.html

Detailed information and usage example for the values() method.

```APIDOC
## Method Detail

### values

```java
public static EncoderUtil.Usage[] values()
```

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```java
for (EncoderUtil.Usage c : EncoderUtil.Usage.values())
    System.out.println(c);
```

Returns:
    an array containing the constants of this enum type, in the order they are declared
```

--------------------------------

### LineNumberSource - getLineNumber()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the current line number, starting from 1.

```APIDOC
## LineNumberSource - getLineNumber()

### Description
Gets the current line number starting at 1 (the number of `\r\n` read so far plus 1).

### Method
`getLineNumber()`

### Interface
`org.apache.james.mime4j.io.LineNumberSource`
```

--------------------------------

### getDescription Method Implementation Example

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/field/ContentDescriptionField.html

Illustrates how to get the content description. Returns the description or null if not set. This method is part of the ContentDescriptionField interface.

```java
String getDescription()

Gets the content description defined in this field.

Returns:
    the content description or null if not set.
```

--------------------------------

### Base64OutputStreamBench Main Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/Base64OutputStreamBench.html

The entry point for the Base64OutputStreamBench benchmark. It may throw exceptions during execution.

```java
public static void main(String[] args)
                 throws Exception
```

--------------------------------

### Get Line Number Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/io/LineNumberSource.html

Retrieves the current line number. The count starts at 1, representing the number of \r\n sequences encountered so far plus one.

```java
int getLineNumber()
```

--------------------------------

### Method Detail: startMessage

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/ContentHandler.html

Called when a new message starts, either a top-level message or an embedded RFC822 message.

```APIDOC
## Method Detail: startMessage

### startMessage
```java
void startMessage()
                  throws MimeException
```

Called when a new message starts (a top level message or an embedded rfc822 message).

Throws:
    `MimeException` - on processing errors
```

--------------------------------

### Main Entry Point

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/samples/tree/MessageTree.html

Standard main method for the class.

```java
public static void main(String[] args)
```

--------------------------------

### ReInit Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/SimpleCharStream.html

Initializes the parser with a new input stream, starting line, and starting column.

```APIDOC
## ReInit

### Description
Initializes the parser with a new input stream, starting line, and starting column.

### Method
`public void ReInit(java.io.InputStream dstream, int startline, int startcolumn)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### QuotedPrintableOutputStreamBench Main Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/QuotedPrintableOutputStreamBench.html

The entry point for the QuotedPrintableOutputStreamBench. This method may throw an Exception, indicating potential issues during execution.

```java
public static void main(String[] args)
                 throws Exception

```

--------------------------------

### Get all EntityState constants

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/stream/EntityState.html

Use the values() method to get an array of all declared constants in the EntityState enum. This is useful for iterating over all possible states.

```java
public static EntityState[] values()
```

```java
for (EntityState c : EntityState.values())
    System.out.println(c);
```

--------------------------------

### JJTAddressListParserState Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/JJTAddressListParserState.html

Initializes a new instance of the JJTAddressListParserState class. No specific setup is required beyond instantiation.

```java
public
JJTAddressListParserState()
```

--------------------------------

### Base64InputStreamBench Main Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/Base64InputStreamBench.html

The main entry point for the benchmark class, which throws an Exception.

```java
public static void main(String[] args)
                 throws Exception
```

--------------------------------

### AbstractEntity - getHeader()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the header of an entity.

```APIDOC
## AbstractEntity - getHeader()

### Description
Gets the entity header.

### Method
`getHeader()`

### Class
`org.apache.james.mime4j.message.AbstractEntity`
```

--------------------------------

### Entity - getHeader()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the header of an entity.

```APIDOC
## Entity - getHeader()

### Description
Gets the entity header.

### Method
`getHeader()`

### Interface
`org.apache.james.mime4j.dom.Entity`
```

--------------------------------

### main method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/QuotedPrintableOutputStreamBench.html

The main entry point for the QuotedPrintableOutputStreamBench class.

```APIDOC
## main

### Description
Executes the benchmark for the QuotedPrintableOutputStream.

### Method
static void

### Parameters
#### Path Parameters
- **args** (String[]) - Required - Command line arguments for the benchmark.

### Response
#### Success Response
- **void** - Returns nothing.

### Errors
- **Exception** - Thrown if an error occurs during execution.
```

--------------------------------

### Get Epilogue

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the epilogue of the multipart message.

```APIDOC
## GET /websites/james_apache_mime4j/multipart/epilogue

### Description
Gets the epilogue or null if the message has no epilogue.

### Method
GET

### Endpoint
/websites/james_apache_mime4j/multipart/epilogue

### Response
#### Success Response (200)
- **epilogue** (string) - The epilogue of the multipart message, or null if none exists.
```

--------------------------------

### Get Preamble

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the preamble of the multipart message.

```APIDOC
## GET /websites/james_apache_mime4j/multipart/preamble

### Description
Gets the preamble or null if the message has no preamble.

### Method
GET

### Endpoint
/websites/james_apache_mime4j/multipart/preamble

### Response
#### Success Response (200)
- **preamble** (string) - The preamble of the multipart message, or null if none exists.
```

--------------------------------

### ThresholdStorageProvider Constructors

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/ThresholdStorageProvider.html

Details on how to instantiate the ThresholdStorageProvider.

```APIDOC
## ThresholdStorageProvider Constructors

### Constructor Summary

Constructors | Description
---|---
`ThresholdStorageProvider(StorageProvider backend)` | Creates a new `ThresholdStorageProvider` for the given back-end using a threshold size of 2048 bytes.
`ThresholdStorageProvider(StorageProvider backend, int thresholdSize)` | Creates a new `ThresholdStorageProvider` for the given back-end and threshold size.

### Constructor Detail

#### ThresholdStorageProvider

```java
public ThresholdStorageProvider(StorageProvider backend)
```

Creates a new `ThresholdStorageProvider` for the given back-end using a threshold size of 2048 bytes.

#### ThresholdStorageProvider

```java
public ThresholdStorageProvider(StorageProvider backend,
                        int thresholdSize)
```

Creates a new `ThresholdStorageProvider` for the given back-end and threshold size.

Parameters:
* `backend` - used to store the remainder of the data if the threshold size gets exceeded.
* `thresholdSize` - determines how much bytes are kept in memory before that back-end storage provider is used to store the remainder of the data.
```

--------------------------------

### Get Parent

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the parent entity of this body.

```APIDOC
## GET /api/mime4j/body/parent

### Description
Gets the parent of this body.

### Method
GET

### Endpoint
`/api/mime4j/body/parent`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **parent** (Entity) - The parent entity.

#### Response Example
```json
{
  "parent": { /* Entity object */ }
}
```
```

--------------------------------

### MemoryStorageProvider Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/MemoryStorageProvider.html

Creates a new instance of MemoryStorageProvider. No specific setup is required before instantiation.

```java
public MemoryStorageProvider()
```

--------------------------------

### GET getMailbox

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/MailboxFieldLenientImpl.html

Retrieves the mailbox information from the field.

```APIDOC
## GET getMailbox

### Description
Retrieves the Mailbox object associated with the current field.

### Method
GET

### Response
#### Success Response (200)
- **Mailbox** (Object) - The mailbox information extracted from the field.
```

--------------------------------

### Constructor Detail: Token(int kind, String image)

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/Token.html

Details of the Token constructor that takes an integer kind and a string image.

```APIDOC
#### Token

```java
public Token(int kind,
     String image)
```

Constructs a new token for the specified Image and Kind.
```

--------------------------------

### Get Entity Body

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Retrieves the body of the entity.

```java
Body getBody()
```

--------------------------------

### Token Constructor Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/Token.html

Provides detailed explanations for each constructor in the Token class.

```APIDOC
## Token Constructor Detail

### `Token`
```java
public Token()
```
No-argument constructor

### `Token`
```java
public Token(int kind)
```
Constructs a new token for the specified Image.

### `Token`
```java
public Token(int kind,
     String image)
```
Constructs a new token for the specified Image and Kind.
```

--------------------------------

### Get Epilogue

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the epilogue of the multipart message, if it exists.

```APIDOC
## GET /api/mime4j/multipart/epilogue

### Description
Gets the epilogue or null if the message has no epilogue.

### Method
GET

### Endpoint
`/api/mime4j/multipart/epilogue`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **epilogue** (String) - The epilogue text or null.

#### Response Example
```json
{
  "epilogue": "This is the epilogue."
}
```
```

--------------------------------

### Token Constructor Details

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/Token.html

Provides detailed explanations for each constructor within the Token class.

```APIDOC
### Constructor Detail

#### Token
```java
public Token()
```
No-argument constructor

#### Token
```java
public Token(int kind)
```
Constructs a new token for the specified Image.

#### Token
```java
public Token(int kind,
     String image)
```
Constructs a new token for the specified Image and Kind.
```

--------------------------------

### Get Preamble

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the preamble of the multipart message, if it exists.

```APIDOC
## GET /api/mime4j/multipart/preamble

### Description
Gets the preamble or null if the message has no preamble.

### Method
GET

### Endpoint
`/api/mime4j/multipart/preamble`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **preamble** (String) - The preamble text or null.

#### Response Example
```json
{
  "preamble": "This is the preamble."
}
```
```

--------------------------------

### Header Management

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/Entity.html

Methods for getting and setting the Header of the Entity.

```APIDOC
## Header Management

### getHeader

#### Description
Gets the entity header.

#### Returns
- Header - the header.

### setHeader

#### Description
Sets the entity header.

#### Parameters
- **header** (Header) - the header.
```

--------------------------------

### Token Constructor Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/structured/parser/Token.html

Provides detailed explanations for each constructor of the Token class.

```APIDOC
## Constructor Detail

### Token
```java
public Token()
```
No-argument constructor

### Token
```java
public Token(int kind)
```
Constructs a new token for the specified Image.

### Token
```java
public Token(int kind,
     String image)
```
Constructs a new token for the specified Image and Kind.
```

--------------------------------

### Get SubType

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Retrieves the multipart sub-type, such as 'alternative' or 'parallel'.

```APIDOC
## GET /api/mime4j/multipart/subtype

### Description
Gets the multipart sub-type. E.g. `alternative` (the default) or `parallel`. See RFC 2045 for common sub-types and their meaning.

### Method
GET

### Endpoint
`/api/mime4j/multipart/subtype`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **subType** (String) - The multipart sub-type.

#### Response Example
```json
{
  "subType": "alternative"
}
```
```

--------------------------------

### Constructor Detail: Event

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/Event.html

Detailed signature and explanation for the Event constructor.

```APIDOC
### Constructor Detail

#### Event
```java
public **Event**(java.lang.String code)

```

--------------------------------

### LineNumberInputStream - getLineNumber()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the current line number being processed.

```APIDOC
## LineNumberInputStream - getLineNumber()

### Description
Gets the current line number.

### Method
`getLineNumber()`

### Class
`org.apache.james.mime4j.io.LineNumberInputStream`
```

--------------------------------

### SimpleContentHandler Method Details

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/SimpleContentHandler.html

Detailed explanations for each method in the SimpleContentHandler class.

```APIDOC
## Method Details

### `headers(Header header)`
```java
public abstract void headers(Header header)
```
Called after headers are parsed.

### `startHeader()`
```java
public final void startHeader()
```
Called when a header (of a message or body part) is about to be parsed.

**Specified by:**
`startHeader` in interface `ContentHandler`

**Overrides:**
`startHeader` in class `AbstractContentHandler`

### `field(Field field)`
```java
public final void field(Field field) throws MimeException
```
Called for each field of a header.

**Specified by:**
`field` in interface `ContentHandler`

**Overrides:**
`field` in class `AbstractContentHandler`

**Parameters:**
* `field` - the MIME field.

**Throws:**
* `MimeException` - on processing errors

### `endHeader()`
```java
public final void endHeader()
```
Called when there are no more header fields in a message or body part.

**Specified by:**
`endHeader` in interface `ContentHandler`

**Overrides:**
`endHeader` in class `AbstractContentHandler`
```

--------------------------------

### GET /org.apache.james.mime4j.field/getParseException

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/class-use/ParseException.html

Retrieves the exception thrown during field parsing.

```APIDOC
## GET /org.apache.james.mime4j.field/getParseException

### Description
Returns the exception that was thrown by the field parser while parsing the field value.

### Method
GET

### Response
#### Success Response (200)
- **ParseException** (object) - The exception raised during parsing, or null if no error occurred.
```

--------------------------------

### DomainList Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/DomainList.html

Initializes a new instance of the DomainList class.

```APIDOC
### Constructor: DomainList

```java
public DomainList(List<String> domains, boolean dontCopy)
```

**Parameters:**
- **domains** (List<String>) - A List that contains only String objects.
- **dontCopy** (boolean) - true iff it is not possible for the domains list to be modified by someone else.
```

--------------------------------

### TempFileStorageProvider Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/TempFileStorageProvider.html

Initializes a new instance of the TempFileStorageProvider with optional directory, prefix, and suffix configurations.

```APIDOC
## Constructor: TempFileStorageProvider(String prefix, String suffix, File directory)

### Description
Creates a new TempFileStorageProvider using the given values for file naming and storage location.

### Parameters
- **prefix** (String) - Required - Prefix for generating the temporary file's name; must be at least three characters long.
- **suffix** (String) - Optional - Suffix for generating the temporary file's name; may be null to use the default ".tmp".
- **directory** (File) - Optional - The directory in which the file is to be created, or null to use the system default temporary-file directory.

### Throws
- **IllegalArgumentException** - If the prefix is less than three characters long or the directory does not exist and cannot be created.
```

--------------------------------

### GET getMailboxList

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/MailboxListFieldLenientImpl.html

Retrieves the parsed mailbox list from the field.

```APIDOC
## GET getMailboxList

### Description
Retrieves the MailboxList object associated with the current mailbox-list field.

### Method
GET

### Response
#### Success Response (200)
- **MailboxList** (object) - The parsed list of mailboxes contained in the field.
```

--------------------------------

### Token Method Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/Token.html

Provides detailed explanations for each method in the Token class.

```APIDOC
## Token Method Detail

### `getValue`
```java
public Object getValue()
```
An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.

### `toString`
```java
public String toString()
```
Returns the image.

**Overrides:**
    `toString` in class `Object`

### `newToken`
```java
public static Token newToken(int ofKind)
```

### `newToken`
```java
public static Token newToken(int ofKind,
         String image)
```
Returns a new Token object, by default.
```

--------------------------------

### GET getMailbox

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/field/MailboxField.html

Retrieves the Mailbox object associated with the field.

```APIDOC
## GET getMailbox

### Description
Retrieves the parsed Mailbox object from the field.

### Method
GET

### Response
#### Success Response (200)
- **Mailbox** (object) - The mailbox address object associated with this field.
```

--------------------------------

### TempFileStorageProvider Constructor with Prefix, Suffix, and Directory

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/TempFileStorageProvider.html

Creates a new TempFileStorageProvider with custom prefix, suffix, and directory settings for temporary files. The prefix must be at least three characters long, and the suffix can be null to default to ".tmp". The directory can be null to use the system's default temporary directory.

```java
public TempFileStorageProvider(String prefix,
                       String suffix,
                       File directory)
```

--------------------------------

### GET getEncoding

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/field/ContentTransferEncodingField.html

Retrieves the encoding defined in the Content-Transfer-Encoding field.

```APIDOC
## GET getEncoding

### Description
Retrieves the encoding defined in the Content-Transfer-Encoding field.

### Method
GET

### Response
- **String** - The encoding defined in this field, or null if not set.
```

--------------------------------

### MultipartImpl Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/MultipartImpl.html

Details of the constructor for creating a new MultipartImpl instance.

```APIDOC
## Constructor: MultipartImpl

### Signature
```java
public MultipartImpl(String subType)
```

### Description
Creates a new empty `Multipart` instance.

### Parameters
* **subType** (String) - The subtype of the multipart content.
```

--------------------------------

### GET getLanguages

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/field/ContentLanguageField.html

Retrieves the content language(s) defined in the ContentLanguageField.

```APIDOC
## GET getLanguages

### Description
Retrieves the content language(s) defined in this field.

### Method
GET

### Response
#### Success Response (200)
- **List<String>** - A list of content language(s).
```

--------------------------------

### ASTdomain Class Reference

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/ASTdomain.html

Documentation for the ASTdomain class, including constructors and the jjtAccept visitor method.

```APIDOC
## Class: org.apache.james.mime4j.field.address.parser.ASTdomain

### Description
ASTdomain is a node class representing a domain in an email address, extending SimpleNode and implementing the Node interface.

### Constructors
- **ASTdomain(int id)** - Constructs an ASTdomain with a specific ID.
- **ASTdomain(AddressListParser p, int id)** - Constructs an ASTdomain with a parser instance and an ID.

### Methods
- **jjtAccept(AddressListParserVisitor visitor, Object data)**
  - Description: Accepts a visitor to perform operations on the node.
  - Parameters:
    - **visitor** (AddressListParserVisitor) - The visitor implementation.
    - **data** (Object) - Contextual data for the visitor.
```

--------------------------------

### GET ContentIdField.getId()

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/field/ContentIdField.html

Retrieves the content ID defined in the field.

```APIDOC
## GET ContentIdField.getId()

### Description
Retrieves the content ID defined in this field.

### Method
GET

### Response
- **String** - The content ID or null if not set.
```

--------------------------------

### Get Filename

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Returns the filename parameter from the content disposition.

```java
String getFilename()
```

--------------------------------

### Get Entity Header

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Retrieves the header associated with the entity.

```java
Header getHeader()
```

--------------------------------

### Storage Provider Implementations

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/package-summary.html

Concrete implementations of the `StorageProvider` interface.

```APIDOC
## AbstractStorageProvider Class

### Description
Abstract implementation of `StorageProvider` that implements `store(InputStream)` by copying the input stream to a `StorageOutputStream` obtained from `createStorageOutputStream()`.

### Class
`AbstractStorageProvider`

## CipherStorageProvider Class

### Description
A `StorageProvider` that transparently scrambles and unscrambles the data stored by another `StorageProvider`.

### Class
`CipherStorageProvider`

## DefaultStorageProvider Class

### Description
Allows for a default `StorageProvider` instance to be configured on an application level.

### Class
`DefaultStorageProvider`

## MemoryStorageProvider Class

### Description
A `StorageProvider` that stores the data entirely in memory.

### Class
`MemoryStorageProvider`

## TempFileStorageProvider Class

### Description
A `StorageProvider` that stores the data in temporary files.

### Class
`TempFileStorageProvider`

## ThresholdStorageProvider Class

### Description
A `StorageProvider` that keeps small amounts of data in memory and writes the remainder to another `StorageProvider` (the back-end) if a certain threshold size gets exceeded.

### Class
`ThresholdStorageProvider`
```

--------------------------------

### getLineNumber Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/io/LineNumberInputStream.html

Retrieves the current line number, starting at 1.

```java
public int getLineNumber()
```

--------------------------------

### Token Method Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/structured/parser/Token.html

Provides detailed explanations for each method of the Token class.

```APIDOC
## Method Detail

### getValue
```java
public Object getValue()
```
An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.

### toString
```java
public String toString()
```
Returns the image. 

**Overrides:**
    `toString` in class `Object`

### newToken
```java
public static Token newToken(int ofKind)
```

### newToken
```java
public static Token newToken(int ofKind,
         String image)
```
Returns a new Token object, by default.
```

--------------------------------

### getInstance Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/DefaultStorageProvider.html

Retrieves the currently configured default StorageProvider instance.

```java
public static StorageProvider getInstance()
```

--------------------------------

### adjustBeginLineColumn Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/SimpleCharStream.html

Updates the line and column tracking for the start of a token.

```java
public void adjustBeginLineColumn(int newLine,
                         int newCol)
```

--------------------------------

### adjustBeginLineColumn Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contenttype/parser/SimpleCharStream.html

Updates the line and column tracking for the start of a token.

```java
public void adjustBeginLineColumn(int newLine,
                         int newCol)
```

--------------------------------

### CipherStorageProvider Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/CipherStorageProvider.html

Initializes a new CipherStorageProvider with a specified backend storage provider and optional cipher algorithm.

```APIDOC
## Constructor CipherStorageProvider

### Description
Creates a new CipherStorageProvider that wraps a backend storage strategy to provide encryption.

### Parameters
- **backend** (StorageProvider) - Required - The underlying storage strategy to encrypt.
- **algorithm** (String) - Optional - The name of the symmetric block cipher algorithm (e.g., "Blowfish", "AES", "RC2"). Defaults to "Blowfish" if not provided.
```

--------------------------------

### adjustBeginLineColumn Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/SimpleCharStream.html

Adjusts line and column numbers for the start of a token.

```APIDOC
## adjustBeginLineColumn

### Description
Method to adjust line and column numbers for the start of a token.

### Method
`public void adjustBeginLineColumn(int newLine, int newCol)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Token Method Details

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/Token.html

Provides detailed explanations for each method within the Token class.

```APIDOC
### Method Detail

#### getValue
```java
public Object getValue()
```
An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.

#### toString
```java
public String toString()
```
Returns the image. 

**Overrides:**
    `toString` in class `Object`

#### newToken
```java
public static Token newToken(int ofKind,

```

--------------------------------

### adjustBeginLineColumn

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/SimpleCharStream.html

Adjusts the line and column tracking for token start positions.

```APIDOC
## adjustBeginLineColumn

### Description
Method to adjust line and column numbers for the start of a token.

### Method
public void adjustBeginLineColumn(int newLine, int newCol)

### Parameters
#### Parameters
- **newLine** (int) - Required - The new line number.
- **newCol** (int) - Required - The new column number.
```

--------------------------------

### Constructor Detail: Token()

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/Token.html

Details of the no-argument constructor for the Token class.

```APIDOC
### Constructor Detail

#### Token

```java
public Token()
```

No-argument constructor
```

--------------------------------

### Get Header Field

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/stream/EntityStateMachine.html

Retrieves the current header field being processed.

```java
Field getField()
               throws IllegalStateException
```

--------------------------------

### TextPlainMessage Main Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/samples/dom/TextPlainMessage.html

The entry point for the TextPlainMessage sample, which may throw IOException or ParseException.

```java
public static void main(String[] args)
                 throws IOException,
                        ParseException
```

--------------------------------

### Display Message Tree

Source: https://james.apache.org/mime4j/samples.html

Use this sample to visualize the structure of a MIME message in a Swing GUI. Requires a path to a message file.

```Java
java org.apache.james.mime4j.samples.tree.MessageTree path/to/message.msg
```

--------------------------------

### Get Entity State

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/stream/EntityStateMachine.html

Retrieves the current state of the MIME entity.

```java
EntityState getState()
```

--------------------------------

### Get Count

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/AbstractMultipart.html

Returns the number of body parts in the multipart message.

```APIDOC
## GET /api/mime4j/multipart/count

### Description
Returns the number of body parts.

### Method
GET

### Endpoint
`/api/mime4j/multipart/count`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **count** (int) - The number of body parts.

#### Response Example
```json
{
  "count": 3
}
```
```

--------------------------------

### SimpleCharStream Constructor Summary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/SimpleCharStream.html

Lists and describes the constructors available for creating SimpleCharStream objects.

```APIDOC
## Constructors

### Constructor Summary

Constructors Constructor and Description
---
`**SimpleCharStream**(InputStream dstream)` Constructor.
`**SimpleCharStream**(InputStream dstream, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(InputStream dstream, int startline, int startcolumn, int buffersize)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding, int startline, int startcolumn, int buffersize)` Constructor.
`**SimpleCharStream**(Reader dstream)` Constructor.
`**SimpleCharStream**(Reader dstream, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(Reader dstream, int startline, int startcolumn, int buffersize)` Constructor.
```

--------------------------------

### Body Management

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/Entity.html

Methods for getting, setting, and removing the Body of the Entity.

```APIDOC
## Body Management

### getBody

#### Description
Gets the body of this entity.

#### Returns
- Body - the body.

### setBody

#### Description
Sets the body of this entity.

#### Parameters
- **body** (Body) - the body.

#### Throws
- `java.lang.IllegalStateException` - if the body has already been set.

### removeBody

#### Description
Removes and returns the body of this entity. The removed body may be attached to another entity. If it is no longer needed it should be `disposed` of.

#### Returns
- Body - the removed body or `null` if no body was set.
```

--------------------------------

### Constructor Detail: Token(int kind)

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/Token.html

Details of the Token constructor that takes an integer kind.

```APIDOC
#### Token

```java
public Token(int kind)
```

Constructs a new token for the specified Image.
```

--------------------------------

### ParserCursor - getLowerBound()

Source: https://james.apache.org/mime4j/apidocs/index-all.html

Gets the lower bound of the current parsing cursor.

```APIDOC
## ParserCursor - getLowerBound()

### Description
Gets the lower bound of the current parsing cursor.

### Method
`getLowerBound()`

### Class
`org.apache.james.mime4j.stream.ParserCursor`
```

--------------------------------

### MailboxList Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/MailboxList.html

Initializes a new MailboxList instance.

```APIDOC
## Constructor: MailboxList

### Description
Creates an immutable list of Mailbox objects.

### Parameters
- **mailboxes** (List<Mailbox>) - Required - A list containing Mailbox objects.
- **dontCopy** (boolean) - Required - Set to true if the provided list cannot be modified by external sources.
```

--------------------------------

### StorageProvider Implementations

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/class-use/AbstractStorageProvider.html

Overview of the available subclasses of AbstractStorageProvider used for data management.

```APIDOC
## StorageProvider Implementations

### Description
The following classes extend AbstractStorageProvider to provide various data storage strategies within the org.apache.james.mime4j.storage package.

### Implementations
- **CipherStorageProvider**: A StorageProvider that transparently scrambles and unscrambles the data stored by another StorageProvider.
- **MemoryStorageProvider**: A StorageProvider that stores the data entirely in memory.
- **TempFileStorageProvider**: A StorageProvider that stores the data in temporary files.
- **ThresholdStorageProvider**: A StorageProvider that keeps small amounts of data in memory and writes the remainder to another StorageProvider (the back-end) if a certain threshold size gets exceeded.
```

--------------------------------

### Get Token Image

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/SimpleCharStream.html

Retrieves the string representation of the current token.

```java
public java.lang.String **GetImage**()
```

--------------------------------

### GET /AddressListParser/parseAddressList

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/class-use/ASTaddress_list.html

Parses an address list and returns an ASTaddress_list object.

```APIDOC
## GET /AddressListParser/parseAddressList

### Description
Parses an address list from the input stream and returns an ASTaddress_list object.

### Method
GET

### Endpoint
AddressListParser.parseAddressList()

### Response
#### Success Response (200)
- **ASTaddress_list** (object) - The parsed address list structure.
```

--------------------------------

### Token Class Constructor Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/Token.html

Detailed explanation for the constructor of the Token class.

```APIDOC
### Constructor Detail

---
### Token
```java
public **Token**()
```
```

--------------------------------

### Get Disposition Type

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Returns the disposition type of the content disposition.

```java
String getDispositionType()
```

--------------------------------

### Get Content Transfer Encoding

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Determines the transfer encoding of the entity.

```java
String getContentTransferEncoding()
```

--------------------------------

### Constructor: HeaderImpl()

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/HeaderImpl.html

Initializes a new, empty instance of the HeaderImpl class.

```APIDOC
## Constructor: HeaderImpl()

### Description
Creates a new empty Header instance.

### Method
Constructor

### Request Example
HeaderImpl header = new HeaderImpl();
```

--------------------------------

### Get Mailbox Name

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/Mailbox.html

Returns the name of the mailbox or null if it does not have a name.

```java
public String getName()
```

--------------------------------

### Initialize MessageTree

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/samples/tree/MessageTree.html

Creates a new MessageTree instance for a given message.

```java
public MessageTree(Message message)
```

--------------------------------

### MailboxList get Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/MailboxList.html

Retrieves the Mailbox object at the specified index.

```java
public Mailbox get(int index)
```

--------------------------------

### SimpleCharStream Constructor Summary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/SimpleCharStream.html

Lists and describes the constructors available for the SimpleCharStream class.

```APIDOC
## Constructor Summary

Constructors Constructor and Description
---
`**SimpleCharStream**(InputStream dstream)` Constructor.
`**SimpleCharStream**(InputStream dstream, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(InputStream dstream, int startline, int startcolumn, int buffersize)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(InputStream dstream, String encoding, int startline, int startcolumn, int buffersize)` Constructor.
`**SimpleCharStream**(Reader dstream)` Constructor.
`**SimpleCharStream**(Reader dstream, int startline, int startcolumn)` Constructor.
`**SimpleCharStream**(Reader dstream, int startline, int startcolumn, int buffersize)` Constructor.
```

--------------------------------

### Get Body InputStream

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/SingleBody.html

Retrieves an InputStream to read the body content.

```java
public abstract InputStream getInputStream()
                                    throws IOException
```

--------------------------------

### Iterate Over Enum Constants

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/codec/EncoderUtil.Usage.html

Example of how to iterate over the constants defined in the enum.

```java
for (EncoderUtil.Usage c : EncoderUtil.Usage.values())
   System.out.println(c);
```

--------------------------------

### MimeTokenStream Usage Example

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/MimeTokenStream.html

Demonstrates the typical usage of MimeTokenStream for parsing MIME messages and iterating through different states like fields and body parts.

```APIDOC
## MimeTokenStream Usage Example

### Description
This example shows how to use the `MimeTokenStream` to parse a MIME message from an input stream and process the resulting events.

### Method
N/A (Illustrative Example)

### Endpoint
N/A (Class Usage)

### Parameters
N/A

### Request Example
```java
MimeTokenStream stream = new MimeTokenStream();
stream.parse(new FileInputStream("mime.msg"));
for (int state = stream.getState();
     state != MimeTokenStream.T_END_OF_STREAM;
     state = stream.next()) {
    switch (state) {
      case MimeTokenStream.T_BODY:
        System.out.println("Body detected, contents = "
          + stream.getInputStream() + ", header data = "
          + stream.getBodyDescriptor());
        break;
      case MimeTokenStream.T_FIELD:
        System.out.println("Header field detected: "
          + stream.getField());
        break;
      case MimeTokenStream.T_START_MULTIPART:
        System.out.println("Multipart message detexted,"
          + " header data = "
          + stream.getBodyDescriptor());
      // ... other cases
    }
}
```

### Response
N/A (Illustrative Example)

#### Success Response (N/A)
N/A

#### Response Example
N/A
```

--------------------------------

### Adjust Token Position

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/SimpleCharStream.html

Updates the starting line and column numbers for a token.

```java
public void **adjustBeginLineColumn**(int newLine,
                                  int newCol)
```

--------------------------------

### ThresholdStorageProvider Constructors

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/ThresholdStorageProvider.html

Constructors for initializing the provider with a backend and optional threshold size.

```java
public ThresholdStorageProvider(StorageProvider backend)
```

```java
public ThresholdStorageProvider(StorageProvider backend,
                        int thresholdSize)
```

--------------------------------

### Multipart Implementations

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/class-use/Multipart.html

Information about concrete implementations of the Multipart interface.

```APIDOC
## AbstractMultipart

### Description
Abstract base class for MIME multipart bodies.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

```APIDOC
## MultipartImpl

### Description
Default implementation of the Multipart interface.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Reinitialize Tokenizer

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/parser/SimpleCharStream.html

Reinitializes the tokenizer with a new input stream and starting position.

```java
public void **ReInit**(java.io.InputStream dstream,
                   int startline,
                   int startcolumn)
```

--------------------------------

### Get Content Stream

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/stream/EntityStateMachine.html

Returns the raw input stream for the entity body.

```java
InputStream getContentStream()
                             throws IllegalStateException
```

--------------------------------

### Token Constructor Summary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/Token.html

Summarizes the constructors available for the Token class, including their parameters and descriptions.

```java
`**Token**()` No-argument constructor
```

```java
`**Token**(`int `kind)` Constructs a new token for the specified Image.
```

```java
`**Token**(`int `kind,      String image)` Constructs a new token for the specified Image and Kind.
```

--------------------------------

### TempFileStorageProvider Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/TempFileStorageProvider.html

Initializes a new TempFileStorageProvider. This constructor is equivalent to using TempFileStorageProvider("m4j", null, null).

```java
public TempFileStorageProvider()
```

--------------------------------

### GET getBoundary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/stream/BodyDescriptor.html

Retrieves the boundary string associated with the MIME body descriptor.

```APIDOC
## GET getBoundary

### Description
Returns the boundary string for the body descriptor. If the body is not a multipart entity, this method may return null.

### Method
GET

### Response
- **boundary** (String) - The boundary string, or null if unknown.
```

--------------------------------

### Method Detail: startHeader

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/ContentHandler.html

Called when the header section of a message or body part is about to be parsed.

```APIDOC
## Method Detail: startHeader

### startHeader
```java
void startHeader()
                 throws MimeException
```

Called when a header (of a message or body part) is about to be parsed.

Throws:
    `MimeException` - on processing errors
```

--------------------------------

### Get Recursion Mode

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/parser/MimeTokenStream.html

Retrieves the current recursion mode setting for the MimeTokenStream.

```java
int getRecursionMode()

```

--------------------------------

### Constructor Summary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/TokenMgrError.html

Lists and describes the available constructors for the TokenMgrError class.

```APIDOC
### Constructor Summary

Constructors | Constructor and Description
---|---
`**TokenMgrError**()` | No arg constructor.
`**TokenMgrError**(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar, int reason)` | Full Constructor.
`**TokenMgrError**(String message, int reason)` | Constructor with message and reason.
```

--------------------------------

### Sender Header Management

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/Message.html

APIs for getting and setting the Sender header field.

```APIDOC
## getSender

### Description
Returns the value of the Sender header field of this message as a Mailbox object or null if it is not present.

### Method
public Mailbox

### Endpoint
N/A (Method within a class)

### Parameters
None

### Response
#### Success Response
- **Mailbox** - The sender of this message.

### Response Example
```java
Mailbox sender = message.getSender();
```

## setSender

### Description
Sets the Sender header field of this message to the specified mailbox address.

### Method
public void

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **sender** (Mailbox) - Required - The address to set or `null` to remove the header field.

### Request Example
```java
message.setSender(new Mailbox("sender@example.com"));
```

### Response
None (void method)
```

--------------------------------

### GET getParent

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/message/Body.html

Retrieves the parent entity associated with the current body instance.

```APIDOC
## GET getParent

### Description
Gets the parent of this body.

### Method
GET

### Response
- **Entity** - The parent entity of the body.
```

--------------------------------

### GET getContentLength

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/ContentLengthFieldImpl.html

Retrieves the content length value defined in the Content-Length field.

```APIDOC
## GET getContentLength

### Description
Gets the content length value defined in this field.

### Method
GET

### Response
#### Success Response (200)
- **contentLength** (long) - The content length value.
```

--------------------------------

### setInstance Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/storage/DefaultStorageProvider.html

Configures the default StorageProvider instance for the application.

```java
public static void setInstance(StorageProvider instance)
```

--------------------------------

### Constructor Summary

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/samples/tree/MessageTree.html

Details the constructors available for the MessageTree class.

```APIDOC
### Constructor Summary

| Constructor and Description |
|---|
| `**MessageTree**(Message message)` - Creates a new `MessageTree` instance displaying the specified `Message`. |
```

--------------------------------

### Get Full Mailbox Address

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/Mailbox.html

Returns the address in the form _localPart@domain_.

```java
public String getAddress()
```

--------------------------------

### Token Constructors

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/address/Token.html

Lists and describes the constructors available for creating Token objects.

```APIDOC
### Constructor Summary

| Constructor and Description |
|---|---|
| `**Token**()` - No-argument constructor |
| `**Token**(int kind)` - Constructs a new token for the specified Image. |
| `**Token**(int kind, String image)` - Constructs a new token for the specified Image and Kind. |
```

--------------------------------

### Get Character Set

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/Entity.html

Determines the MIME character set encoding of the entity.

```java
String getCharset()
```

--------------------------------

### DomainList get Method

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/dom/address/DomainList.html

Retrieves the domain name or literal at the specified index.

```java
public String get(int index)
```

--------------------------------

### SimpleCharStream Class Overview

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/mimeversion/parser/SimpleCharStream.html

Provides an overview of the SimpleCharStream class, its purpose, and its inheritance.

```APIDOC
## Class Overview

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

### Inheritance
`java.lang.Object`
  * `org.apache.james.mime4j.field.mimeversion.parser.SimpleCharStream`
```

--------------------------------

### SimpleCharStream Class Overview

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contentdisposition/parser/SimpleCharStream.html

Provides an overview of the SimpleCharStream class, its purpose, and its inheritance.

```APIDOC
## Class Overview

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

### Inheritance
- `java.lang.Object`
  - `org.apache.james.mime4j.field.contentdisposition.parser.SimpleCharStream`
```

--------------------------------

### SimpleCharStream Class Overview

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/contenttype/parser/SimpleCharStream.html

Provides an overview of the SimpleCharStream class, its purpose, and its inheritance.

```APIDOC
## Class: SimpleCharStream

### Description
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

### Inheritance
- java.lang.Object
  - org.apache.james.mime4j.field.contenttype.parser.SimpleCharStream
```

--------------------------------

### SimpleCharStream Class Overview

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/language/parser/SimpleCharStream.html

Provides an overview of the SimpleCharStream class, its purpose, and its inheritance.

```APIDOC
## Class Overview

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

### Inheritance
- `java.lang.Object`
  - `org.apache.james.mime4j.field.language.parser.SimpleCharStream`
```

--------------------------------

### valueOf() Method Detail

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/codec/EncoderUtil.Usage.html

Detailed information and usage example for the valueOf() method.

```APIDOC
## Method Detail

### valueOf

```java
public static EncoderUtil.Usage valueOf(String name)
```

Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
    `name` - the name of the enum constant to be returned.

Returns:
    the enum constant with the specified name

Throws:
    `IllegalArgumentException` - if this enum type has no constant with the specified name
    `NullPointerException` - if the argument is null
```

--------------------------------

### SimpleCharStream Class Overview

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/datetime/parser/SimpleCharStream.html

Provides an overview of the SimpleCharStream class, its inheritance, and its purpose.

```APIDOC
## Class: org.apache.james.mime4j.field.datetime.parser.SimpleCharStream

### Description
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).

### Class Hierarchy
`java.lang.Object`
  * `org.apache.james.mime4j.field.datetime.parser.SimpleCharStream`
```

--------------------------------

### TransformMessage Constructor

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/samples/transform/TransformMessage.html

The default constructor for the TransformMessage class. No specific setup is required.

```java
public
TransformMessage()
```

--------------------------------

### Token Class Constructors

Source: https://james.apache.org/mime4j/apidocs/org/apache/james/mime4j/field/structured/parser/Token.html

Lists and describes the constructors available for creating Token objects.

```APIDOC
## Constructor Summary

| Constructor and Description |
|---|---|
| `**Token**()` - No-argument constructor |
| `**Token**(int kind)` - Constructs a new token for the specified Image. |
| `**Token**(int kind, String image)` - Constructs a new token for the specified Image and Kind. |
```
Tokens:
Raw