Rust邮件模板处理库mrml的使用指南

mrml是一个高效的Rust库，专门用于处理MJML(邮件标记语言)模板，将其解析并渲染为HTML格式的电子邮件内容。MJML是一种简化响应式电子邮件开发的标记语言，而mrml提供了Rust生态中处理MJML的最佳解决方案。

主要特性

• 完整的MJML规范支持
• 高性能的解析和渲染
• 支持自定义组件
• 类型安全的API设计
• 良好的错误处理

安装方法

在Cargo.toml中添加依赖：

[dependencies]
mrml = "0.10"  # 请使用最新版本

基本使用方法

1. 将MJML转换为HTML

use mrml::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mjml = r#"
        <mjml>
            <mj-body>
                <mj-section>
                    <mj-column>
                        <mj-text>Hello World!</mj-text>
                    </mj-column>
                </mj-section>
            </mj-body>
        </mjml>
    "#;
    
    let template = mrml::parse(mjml)?;
    let html = template.render()?;
    println!("{}", html);
    Ok(())
}

2. 使用自定义选项

use mrml::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let opts = mrml::Options {
        disable_comments: true,
        social_icon_origin: Some("https://example.com".to_string()),
        ..Default::default()
    };
    
    let mjml = r#"
        <mjml>
            <mj-body>
                <mj-social>
                    <mj-social-element name="twitter" href="https://twitter.com/example" />
                </mj-social>
            </mj-body>
        </mjml>
    "#;
    
    let template = mrml::parse_with_options(mjml, opts)?;
    let html = template.render()?;
    println!("{}", html);
    Ok(())
}

3. 错误处理

use mrml::prelude::*;

fn main() {
    let invalid_mjml = r#"<mjml><mj-body><mj-text></mj-text></mj-body></mjml>"#;
    
    match mrml::parse(invalid_mjml) {
        Ok(template) => {
            match template.render() {
                Ok(html) => println!("{}", html),
                Err(e) => eprintln!("渲染错误: {}", e),
            }
        },
        Err(e) => eprintln!("解析错误: {}", e),
    }
}

高级用法

自定义组件

use mrml::prelude::*;
use mrml::mj_body::MjBody;
use mrml::mj_section::MjSection;
use mrml::mj_column::MjColumn;
use mrml::mj_text::MjText;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut body = MjBody::default();
    let mut section = MjSection::default();
    let mut column = MjColumn::default();
    let mut text = MjText::new("Hello from programmatic MJML!");
    
    column.children.push(text.into());
    section.children.push(column.into());
    body.children.push(section.into());
    
    let template = mrml::Mjml::from(body);
    let html = template.render()?;
    println!("{}", html);
    Ok(())
}

处理部分模板

use mrml::prelude::*;

fn render_email_template(content: &str) -> Result<String, Box<dyn std::error::Error>> {
    let mjml = format!(r#"
        <mjml>
            <mj-body>
                <mj-section>
                    <mj-column>
                        {}
                    </mj-column>
                </mj-section>
            </mj-body>
        </mjml>
    "#, content);
    
    let template = mrml::parse(&mjml)?;
    template.render().map_err(|e| e.into())
}

性能建议

1. 对于重复使用的模板，解析一次然后多次渲染
2. 考虑缓存渲染结果
3. 在可能的情况下重用模板实例

mrml是构建电子邮件发送服务的理想选择，特别是需要处理复杂响应式邮件模板的Rust应用程序。

完整示例demo

下面是一个完整的示例，展示了如何使用mrml库构建一个简单的邮件模板系统：

use mrml::prelude::*;
use std::error::Error;

// 定义邮件模板结构体
pub struct EmailTemplate {
    header: String,
    content: String,
    footer: String,
}

impl EmailTemplate {
    // 创建新模板
    pub fn new(header: &str, content: &str, footer: &str) -> Self {
        Self {
            header: header.to_string(),
            content: content.to_string(),
            footer: footer.to_string(),
        }
    }

    // 渲染完整的MJML模板
    pub fn render(&self) -> Result<String, Box<dyn Error>> {
        let mjml = format!(
            r#"
            <mjml>
                <mj-body>
                    <mj-section>
                        <mj-column>
                            {}
                        </mj-column>
                    </mj-section>
                    <mj-section>
                        <mj-column>
                            {}
                        </mj-column>
                    </mj-section>
                    <mj-section>
                        <mj-column>
                            {}
                        </mj-column>
                    </mj-section>
                </mj-body>
            </mjml>
            "#,
            self.header, self.content, self.footer
        );

        let template = mrml::parse(&mjml)?;
        template.render().map_err(|e| e.into())
    }
}

fn main() -> Result<(), Box<dyn Error>> {
    // 创建模板实例
    let template = EmailTemplate::new(
        "<mj-text>欢迎使用我们的服务</mj-text>",
        "<mj-text>这是一封测试邮件内容</mj-text>",
        "<mj-text>© 2023 公司名称</mj-text>",
    );

    // 渲染邮件
    let html = template.render()?;
    println!("渲染结果:\n{}", html);

    Ok(())
}

这个完整示例展示了如何：

1. 定义一个结构体来封装邮件模板
2. 组织邮件的各个部分（页眉、内容、页脚）
3. 使用mrml库将MJML模板渲染为HTML
4. 处理可能的错误

您可以根据需要扩展这个基础实现，添加更复杂的模板逻辑或自定义组件。