Struct RenderOptions

pub struct RenderOptions {
    pub template: String,
    pub version_id: Option<String>,
    pub template_data: HashMap<String, Value>,
    pub strict: bool,
    pub locale: Option<String>,
}

Options for rendering an email template without sending it.

This struct is used with the render API endpoint to preview how a template will look with specific data. This is useful for testing templates and generating email content for use in other systems.

Examples

use send_with_us::types::RenderOptions;
use std::collections::HashMap;
use serde_json::json;

let mut template_data = HashMap::new();
template_data.insert("name".to_string(), json!("John"));
template_data.insert("order_id".to_string(), json!("12345"));

let options = RenderOptions {
  template: "template-id".to_string(),
  version_id: Some("version-id".to_string()),
  template_data,
  strict: true,
  locale: Some("en-US".to_string()),
};

Fields

template: String

ID of the template to render

version_id: Option<String>

Optional specific version of the template to render

template_data: HashMap<String, Value>

Data to use when rendering template variables

strict: bool

Whether to use strict mode for variable replacement (error on missing variables vs. leaving them as is)

locale: Option<String>

Locale for template internationalization

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RenderOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RenderOptions

fn eq(&self, other: &RenderOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RenderOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RenderOptions