#Script Pages

<back to all web services

PreviewHtmlEmail

The following routes are available for this service:
All Verbs/emails/order-confirmation/preview
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PreviewHtmlEmailResponse:
    html_email: Optional[str] = None
    text_email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PreviewHtmlEmail:
    email_template: Optional[str] = None
    html_template: Optional[str] = None
    preview_customer_id: Optional[str] = None

Python PreviewHtmlEmail DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<PreviewHtmlEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
  <EmailTemplate>String</EmailTemplate>
  <HtmlTemplate>String</HtmlTemplate>
  <PreviewCustomerId>String</PreviewCustomerId>
</PreviewHtmlEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PreviewHtmlEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
  <HtmlEmail>String</HtmlEmail>
  <TextEmail>String</TextEmail>
</PreviewHtmlEmailResponse>