`mini\Mail\MultipartMessage` class

Show private and protected members

Documentation

Multipart Message

A PSR-7 MessageInterface that contains multiple child MessageInterfaces. When read as a stream, produces RFC 2046 compliant boundary-delimited content.

Accepts any MessageInterface implementation (Guzzle responses, PSR-7 messages, etc.) without requiring special wrapper classes.

Usage:

$message = new MultipartMessage(MultipartType::Mixed,
    new Message('text/plain', 'Hello'),
    new Message('text/html', '<h1>Hello</h1>'),
    $guzzleResponse  // Any MessageInterface works
);

// Access parts
$part = $message->getPart(0);
$count = count($message);
foreach ($message as $part) { ... }

// Modify (immutable)
$message = $message->withAddedPart($attachment);
$message = $message->withoutPart(2);

// Filter
$htmlParts = $message->findParts(fn($p) =>
    str_starts_with($p->getHeaderLine('Content-Type'), 'text/html')
);

// Stream the body
$body = $message->getBody();
while (!$body->eof()) {
    echo $body->read(8192);
}

Inheritance

Implements: Psr\Http\Message\MessageInterface Countable IteratorAggregate ArrayAccess Traversable

Properties (5)

protected string $protocolVersion

protected array $headers

protected array $headerCases

protected array $parts

protected string $boundary

Methods (34)

public `__construct()`

Create a multipart message

protected `generateBoundary()`

Generate a unique boundary string

public `getParts()`

Get all parts

public `getPart()`

Get a specific part by index

public `hasPart()`

Check if a part exists at the given index

public `withPart()`

Return instance with part replaced at the specified index

public `withAddedPart()`

Return instance with an additional part appended

public `withoutPart()`

Return instance without the part at the specified index

public `findPart()`

Find the first part matching the predicate

public `findParts()`

Find all parts matching the predicate

public `withParts()`

Return instance with only parts matching the predicate

public `withoutParts()`

Return instance without parts matching the predicate

public `getBoundary()`

Get the boundary string

public `getMultipartType()`

Get the multipart subtype (mixed, alternative, related, etc.)

public `withBoundary()`

Return instance with a different boundary

public `withMultipartType()`

Return instance with a different multipart type

public `count()`

Documentation missing

public `getIterator()`

Documentation missing

public `offsetExists()`

Documentation missing

public `offsetGet()`

Documentation missing

public `offsetSet()`

Documentation missing

public `offsetUnset()`

Documentation missing

public `getProtocolVersion()`

Documentation missing

public `withProtocolVersion()`

Documentation missing

public `getHeaders()`

Documentation missing

public `hasHeader()`

Documentation missing

public `getHeader()`

Documentation missing

public `getHeaderLine()`

Documentation missing

public `withHeader()`

Documentation missing

public `withAddedHeader()`

Documentation missing

public `withoutHeader()`

Documentation missing

public `getBody()`

Get the message body

public `withBody()`

Return instance with the specified body

public `__clone()`

Clone handler

Source

src/Mail/MultipartMessage.php:53-467