IMessage
extends
IMimePart
in
An interface representing an email message.
Defines an interface to retrieve content, attachments and other parts of an email message.
Tags
Table of Contents
- __toString() : string
- Returns the message/part as a string, containing its headers, content and children.
- addAttachmentPart() : mixed
- Adds an attachment part for the passed raw data string, handle, or stream and given parameters.
- addAttachmentPartFromFile() : mixed
- Adds an attachment part using the passed file.
- addChild() : mixed
- Registers the passed part as a child of the current part.
- addRawHeader() : mixed
- Adds a header with the given $name and $value.
- attachContentStream() : mixed
- Attaches the stream or resource handle for the part's content. The stream is closed when another stream is attached, or the MimePart is destroyed.
- detachContentStream() : mixed
- Detaches the content stream.
- getAllAttachmentParts() : array<string|int, IMessagePart>
- Returns all attachment parts.
- getAllHeaders() : array<string|int, IHeader>
- Returns an array of all headers in this part.
- getAllHeadersByName() : array<string|int, IHeader>
- Returns an array of headers that match the passed name.
- getAllParts() : array<string|int, IMessagePart>
- Returns the current part, all child parts, and child parts of all children optionally filtering them with the provided PartFilter.
- getAllPartsByMimeType() : array<string|int, IMessagePart>
- Returns an array of all parts that have a content type matching the passed mime type.
- getAttachmentCount() : int
- Returns the number of attachments available.
- getAttachmentPart() : IMessagePart|null
- Returns the attachment part at the given 0-based index, or null if none is set.
- getBinaryContentResourceHandle() : resource|null
- Returns a resource handle for the content's raw data stream, or null if the part doesn't have a content stream.
- getBinaryContentStream() : StreamInterface|null
- Returns the raw data stream for the current part, if it exists, or null if there's no content associated with the stream.
- getCharset() : string|null
- Returns the charset of the content, or null if not applicable/defined.
- getChild() : IMessagePart|null
- Returns the direct child at the given 0-based index and optional filter, or null if none exist or do not match.
- getChildCount() : int
- Returns the number of direct children under this part (optionally counting only filtered items if a callable filter is passed).
- getChildIterator() : RecursiveIterator
- Returns a \RecursiveIterator of child parts.
- getChildParts() : array<string|int, IMessagePart>
- Returns an array of all direct child parts, optionally filtering them with a passed callable.
- getContent() : string|null
- Shortcut to reading stream content and assigning it to a string. Returns null if the part doesn't have a content stream.
- getContentDisposition() : string|null
- Returns the content's disposition, or returns the value of $default if not defined.
- getContentId() : string|null
- Returns the Content ID of the part, or null if not defined.
- getContentStream() : StreamInterface|null
- Returns the StreamInterface for the part's content or null if the part doesn't have a content section.
- getContentTransferEncoding() : string|null
- Returns the content transfer encoding used to encode the content on this part, or the value of $default if not defined.
- getContentType() : string
- Returns the mime type of the content, or $default if one is not set.
- getCountOfPartsByMimeType() : int
- Returns the number of parts that have content types matching the passed mime type.
- getFilename() : string|null
- Returns a filename for the part if one is defined, or null otherwise.
- getHeader() : IHeader|null
- Returns the IHeader object for the header with the given $name.
- getHeaderParameter() : string|null
- Returns the value of the parameter named $param on a header with the passed $header name, or null if the parameter doesn't exist and a $defaultValue isn't passed.
- getHeaderValue() : string|null
- Returns the string value for the header with the given $name, or null if the header doesn't exist and no alternative $defaultValue is passed.
- getHtmlContent() : string|null
- Returns the content of the inline text/html part as a string.
- getHtmlPart() : IMessagePart|null
- Returns the inline text/html IMessagePart for a message.
- getHtmlPartCount() : int
- Returns the number of inline text/html parts this message contains.
- getHtmlStream() : StreamInterface|null
- Returns a Psr7 Stream for the 'inline' text/html content.
- getParent() : IMimePart
- Returns this part's parent.
- getPart() : IMessagePart|null
- Returns the part at the given 0-based index for this part (part 0) and all parts under it, or null if not found with the passed filter function.
- getPartByContentId() : IMessagePart|null
- Returns a part that has the given Content ID, or null if not found.
- getPartByMimeType() : IMessagePart|null
- Returns the part that has a content type matching the passed mime type at the given index, or null if there are no matching parts.
- getPartCount() : int
- Returns the total number of parts in this and all children.
- getRawHeaderIterator() : Iterator
- Returns an iterator to all headers in this part. Each returned element is an array with its first element set to the header's name, and the second to its raw value:
- getRawHeaders() : array<string|int, array<string|int, string>>
- Returns a two dimensional string array of all headers for the mime part with the first element holding the name, and the second its raw string value:
- getResourceHandle() : resource
- Returns a resource handle for the string representation of this part, containing its headers, content and children. For an IMessage, this would be the entire RFC822 (or greater) email.
- getSignaturePart() : IMimePart
- Returns the signature part of a multipart/signed message or null.
- getSignedMessageAsString() : string
- Returns a string containing the entire body of a signed message for verification or calculating a signature.
- getSignedMessageStream() : StreamInterface
- Returns a stream that can be used to read the content part of a signed message, which can be used to sign an email or verify a signature.
- getStream() : StreamInterface
- Returns a Psr7 StreamInterface for the string representation of this part, containing its headers, content and children.
- getTextContent() : string|null
- Returns the content of the inline text/plain part as a string.
- getTextPart() : IMessagePart|null
- Returns the inline text/plain IMessagePart for a message.
- getTextPartCount() : int
- Returns the number of inline text/plain parts this message contains.
- getTextStream() : StreamInterface|null
- Returns a Psr7 Stream for the 'inline' text/plain content.
- hasContent() : bool
- Returns true if the part contains a 'body' (content).
- isMime() : bool
- Returns true if the current part is a mime part.
- isMultiPart() : bool
- Returns true if this part's content type matches multipart/*
- isSignaturePart() : bool
- Returns true if this part is the 'signature' part of a signed message.
- isTextPart() : bool
- Returns true if the content of this part is plain text.
- removeAllHtmlParts() : bool
- Removes all text/html inline parts in this message.
- removeAllParts() : int
- Removes all parts below the current part. If a callable filter is passed, removes only those matching the passed filter. The number of removed parts is returned.
- removeAllTextParts() : bool
- Removes all text/plain inline parts in this message.
- removeAttachmentPart() : mixed
- Removes the attachment at the given index.
- removeHeader() : mixed
- Removes all headers from this part with the passed name.
- removeHtmlPart() : bool
- Removes the text/html part of the message at the passed index if one exists (defaults to first part if an index isn't passed).
- removePart() : int|null
- Removes the child part from this part and returns its previous position or null if it wasn't found.
- removeSingleHeader() : mixed
- Removes a single header with the passed name (in cases where more than one may exist, and others should be preserved).
- removeTextPart() : bool
- Removes the text/plain part of the message at the passed index if one exists (defaults to first part if an index isn't passed).
- save() : mixed
- Writes a string representation of this part, including its headers, content and children to the passed file, resource, or stream.
- saveContent() : mixed
- Saves the binary content of the stream to the passed file, resource or stream.
- setAsMultipartSigned() : mixed
- Turns the message into a multipart/signed message, moving the actual message into a child part, sets the content-type of the main message to multipart/signed and adds an empty signature part as well.
- setCharsetOverride() : mixed
- Overrides the default character set used for reading content from content streams in cases where a user knows the source charset is not what is specified.
- setContent() : mixed
- Sets the content of the part to the passed string, resource, or stream.
- setHtmlPart() : mixed
- Sets the text/html part of the message to the passed $resource, either creating a new part if one doesn't exist for text/html, or assigning the value of $resource to an existing text/html part.
- setRawHeader() : mixed
- Adds a header with the given $name and $value. An optional $offset may be passed, which will overwrite a header if one exists with the given name and offset only. Otherwise a new header is added. The passed $offset may be ignored in that case if it doesn't represent the next insert position for the header with the passed name... instead it would be 'pushed' on at the next position.
- setSignature() : mixed
- Sets the signature body of the message to the passed $body for a multipart/signed message.
- setTextPart() : mixed
- Sets the text/plain part of the message to the passed $resource, either creating a new part if one doesn't exist for text/plain, or assigning the value of $resource to an existing text/plain part.
Methods
__toString()
Returns the message/part as a string, containing its headers, content and children.
public
__toString() : string
Convenience method for calling getContents() on IMessagePart::getStream().
Tags
Return values
string —addAttachmentPart()
Adds an attachment part for the passed raw data string, handle, or stream and given parameters.
public
addAttachmentPart(string|resource|StreamInterface $resource, string $mimeType[, string $filename = null ][, string $disposition = 'attachment' ][, string $encoding = 'base64' ]) : mixed
Note that $disposition must be one of 'inline' or 'attachment', and will default to 'attachment' if a different value is passed.
Parameters
- $resource : string|resource|StreamInterface
-
the part's content
- $mimeType : string
-
the mime-type of the attachment
- $filename : string = null
-
Optional filename (to set relevant header params)
- $disposition : string = 'attachment'
-
Optional Content-Disposition value.
- $encoding : string = 'base64'
-
defaults to 'base64', only applied for a mime email
Return values
mixed —addAttachmentPartFromFile()
Adds an attachment part using the passed file.
public
addAttachmentPartFromFile(string $filePath, string $mimeType[, string $filename = null ][, string $disposition = 'attachment' ][, string $encoding = 'base64' ]) : mixed
Essentially creates a psr7 stream and calls IMessage::addAttachmentPart.
Note that $disposition must be one of 'inline' or 'attachment', and will default to 'attachment' if a different value is passed.
Parameters
- $filePath : string
-
file to attach
- $mimeType : string
-
the mime-type of the attachment
- $filename : string = null
-
Optional filename (to set relevant header params)
- $disposition : string = 'attachment'
-
Optional Content-Disposition value.
- $encoding : string = 'base64'
-
defaults to 'base64', only applied for a mime email
Return values
mixed —addChild()
Registers the passed part as a child of the current part.
public
addChild(IMessagePart $part[, int $position = null ]) : mixed
If the $position parameter is non-null, adds the part at the passed position index, otherwise adds it as the last child.
Parameters
- $part : IMessagePart
-
The part to add.
- $position : int = null
-
Optional insertion position 0-based index.
Return values
mixed —addRawHeader()
Adds a header with the given $name and $value.
public
addRawHeader(string $name, string $value) : mixed
Note: If a header with the passed name already exists, a new header is created with the same name. This should only be used when that is intentional - in most cases IMimePart::setRawHeader() should be called instead.
A new IHeader object is created from the passed value. No processing on the passed string is performed, and so the passed name and value must be formatted correctly according to related RFCs. In particular, be careful to encode non-ascii data, to keep lines under 998 characters in length, and to follow any special formatting required for the type of header.
Parameters
- $name : string
-
The name of the header
- $value : string
-
The raw value of the header.
Tags
Return values
mixed —attachContentStream()
Attaches the stream or resource handle for the part's content. The stream is closed when another stream is attached, or the MimePart is destroyed.
public
attachContentStream(StreamInterface $stream[, string $streamCharset = MailMimeParser::DEFAULT_CHARSET ]) : mixed
Parameters
- $stream : StreamInterface
-
the content
- $streamCharset : string = MailMimeParser::DEFAULT_CHARSET
-
the charset of $stream
Tags
Return values
mixed —detachContentStream()
Detaches the content stream.
public
detachContentStream() : mixed
Tags
Return values
mixed —getAllAttachmentParts()
Returns all attachment parts.
public
getAllAttachmentParts() : array<string|int, IMessagePart>
The method returns all parts other than the main content part for a non-mime message, and all parts under a mime message except:
- text/plain and text/html parts with a Content-Disposition not set to 'attachment'
- all multipart/* parts
- any signature part
Tags
Return values
array<string|int, IMessagePart> —getAllHeaders()
Returns an array of all headers in this part.
public
getAllHeaders() : array<string|int, IHeader>
Tags
Return values
array<string|int, IHeader> —an array of header objects
getAllHeadersByName()
Returns an array of headers that match the passed name.
public
getAllHeadersByName(string $name) : array<string|int, IHeader>
Parameters
- $name : string
Tags
Return values
array<string|int, IHeader> —an array of header objects
getAllParts()
Returns the current part, all child parts, and child parts of all children optionally filtering them with the provided PartFilter.
public
getAllParts([callable $fnFilter = null ]) : array<string|int, IMessagePart>
Note that the first part returned is the current part itself. This is often desirable for queries with a passed filter, e.g. looking for an IMessagePart with a specific Content-Type that may be satisfied by the current part.
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
array<string|int, IMessagePart> —An array of matching parts.
getAllPartsByMimeType()
Returns an array of all parts that have a content type matching the passed mime type.
public
getAllPartsByMimeType(string $mimeType) : array<string|int, IMessagePart>
Creates a filter that looks at the return value of IMessagePart::getContentType() for all parts (including the current part), returning an array of matching parts.
Parameters
- $mimeType : string
-
The mime type to find.
Tags
Return values
array<string|int, IMessagePart> —An array of matching parts.
getAttachmentCount()
Returns the number of attachments available.
public
getAttachmentCount() : int
Tags
Return values
int —getAttachmentPart()
Returns the attachment part at the given 0-based index, or null if none is set.
public
getAttachmentPart(int $index) : IMessagePart|null
The method returns all parts other than the main content part for a non-mime message, and all parts under a mime message except:
- text/plain and text/html parts with a Content-Disposition not set to 'attachment'
- all multipart/* parts
- any signature part
Parameters
- $index : int
-
the 0-based index of the attachment part to return.
Tags
Return values
IMessagePart|null —getBinaryContentResourceHandle()
Returns a resource handle for the content's raw data stream, or null if the part doesn't have a content stream.
public
getBinaryContentResourceHandle() : resource|null
The method wraps a call to IMessagePart::getBinaryContentStream() and returns a resource handle for the returned Stream.
Tags
Return values
resource|null —the resource
getBinaryContentStream()
Returns the raw data stream for the current part, if it exists, or null if there's no content associated with the stream.
public
getBinaryContentStream() : StreamInterface|null
This is basically the same as calling IMessagePart::getContentStream(), except no automatic charset conversion is done. Note that for non-text streams, this doesn't have an effect, as charset conversion is not performed in that case, and is useful only when:
- The charset defined is not correct, and the conversion produces errors; or
- You'd like to read the raw contents without conversion, for instance to save it to file or allow a user to download it as-is (in a download link for example).
Tags
Return values
StreamInterface|null —the stream
getCharset()
Returns the charset of the content, or null if not applicable/defined.
public
getCharset() : string|null
Return values
string|null —the charset
getChild()
Returns the direct child at the given 0-based index and optional filter, or null if none exist or do not match.
public
getChild(int $index[, callable $fnFilter = null ]) : IMessagePart|null
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $index : int
-
0-based index
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
IMessagePart|null —The matching direct child part or null if not found.
getChildCount()
Returns the number of direct children under this part (optionally counting only filtered items if a callable filter is passed).
public
getChildCount([callable $fnFilter = null ]) : int
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
int —The number of children, or number of children matching the the passed filtering callable.
getChildIterator()
Returns a \RecursiveIterator of child parts.
public
getChildIterator() : RecursiveIterator
The https://www.php.net/manual/en/class.recursiveiterator.php allows iterating over direct children, or using a https://www.php.net/manual/en/class.recursiveiteratoriterator.php to iterate over direct children, and all their children.
Tags
Return values
RecursiveIterator —getChildParts()
Returns an array of all direct child parts, optionally filtering them with a passed callable.
public
getChildParts([callable $fnFilter = null ]) : array<string|int, IMessagePart>
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
array<string|int, IMessagePart> —An array of matching child parts.
getContent()
Shortcut to reading stream content and assigning it to a string. Returns null if the part doesn't have a content stream.
public
getContent([string $charset = MailMimeParser::DEFAULT_CHARSET ]) : string|null
The returned string is encoded to the passed $charset character encoding.
Parameters
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
the target charset for the returned string
Tags
Return values
string|null —the content
getContentDisposition()
Returns the content's disposition, or returns the value of $default if not defined.
public
getContentDisposition([string $default = null ]) : string|null
Parameters
- $default : string = null
-
Optional default value to return if not applicable/defined
Return values
string|null —the disposition.
getContentId()
Returns the Content ID of the part, or null if not defined.
public
getContentId() : string|null
Return values
string|null —the content ID.
getContentStream()
Returns the StreamInterface for the part's content or null if the part doesn't have a content section.
public
getContentStream([string $charset = MailMimeParser::DEFAULT_CHARSET ]) : StreamInterface|null
To get a stream without charset conversion if you know the part's content contains a binary stream, call self::getBinaryContentStream() instead.
The library automatically handles decoding and charset conversion (to the target passed $charset) based on the part's transfer encoding as returned by IMessagePart::getContentTransferEncoding() and the part's charset as returned by IMessagePart::getCharset(). The returned stream is ready to be read from directly.
Note that the returned Stream is a shared object. If called multiple times with the same $charset, and the value of the part's Content-Transfer-Encoding header has not changed, the stream will be rewound. This would affect other existing variables referencing the stream, for example:
// assuming $part is a part containing the following
// string for its content: '12345678'
$stream = $part->getContentStream();
$someChars = $part->read(4);
$stream2 = $part->getContentStream();
$moreChars = $part->read(4);
echo ($someChars === $moreChars); //1
In this case the Stream was rewound, and $stream's second call to read 4 bytes reads the same first 4.
Parameters
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
Optional charset for the returned stream.
Tags
Return values
StreamInterface|null —the stream
getContentTransferEncoding()
Returns the content transfer encoding used to encode the content on this part, or the value of $default if not defined.
public
getContentTransferEncoding([ $default = null ]) : string|null
Parameters
Return values
string|null —the transfer encoding defined for the part.
getContentType()
Returns the mime type of the content, or $default if one is not set.
public
getContentType([string $default = 'text/plain' ]) : string
Parameters
- $default : string = 'text/plain'
-
Optional override for the default return value of 'text/plain.
Return values
string —the mime type
getCountOfPartsByMimeType()
Returns the number of parts that have content types matching the passed mime type.
public
getCountOfPartsByMimeType(string $mimeType) : int
Parameters
- $mimeType : string
-
The mime type to find.
Tags
Return values
int —The number of matching parts.
getFilename()
Returns a filename for the part if one is defined, or null otherwise.
public
getFilename() : string|null
Return values
string|null —the file name
getHeader()
Returns the IHeader object for the header with the given $name.
public
getHeader(string $name, int $offset) : IHeader|null
If the optional $offset is passed, and multiple headers exist with the same name, the one at the passed offset is returned.
Note that mime headers aren't case sensitive, and the '-' character is
If a header with the given $name and $offset doesn't exist, null is returned.
Parameters
- $name : string
-
The name of the header to retrieve.
- $offset : int
-
Optional offset if there are multiple headers with the given name.
Tags
Return values
IHeader|null —the header object
getHeaderParameter()
Returns the value of the parameter named $param on a header with the passed $header name, or null if the parameter doesn't exist and a $defaultValue isn't passed.
public
getHeaderParameter(string $header, string $param[, string $defaultValue = null ]) : string|null
Only headers of type ParameterHeader have parameters. Content-Type and Content-Disposition are examples of headers with parameters. "Charset" is a common parameter of Content-Type.
Parameters
- $header : string
-
The name of the header.
- $param : string
-
The name of the parameter.
- $defaultValue : string = null
-
Optional default value to return if the parameter doesn't exist.
Tags
Return values
string|null —The value of the parameter.
getHeaderValue()
Returns the string value for the header with the given $name, or null if the header doesn't exist and no alternative $defaultValue is passed.
public
getHeaderValue(string $name[, string $defaultValue = null ]) : string|null
Note that mime headers aren't case sensitive.
Parameters
- $name : string
-
The name of the header
- $defaultValue : string = null
-
Optional default value to return if the header doesn't exist on this part.
Tags
Return values
string|null —the value of the header
getHtmlContent()
Returns the content of the inline text/html part as a string.
public
getHtmlContent(int $index[, string $charset = MailMimeParser::DEFAULT_CHARSET ]) : string|null
If the message contains more than one text/html 'inline' part, the default behavior is to return the first part. The content for additional parts can be returned by passing a 0-based index.
If a part at the passed index doesn't exist, null is returned.
Parameters
- $index : int
-
Optional 0-based index of inline html part content.
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
Optional charset for the returned string to be encoded in.
Tags
Return values
string|null —getHtmlPart()
Returns the inline text/html IMessagePart for a message.
public
getHtmlPart(int $index) : IMessagePart|null
If the message contains more than one text/html 'inline' part, the default behavior is to return the first part. Additional parts can be returned by passing a 0-based index.
If there are no inline text/plain parts in this message, null is returned.
Parameters
- $index : int
-
Optional index of part to return.
Tags
Return values
IMessagePart|null —getHtmlPartCount()
Returns the number of inline text/html parts this message contains.
public
getHtmlPartCount() : int
Tags
Return values
int —getHtmlStream()
Returns a Psr7 Stream for the 'inline' text/html content.
public
getHtmlStream(int $index[, string $charset = MailMimeParser::DEFAULT_CHARSET ]) : StreamInterface|null
If the message contains more than one text/html 'inline' part, the default behavior is to return the first part. The streams for additional parts can be returned by passing a 0-based index.
If a part at the passed index doesn't exist, null is returned.
Parameters
- $index : int
-
Optional 0-based index of inline html part stream.
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
Optional charset to encode the stream with.
Tags
Return values
StreamInterface|null —getParent()
Returns this part's parent.
public
getParent() : IMimePart
Return values
IMimePart —the parent part
getPart()
Returns the part at the given 0-based index for this part (part 0) and all parts under it, or null if not found with the passed filter function.
public
getPart(int $index[, callable $fnFilter = null ]) : IMessagePart|null
Note that the first part returned is the current part itself. This is usually desirable for queries with a passed filter, e.g. looking for an part with a specific Content-Type that may be satisfied by the current part.
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $index : int
-
The 0-based index (0 being this part if $fnFilter is null or this part is satisfied by the filter).
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
IMessagePart|null —A matching part, or null if not found.
getPartByContentId()
Returns a part that has the given Content ID, or null if not found.
public
getPartByContentId(string $contentId) : IMessagePart|null
Calls IMessagePart::getContentId() to find a matching part.
Parameters
- $contentId : string
-
The content ID to find a part for.
Return values
IMessagePart|null —The matching part.
getPartByMimeType()
Returns the part that has a content type matching the passed mime type at the given index, or null if there are no matching parts.
public
getPartByMimeType(string $mimeType, int $index) : IMessagePart|null
Creates a filter that looks at the return value of IMessagePart::getContentType() for all parts (including the current part) and returns a matching one at the given 0-based index.
Parameters
- $mimeType : string
-
The mime type to find.
- $index : int
-
Optional 0-based index (defaulting to '0').
Tags
Return values
IMessagePart|null —The part.
getPartCount()
Returns the total number of parts in this and all children.
public
getPartCount([callable $fnFilter = null ]) : int
Note that the current part is considered, so the minimum getPartCount is 1 without a filter.
The passed callable must accept an IMessagePart as an argument, and return true if it should be accepted, or false to filter the part out. Some default filters are provided by static functions returning callables in PartFilter.
Parameters
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Tags
Return values
int —The number of matching parts.
getRawHeaderIterator()
Returns an iterator to all headers in this part. Each returned element is an array with its first element set to the header's name, and the second to its raw value:
public
getRawHeaderIterator() : Iterator
[ 'Header-Name', 'Header Value' ]
Tags
Return values
Iterator —an iterator for raw headers
getRawHeaders()
Returns a two dimensional string array of all headers for the mime part with the first element holding the name, and the second its raw string value:
public
getRawHeaders() : array<string|int, array<string|int, string>>
[ [ '1st-Header-Name', 'Header Value' ], [ '2nd-Header-Name', 'Header Value' ] ]
Tags
Return values
array<string|int, array<string|int, string>> —an array of raw headers
getResourceHandle()
Returns a resource handle for the string representation of this part, containing its headers, content and children. For an IMessage, this would be the entire RFC822 (or greater) email.
public
getResourceHandle() : resource
If the part has not been modified and represents a parsed part, the original stream should be returned. Otherwise a stream representation of the part including its modifications should be returned. This insures that an unmodified, signed message could be passed on that way even after parsing and reading.
The returned stream is not guaranteed to be RFC822 (or greater) compliant for the following reasons:
- The original email or part, if not modified, is returned as-is and may not be compliant.
- Although certain parts may have been modified, an original unmodified header from the original email or part may not be compliant.
- A user may set headers in a non-compliant format.
Tags
Return values
resource —the resource handle containing the part.
getSignaturePart()
Returns the signature part of a multipart/signed message or null.
public
getSignaturePart() : IMimePart
The signature part is determined to always be the 2nd child of a multipart/signed message, the first being the 'body'.
Using the 'protocol' parameter of the Content-Type header is unreliable in some instances (for instance a difference of x-pgp-signature versus pgp-signature).
Return values
IMimePart —getSignedMessageAsString()
Returns a string containing the entire body of a signed message for verification or calculating a signature.
public
getSignedMessageAsString() : string
Non-CRLF new lines are replaced to always be CRLF.
Tags
Return values
string —or null if the message doesn't have any children
getSignedMessageStream()
Returns a stream that can be used to read the content part of a signed message, which can be used to sign an email or verify a signature.
public
getSignedMessageStream() : StreamInterface
The method simply returns the stream for the first child. No verification of whether the message is in fact a signed message is performed.
Note that unlike getSignedMessageAsString, getSignedMessageStream doesn't replace new lines, and before calculating a signature, LFs not preceded by CR should be replaced with CRLFs.
Tags
Return values
StreamInterface —or null if the message doesn't have any children
getStream()
Returns a Psr7 StreamInterface for the string representation of this part, containing its headers, content and children.
public
getStream() : StreamInterface
If the part has not been modified and represents a parsed part, the original stream should be returned. Otherwise a stream representation of the part including its modifications should be returned. This insures that an unmodified, signed message could be passed on that way even after parsing and reading.
The returned stream is not guaranteed to be RFC822 (or greater) compliant for the following reasons:
- The original email or part, if not modified, is returned as-is and may not be compliant.
- Although certain parts may have been modified, an original unmodified header from the original email or part may not be compliant.
- A user may set headers in a non-compliant format.
Tags
Return values
StreamInterface —the stream containing the part.
getTextContent()
Returns the content of the inline text/plain part as a string.
public
getTextContent(int $index[, string $charset = MailMimeParser::DEFAULT_CHARSET ]) : string|null
If the message contains more than one text/plain 'inline' part, the default behavior is to return the first part. The content for additional parts can be returned by passing a 0-based index.
If a part at the passed index doesn't exist, null is returned.
Parameters
- $index : int
-
Optional 0-based index of inline text part content.
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
Optional charset for the returned string to be encoded in.
Tags
Return values
string|null —getTextPart()
Returns the inline text/plain IMessagePart for a message.
public
getTextPart(int $index) : IMessagePart|null
If the message contains more than one text/plain 'inline' part, the default behavior is to return the first part. Additional parts can be returned by passing a 0-based index.
If there are no inline text/plain parts in this message, null is returned.
Parameters
- $index : int
-
Optional index of part to return.
Tags
Return values
IMessagePart|null —getTextPartCount()
Returns the number of inline text/plain parts this message contains.
public
getTextPartCount() : int
Tags
Return values
int —getTextStream()
Returns a Psr7 Stream for the 'inline' text/plain content.
public
getTextStream(int $index[, string $charset = MailMimeParser::DEFAULT_CHARSET ]) : StreamInterface|null
If the message contains more than one text/plain 'inline' part, the default behavior is to return the first part. The streams for additional parts can be returned by passing a 0-based index.
If a part at the passed index doesn't exist, null is returned.
Parameters
- $index : int
-
Optional 0-based index of inline text part stream.
- $charset : string = MailMimeParser::DEFAULT_CHARSET
-
Optional charset to encode the stream with.
Tags
Return values
StreamInterface|null —hasContent()
Returns true if the part contains a 'body' (content).
public
hasContent() : bool
Return values
bool —isMime()
Returns true if the current part is a mime part.
public
isMime() : bool
Return values
bool —isMultiPart()
Returns true if this part's content type matches multipart/*
public
isMultiPart() : bool
Return values
bool —isSignaturePart()
Returns true if this part is the 'signature' part of a signed message.
public
isSignaturePart() : bool
Return values
bool —isTextPart()
Returns true if the content of this part is plain text.
public
isTextPart() : bool
Return values
bool —removeAllHtmlParts()
Removes all text/html inline parts in this message.
public
removeAllHtmlParts([bool $moveRelatedPartsBelowMessage = true ]) : bool
If the message contains a multipart/alternative part, the html parts are removed from below the alternative part only. If there is only one remaining part after that, it is moved up, replacing the multipart/alternative part.
If the multipart/alternative part further contains a multipart/related (or mixed) part which holds an inline html part, only parts from that child multipart are removed, and if the passed $moveRelatedPartsBelowMessage is true, any non-html parts are moved to be below the message directly (changing the message into a multipart/mixed message if need be).
For more control, call IMessagePart::removePart() with parts you wish to remove.
Parameters
- $moveRelatedPartsBelowMessage : bool = true
-
Optionally pass false to remove related parts.
Tags
Return values
bool —true on success
removeAllParts()
Removes all parts below the current part. If a callable filter is passed, removes only those matching the passed filter. The number of removed parts is returned.
public
removeAllParts([callable $fnFilter = null ]) : int
Note: the current part will not be removed. Although the function naming matches getAllParts, which returns the current part, it also doesn't only remove direct children like getChildParts. Internally this function uses getAllParts but the current part is filtered out if returned.
Parameters
- $fnFilter : callable = null
-
Optional function accepting an IMessagePart and returning true if the part should be included.
Return values
int —The number of removed parts.
removeAllTextParts()
Removes all text/plain inline parts in this message.
public
removeAllTextParts([bool $moveRelatedPartsBelowMessage = true ]) : bool
If the message contains a multipart/alternative part, the text parts are removed from below the alternative part only. If there is only one remaining part after that, it is moved up, replacing the multipart/alternative part.
If the multipart/alternative part further contains a multipart/related (or mixed) part which holds an inline text part, only parts from that child multipart are removed, and if the passed $moveRelatedPartsBelowMessage is true, any non-text parts are moved to be below the message directly (changing the message into a multipart/mixed message if need be).
For more control, call IMessagePart::removePart() with parts you wish to remove.
Parameters
- $moveRelatedPartsBelowMessage : bool = true
-
Optionally pass false to remove related parts.
Tags
Return values
bool —true on success
removeAttachmentPart()
Removes the attachment at the given index.
public
removeAttachmentPart(int $index) : mixed
Attachments are considered to be all parts other than the main content part for a non-mime message, and all parts under a mime message except:
- text/plain and text/html parts with a Content-Disposition not set to 'attachment'
- all multipart/* parts
- any signature part
Parameters
- $index : int
Return values
mixed —removeHeader()
Removes all headers from this part with the passed name.
public
removeHeader(string $name) : mixed
Parameters
- $name : string
-
The name of the header(s) to remove.
Tags
Return values
mixed —removeHtmlPart()
Removes the text/html part of the message at the passed index if one exists (defaults to first part if an index isn't passed).
public
removeHtmlPart(int $index) : bool
Returns true if a part exists at the passed index and has been removed.
Parameters
- $index : int
-
Optional 0-based index of inline html part to remove.
Tags
Return values
bool —true on success
removePart()
Removes the child part from this part and returns its previous position or null if it wasn't found.
public
removePart(IMessagePart $part) : int|null
Note that if the part is not a direct child of this part, the returned position is its index within its parent (calls removePart on its direct parent).
This also means that parts from unrelated parts/messages could be removed
by a call to removePart -- it will always remove the part from its parent
if it has one, essentially calling
php $part->getParent()->removePart(); .
Parameters
- $part : IMessagePart
-
The part to remove
Return values
int|null —The previous index position of the part within its old parent.
removeSingleHeader()
Removes a single header with the passed name (in cases where more than one may exist, and others should be preserved).
public
removeSingleHeader(string $name, int $offset) : mixed
Parameters
- $name : string
-
The name of the header to remove
- $offset : int
-
Optional offset of the header to remove (defaults to 0 -- the first header).
Tags
Return values
mixed —removeTextPart()
Removes the text/plain part of the message at the passed index if one exists (defaults to first part if an index isn't passed).
public
removeTextPart(int $index) : bool
Returns true if a part exists at the passed index and has been removed.
Parameters
- $index : int
-
Optional 0-based index of inline text part to remove.
Tags
Return values
bool —true on success
save()
Writes a string representation of this part, including its headers, content and children to the passed file, resource, or stream.
public
save(string|resource|StreamInterface $filenameResourceOrStream[, string $filemode = 'w+' ]) : mixed
If the part has not been modified and represents a parsed part, the original stream should be written to the file. Otherwise a stream representation of the part including its modifications should be written. This insures that an unmodified, signed message could be passed on this way even after parsing and reading.
The written stream is not guaranteed to be RFC822 (or greater) compliant for the following reasons:
- The original email or part, if not modified, is returned as-is and may not be compliant.
- Although certain parts may have been modified, an original unmodified header from the original email or part may not be compliant.
- A user may set headers in a non-compliant format.
If the passed $filenameResourceOrStream is a string, it's assumed to be a filename to write to.
When passing a resource or Psr7 Stream, the resource is not closed, nor rewound after being written to.
Parameters
- $filenameResourceOrStream : string|resource|StreamInterface
-
the file, resource, or stream to write to.
- $filemode : string = 'w+'
-
Optional filemode to open a file in (if $filenameResourceOrStream is a string)
Tags
Return values
mixed —saveContent()
Saves the binary content of the stream to the passed file, resource or stream.
public
saveContent(string|resource|StreamInterface $filenameResourceOrStream) : mixed
Note that charset conversion is not performed in this case, and the contents of the part are saved in their binary format as transmitted (but after any content-transfer decoding is performed). IMessagePart::getBinaryContentStream() for a more detailed description of the stream.
If the passed parameter is a string, it's assumed to be a filename to write to. The file is opened in 'w+' mode, and closed before returning.
When passing a resource or Psr7 Stream, the resource is not closed, nor rewound.
Parameters
- $filenameResourceOrStream : string|resource|StreamInterface
Tags
Return values
mixed —setAsMultipartSigned()
Turns the message into a multipart/signed message, moving the actual message into a child part, sets the content-type of the main message to multipart/signed and adds an empty signature part as well.
public
setAsMultipartSigned(string $micalg, string $protocol) : mixed
After calling setAsMultipartSigned, call getSignedMessageAsString to get the normalized string content to be used for calculated the message's hash.
Parameters
- $micalg : string
-
The Message Integrity Check algorithm being used
- $protocol : string
-
The mime-type of the signature body
Tags
Return values
mixed —setCharsetOverride()
Overrides the default character set used for reading content from content streams in cases where a user knows the source charset is not what is specified.
public
setCharsetOverride(string $charsetOverride[, bool $onlyIfNoCharset = false ]) : mixed
If set, the returned value from IMessagePart::getCharset() must be ignored during subsequent read operations and streams created out of this part's content.
Note that setting an override on an IMessage and calling getTextStream, getTextContent, getHtmlStream or getHtmlContent will not be applied to those sub-parts, unless the text/html part is the IMessage itself. Instead, IMessage::getTextPart() should be called, and setCharsetOverride called on the returned IMessagePart.
Parameters
- $charsetOverride : string
-
the actual charset of the content.
- $onlyIfNoCharset : bool = false
-
if true, $charsetOverride is used only if getCharset returns null.
Tags
Return values
mixed —setContent()
Sets the content of the part to the passed string, resource, or stream.
public
setContent(string|resource|StreamInterface $resource[, string $resourceCharset = MailMimeParser::DEFAULT_CHARSET ]) : mixed
Parameters
- $resource : string|resource|StreamInterface
-
the content.
- $resourceCharset : string = MailMimeParser::DEFAULT_CHARSET
-
the charset of the passed $resource.
Tags
Return values
mixed —setHtmlPart()
Sets the text/html part of the message to the passed $resource, either creating a new part if one doesn't exist for text/html, or assigning the value of $resource to an existing text/html part.
public
setHtmlPart(string|resource|StreamInterface $resource[, string $contentTypeCharset = 'UTF-8' ]) : mixed
The optional $contentTypeCharset parameter is the charset for the text/html part's Content-Type, not the charset of the passed $resource. $resource must be encoded in UTF-8 regardless of the target charset.
Parameters
- $resource : string|resource|StreamInterface
-
UTF-8 encoded content.
- $contentTypeCharset : string = 'UTF-8'
-
the charset to use as the text/html part's content-type header charset value.
Tags
Return values
mixed —setRawHeader()
Adds a header with the given $name and $value. An optional $offset may be passed, which will overwrite a header if one exists with the given name and offset only. Otherwise a new header is added. The passed $offset may be ignored in that case if it doesn't represent the next insert position for the header with the passed name... instead it would be 'pushed' on at the next position.
public
setRawHeader(string $name, string|null $value, int $offset) : mixed
$part = $myMimePart;
$part->setRawHeader('New-Header', 'value');
echo $part->getHeaderValue('New-Header'); // 'value'
$part->setRawHeader('New-Header', 'second', 4);
echo is_null($part->getHeader('New-Header', 4)); // '1' (true)
echo $part->getHeader('New-Header', 1)
->getValue(); // 'second'
A new IHeader object is created from the passed value. No processing on the passed string is performed, and so the passed name and value must be formatted correctly according to related RFCs. In particular, be careful to encode non-ascii data, to keep lines under 998 characters in length, and to follow any special formatting required for the type of header.
Parameters
- $name : string
-
The name of the new header, e.g. 'Content-Type'.
- $value : string|null
-
The raw value of the new header.
- $offset : int
-
An optional offset, defaulting to '0' and therefore overriding the first header of the given $name if one exists.
Tags
Return values
mixed —setSignature()
Sets the signature body of the message to the passed $body for a multipart/signed message.
public
setSignature(string $body) : mixed
Parameters
- $body : string
-
the message's hash
Return values
mixed —setTextPart()
Sets the text/plain part of the message to the passed $resource, either creating a new part if one doesn't exist for text/plain, or assigning the value of $resource to an existing text/plain part.
public
setTextPart(string|resource|StreamInterface $resource[, string $contentTypeCharset = 'UTF-8' ]) : mixed
The optional $contentTypeCharset parameter is the charset for the text/plain part's Content-Type, not the charset of the passed $resource. $resource must be encoded in UTF-8 regardless of the target charset.
Parameters
- $resource : string|resource|StreamInterface
-
UTF-8 encoded content.
- $contentTypeCharset : string = 'UTF-8'
-
the charset to use as the text/plain part's content-type header charset value.