MailMimeParser 1.1

PartFilterFactory

Injectable factory class used by MimePart to construct PartFilter instances in a testable way.

Users are expected to use the static PartFilter methods directly -- this class simply encapsulates them in an object: o PartFilter::fromContentType o PartFilter::fromInlineContentType o PartFilter::fromDisposition

Tags
see
PartFilter
author

Zaahid Bateson

Table of Contents

newFilterFromArray()  : PartFilter
Constructs a PartFilter from the passed array of options and returns it.
newFilterFromContentType()  : PartFilter
Creates a filter for the passed mime content-type.
newFilterFromDisposition()  : PartFilter
Creates a filter for the passed disposition and optional multipart filter.
newFilterFromInlineContentType()  : PartFilter
Creates an 'inline' filter for the passed mime content-type.

Methods

newFilterFromArray()

Constructs a PartFilter from the passed array of options and returns it.

public newFilterFromArray(array<string|int, mixed> $init) : PartFilter
Parameters
$init : array<string|int, mixed>
Tags
see
PartFilter::__construct
Return values
PartFilter

newFilterFromContentType()

Creates a filter for the passed mime content-type.

public newFilterFromContentType(string $mimeType) : PartFilter

This method just calls PartFilter::fromContentType.

Parameters
$mimeType : string
Tags
see
PartFilter::fromContentType
Return values
PartFilter

newFilterFromDisposition()

Creates a filter for the passed disposition and optional multipart filter.

public newFilterFromDisposition(string $disposition[, int $multipart = PartFilter::FILTER_OFF ]) : PartFilter

This method just calls PartFilter::newFilterFromDisposition.

Parameters
$disposition : string
$multipart : int = PartFilter::FILTER_OFF

one of PartFilter::FILTER_OFF, PartFilter::FILTER_INCLUDE or PartFilter::FILTER_EXCLUDE

Tags
see
PartFilter::fromDisposition
Return values
PartFilter

newFilterFromInlineContentType()

Creates an 'inline' filter for the passed mime content-type.

public newFilterFromInlineContentType(string $mimeType) : PartFilter

This method just calls PartFilter::fromInlineContentType.

Parameters
$mimeType : string
Tags
see
PartFilter::fromInlineContentType
Return values
PartFilter

Search results