Plentymarkets interface documentation

Templates

Contracts

MailTemplateWidgetRepositoryContract

Register mail builder widgets.

Namespace

Plenty\Modules\Mail\Templates\Contracts

Methods
public registerWidget($widgetClass):void

Register a widget to be available in the mail builder.

Parameters

Name

Type

Description

$widgetClass

string

public overrideWidget($widgetIdentifier, $overrideWidget):void

Override a widget class to extend data or settings of the widget.

Parameters

Name

Type

Description

$widgetIdentifier

string

The identifier of the original widget to override

$overrideWidget

string

The class of the new class to get information of the widget from.

Models

Templates

MailTemplateAttachments

The MailTemplateAttachments model. Stores the relation between * mail templates - static attachments

Namespace

Plenty\Modules\Mail\Templates\Models\Templates

Properties
Name Type Description

relationId

int

plenty_mail_template_relation_id

documentId

int

plenty_documents.id // static attachment document id; optional FK plenty_documents

createdAt

The time the attachment was created as unix timestamp

updatedAt

The time the attachment was last updated as unix timestamp

configId

int

plenty_mail_template_base_config.id // mail template id; required

isStaticDoc

bool

The reference type. The following reference types are available; required <ul> <li>0</li> // is dynamic <li>1</li> // is static </ul>

dynamicAttachmentId

string

Methods
public toArray()

Returns this model as an array.