IUUEncodedPart
extends
IMessagePart
in
An interface representing a non-mime uuencoded part.
Prior to the MIME standard, a plain text email may have included attachments below it surrounded by 'begin' and 'end' lines and uuencoded data between them. Those attachments are captured as 'IUUEncodedPart' objects.
The 'begin' line included a file name and unix file mode. IUUEncodedPart allows reading/setting those parameters.
IUUEncodedPart returns a Content-Transfer-Encoding of x-uuencode, a Content-Type of application-octet-stream, and a Content-Disposition of 'attachment'. It also expects a mode and filename to initialize it, and adds 'filename' parts to the Content-Disposition and a 'name' parameter to Content-Type.
Tags
Table of Contents
- __toString() : string
- Returns the message/part as a string, containing its headers, content and children.
- 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.
- 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.
- 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.
- getFilename() : string|null
- Returns a filename for the part if one is defined, or null otherwise.
- getParent() : IMimePart
- Returns this part's parent.
- 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.
- getStream() : StreamInterface
- Returns a Psr7 StreamInterface for the string representation of this part, containing its headers, content and children.
- getUnixFileMode() : int|null
- Returns the file mode included in the uuencoded 'begin' line for this part.
- hasContent() : bool
- Returns true if the part contains a 'body' (content).
- isMime() : bool
- Returns true if the current part is a mime part.
- isTextPart() : bool
- Returns true if the content of this part is plain text.
- 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.
- 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.
- setFilename() : mixed
- Sets the filename included in the uuencoded 'begin' line.
- setUnixFileMode() : mixed
- Sets the unix file mode for the uuencoded 'begin' line.
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 —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 —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
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
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
getParent()
Returns this part's parent.
public
getParent() : IMimePart
Return values
IMimePart —the parent part
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.
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.
getUnixFileMode()
Returns the file mode included in the uuencoded 'begin' line for this part.
public
getUnixFileMode() : int|null
Return values
int|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 —isTextPart()
Returns true if the content of this part is plain text.
public
isTextPart() : bool
Return values
bool —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 —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 —setFilename()
Sets the filename included in the uuencoded 'begin' line.
public
setFilename(string $filename) : mixed
Parameters
- $filename : string
Return values
mixed —setUnixFileMode()
Sets the unix file mode for the uuencoded 'begin' line.
public
setUnixFileMode(int $mode) : mixed
Parameters
- $mode : int