\Pop\Mail\MessagePart

Message part object class

Summary

Methods
Properties
Constants
__construct()
createFromJson()
createFromSerialized()
count()
getIterator()
jsonSerialize()
jsonUnserialize()
serialize()
unserialize()
__set()
__get()
__isset()
__unset()
offsetSet()
offsetGet()
offsetExists()
offsetUnset()
toArray()
parse()
parseParts()
No public properties found
No constants found
No protected methods found
$data
N/A
No private methods found
No private properties found
N/A

Properties

$data

$data : array

Array data

Type

array

Methods

__construct()

__construct(mixed  $data = null) 

Constructor

Instantiate the array object

Parameters

mixed $data

Throws

\Pop\Utils\Exception

createFromJson()

createFromJson(string  $jsonString, integer  $depth = 512, integer  $options) : \Pop\Utils\ArrayObject

Create array object from JSON string

Parameters

string $jsonString
integer $depth
integer $options

Returns

\Pop\Utils\ArrayObject

createFromSerialized()

createFromSerialized(string  $string) : \Pop\Utils\ArrayObject

Create array object from serialized string

Parameters

string $string

Returns

\Pop\Utils\ArrayObject

count()

count() : integer

Method to get the count of the array object

Returns

integer

getIterator()

getIterator() : \ArrayIterator

Method to iterate over the array object

Returns

\ArrayIterator

jsonSerialize()

jsonSerialize(integer  $options, integer  $depth = 512) : string

JSON serialize the array object

Parameters

integer $options
integer $depth

Returns

string

jsonUnserialize()

jsonUnserialize(string  $jsonString, integer  $depth = 512, integer  $options) : \Pop\Utils\ArrayObject

Unserialize a JSON string

Parameters

string $jsonString
integer $depth
integer $options

Returns

\Pop\Utils\ArrayObject

serialize()

serialize(boolean  $self = false) : string

Serialize the array object

Parameters

boolean $self

Returns

string

unserialize()

unserialize(string  $string) : \Pop\Utils\ArrayObject

Unserialize a string

Parameters

string $string

Throws

\Pop\Utils\Exception

Returns

\Pop\Utils\ArrayObject

__set()

__set(string  $name, mixed  $value) : \Pop\Utils\ArrayObject

Set a value

Parameters

string $name
mixed $value

Returns

\Pop\Utils\ArrayObject

__get()

__get(string  $name) : mixed

Get a value

Parameters

string $name

Returns

mixed

__isset()

__isset(string  $name) : boolean

Is value set

Parameters

string $name

Returns

boolean

__unset()

__unset(string  $name) : void

Unset a value

Parameters

string $name

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : void

ArrayAccess offsetSet

Parameters

mixed $offset
mixed $value

offsetGet()

offsetGet(mixed  $offset) : mixed

ArrayAccess offsetGet

Parameters

mixed $offset

Returns

mixed

offsetExists()

offsetExists(mixed  $offset) : boolean

ArrayAccess offsetExists

Parameters

mixed $offset

Returns

boolean

offsetUnset()

offsetUnset(mixed  $offset) : void

ArrayAccess offsetUnset

Parameters

mixed $offset

toArray()

toArray() : array

Get the values as an array

Returns

array

parse()

parse(mixed  $body, string  $boundary = null) : array

Parse message parts from string

Parameters

mixed $body
string $boundary

Returns

array

parseParts()

parseParts(array  $parts) : array

Parse message parts from array of parts

Parameters

array $parts

Returns

array