Class EmailJsonSerializer

Class EmailsJsonSerializer

This class will serialize and deserialize an email entity. It can be used into many places where PHP interacts with external requests such as AJAX or API communication.

AbstractJsonSerializer implements SerializerInterface

EmailJsonSerializer

Package: Extensions\Serializers
Category: System
Located at Extensions/Serializers/EmailJsonSerializer.inc.php

Methods summary

`public string\|array`	# `serialize( EmailInterface $object, boolean $encode = true )` Serialize email object (from Email instance to json string) Serialize email object (from Email instance to json string) Parameters `$object` Contains the email data. `$encode` (optional) Whether to json_encode the result of the method (default true). Sometimes it might be required to encode an array of multiple email records together and not one by one. Returns string\|array
`public EmailInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize email JSON string. Deserialize email JSON string. Parameters `$string` JSON string that contains the data of the email. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `EmailInterface` Returns the deserialized Email object. Throws InvalidArgumentException If the argument is not a string or is empty.
`protected array`	# `_serializeContact( EmailContactInterface $contact )` Serialize EmailContact Serialize EmailContact Parameters `$contact` Returns array
`protected EmailContact`	# `_deserializeContact( stdClass $contact, $type )` Deserialize EmailContact Deserialize EmailContact Parameters `$contact` `$type` Returns `EmailContact`
`protected array`	# `_serializeAttachment( EmailAttachmentInterface $attachment )` Serialize EmailAttachment Serialize EmailAttachment Parameters `$attachment` Returns array
`protected EmailAttachment`	# `_deserializeAttachment( stdClass $attachment )` Deserialize EmailAttachment Deserialize EmailAttachment Parameters `$attachment` Returns `EmailAttachment`

Methods inherited from AbstractJsonSerializer

__construct(), _deserializeAddonValues(), _deserializeLanguageSpecificProperty(), _serializeAddonValues(), _serializeLanguageSpecificProperty(), jsonEncode()

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces

Class EmailJsonSerializer

Methods summary

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from AbstractJsonSerializer

Properties summary

Properties inherited from AbstractJsonSerializer