PHP Manual
Prev |  | Next

# LXXX. Mailparse Functions

# Introduction

Mailparse is an extension for parsing and working with email messages. It can deal with RFC 822 and RFC 2045 (`MIME`) compliant messages.

Mailparse is stream based, which means that it does not keep in-memory copies of the files it processes - so it is very resource efficient when dealing with large messages.

> Note: Mailparse requires the mbstring extension.

This extension has been moved to the PECL repository and is no longer bundled with PHP as of PHP 4.2.0.

# Installation

This PECL extension is not bundled with PHP. Information for installing this PECL extension may be found in the manual chapter titled Installation of PECL extensions. Additional information such as new releases, downloads, source files, maintainer information, and a CHANGELOG, can be located here: http://pecl.php.net/package/mailparse.

In order to use these functions you must compile PHP with mailparse support by using the `--enable-mailparse` configure option.

Windows users will enable `php_mailparse.dll` inside of `php.ini` in order to use these functions. The DLL for this PECL extension may be downloaded from either the PHP Downloads page or from http://pecl4win.php.net/

# Runtime Configuration

The behaviour of these functions is affected by settings in `php.ini`.

Table 1. Mailparse configuration options

Name | Default | Changeable | Changelog
--- | --- | --- | ---
mailparse.def_charset | "us-ascii" | PHP_INI_ALL |

For further details and definitions of the PHP_INI_* constants, see the Appendix H.

# Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

`MAILPARSE_EXTRACT_OUTPUT` (integer)

`MAILPARSE_EXTRACT_STREAM` (integer)

`MAILPARSE_EXTRACT_RETURN` (integer)

Prev | Home | Next
mail | Up | mailparse_determine_best_xfer_encoding