#Script Pages

<back to all web services

PreviewHtmlEmail

The following routes are available for this service:
All Verbs/emails/order-confirmation/preview
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class PreviewHtmlEmailResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $htmlEmail=null,
        /** @var string|null */
        public ?string $textEmail=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['htmlEmail'])) $this->htmlEmail = $o['htmlEmail'];
        if (isset($o['textEmail'])) $this->textEmail = $o['textEmail'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->htmlEmail)) $o['htmlEmail'] = $this->htmlEmail;
        if (isset($this->textEmail)) $o['textEmail'] = $this->textEmail;
        return empty($o) ? new class(){} : $o;
    }
}

class PreviewHtmlEmail implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $emailTemplate=null,
        /** @var string|null */
        public ?string $htmlTemplate=null,
        /** @var string|null */
        public ?string $previewCustomerId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['emailTemplate'])) $this->emailTemplate = $o['emailTemplate'];
        if (isset($o['htmlTemplate'])) $this->htmlTemplate = $o['htmlTemplate'];
        if (isset($o['previewCustomerId'])) $this->previewCustomerId = $o['previewCustomerId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->emailTemplate)) $o['emailTemplate'] = $this->emailTemplate;
        if (isset($this->htmlTemplate)) $o['htmlTemplate'] = $this->htmlTemplate;
        if (isset($this->previewCustomerId)) $o['previewCustomerId'] = $this->previewCustomerId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PreviewHtmlEmail DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /emails/order-confirmation/preview HTTP/1.1 
Host: sharpscript.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"emailTemplate":"String","htmlTemplate":"String","previewCustomerId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"htmlEmail":"String","textEmail":"String"}