PHPFUI/InstaDoc

Provides various routines to manipulate and create multipart messages from an
existing message (e.g. to make space for attachments in a message, or to
change a simple message to a multipart/alternative one, etc...)

author Zaahid Bateson

CloneableInstantiable

Extends
ZBateson\MailMimeParser\Message\Helper\AbstractHelper

Methods

public __construct(ZBateson\MailMimeParser\Message\Factory\IMimePartFactory $mimePartFactory, ZBateson\MailMimeParser\Message\Factory\IUUEncodedPartFactory $uuEncodedPartFactory, ZBateson\MailMimeParser\Message\Helper\GenericHelper $genericHelper)

public createAlternativeContentPart(ZBateson\MailMimeParser\IMessage $message, ZBateson\MailMimeParser\Message\IMessagePart $contentPart)

Creates a new mime part as a multipart/alternative and assigns the passed
$contentPart as a part below it before returning it.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\Object_ $contentPart
return phpDocumentor\Reflection\Types\Object_ the alternative part

public createAndAddPartForAttachment(ZBateson\MailMimeParser\IMessage $message, $resource, $mimeType, $disposition, $filename = NULL, $encoding = 'base64')

Creates and adds a IMimePart for the passed content and options as an
attachment.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\Compound $resource
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\String_ $disposition
param phpDocumentor\Reflection\Types\String_ $filename
param phpDocumentor\Reflection\Types\String_ $encoding
return phpDocumentor\Reflection\Types\Object_

public createContentPartForMimeType(ZBateson\MailMimeParser\IMessage $message, $mimeType, $charset)

Creates a new content part for the passed mimeType and charset, making
space by creating a multipart/alternative if needed

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\String_ $charset
return phpDocumentor\Reflection\Types\Object_

public createMultipartRelatedPartForInlineChildrenOf(ZBateson\MailMimeParser\Message\IMimePart $parent)

Creates a multipart/related part out of 'inline' children of $parent and
returns it.

param phpDocumentor\Reflection\Types\Object_ $parent
return phpDocumentor\Reflection\Types\Object_

public enforceMime(ZBateson\MailMimeParser\IMessage $message)

Enforces the message to be a mime message for a non-mime (e.g. uuencoded
or unspecified) message. If the message has uuencoded attachments, sets
up the message as a multipart/mixed message and creates a separate
content part.

param phpDocumentor\Reflection\Types\Object_ $message

public findOtherContentPartFor(ZBateson\MailMimeParser\IMessage $message, $mimeType)

Finds an alternative inline part in the message and returns it if one
exists.

If the passed $mimeType is text/plain, searches for a text/html part.
Otherwise searches for a text/plain part to return.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
return phpDocumentor\Reflection\Types\Object_ or null if not found

public getContentPartContainerFromAlternative( $mimeType, ZBateson\MailMimeParser\Message\IMimePart $alternativePart)

Searches the passed $alternativePart for a part with the passed mime type
and returns its parent.

Used for alternative mime types that have a multipart/mixed or
multipart/related child containing a content part of $mimeType, where
the whole mixed/related part should be removed.

param phpDocumentor\Reflection\Types\String_ $mimeType the content-type to find below $alternativePart
param phpDocumentor\Reflection\Types\Object_ $alternativePart The multipart/alternative part to look
under
return phpDocumentor\Reflection\Types\Compound false if a part is not found

public getUniqueBoundary( $mimeType)

Creates and returns a unique boundary.

param phpDocumentor\Reflection\Types\String_ $mimeType first 3 characters of a multipart type are used,
e.g. REL for relative or ALT for alternative
return phpDocumentor\Reflection\Types\String_

public moveAllNonMultiPartsToMessageExcept(ZBateson\MailMimeParser\IMessage $message, ZBateson\MailMimeParser\Message\IMimePart $from, $exceptMimeType)

Moves all parts under $from into this message except those with a
content-type equal to $exceptMimeType. If the message is not a
multipart/mixed message, it is set to multipart/mixed first.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\Object_ $from
param phpDocumentor\Reflection\Types\String_ $exceptMimeType

public removeAllContentPartsByMimeType(ZBateson\MailMimeParser\IMessage $message, $mimeType, $keepOtherContent = false)

Removes the content part of the message with the passed mime type. If
there is a remaining content part and it is an alternative part of the
main message, the content part is moved to the message part.

If the content part is part of an alternative part beneath the message,
the alternative part is replaced by the remaining content part,
optionally keeping other parts if $keepOtherContent is set to true.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\Boolean $keepOtherContent
return phpDocumentor\Reflection\Types\Boolean true on success

public removeAllContentPartsFromAlternative(ZBateson\MailMimeParser\IMessage $message, $mimeType, ZBateson\MailMimeParser\Message\IMimePart $alternativePart, $keepOtherContent)

Removes all parts of $mimeType from $alternativePart.

If $alternativePart contains a multipart/mixed or multipart/relative part
with other parts of different content-types, the multipart part is
removed, and parts of different content-types can optionally be moved to
the main message part.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\Object_ $alternativePart
param phpDocumentor\Reflection\Types\Boolean $keepOtherContent
return phpDocumentor\Reflection\Types\Boolean

public removePartByMimeType(ZBateson\MailMimeParser\IMessage $message, $mimeType, $index = 0)

Removes the 'inline' part with the passed contentType, at the given index
defaulting to the first

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\Integer $index
return phpDocumentor\Reflection\Types\Boolean true on success

public setContentPartForMimeType(ZBateson\MailMimeParser\IMessage $message, $mimeType, $stringOrHandle, $charset)

Either creates a mime part or sets the existing mime part with the passed
mimeType to $strongOrHandle.

param phpDocumentor\Reflection\Types\Object_ $message
param phpDocumentor\Reflection\Types\String_ $mimeType
param phpDocumentor\Reflection\Types\Compound $stringOrHandle
param phpDocumentor\Reflection\Types\String_ $charset

public setMessageAsAlternative(ZBateson\MailMimeParser\IMessage $message)

Sets the passed message as multipart/alternative.

If the message has content, a new part is created and added as a child of
the message. The message's content and content headers are moved to the
new part.

param phpDocumentor\Reflection\Types\Object_ $message

public setMessageAsMixed(ZBateson\MailMimeParser\IMessage $message)

Sets the passed message as multipart/mixed.

If the message has content, a new part is created and added as a child of
the message. The message's content and content headers are moved to the
new part.

param phpDocumentor\Reflection\Types\Object_ $message

public setMimeHeaderBoundaryOnPart(ZBateson\MailMimeParser\Message\IMimePart $part, $mimeType)

Creates a unique mime boundary and assigns it to the passed part's
Content-Type header with the passed mime type.

param phpDocumentor\Reflection\Types\Object_ $part
param phpDocumentor\Reflection\Types\String_ $mimeType

Properties

private $genericHelper

var phpDocumentor\Reflection\Types\Object_ a GenericHelper instance

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only