mailgen 0.4.2

Mailgen generates clean, responsive HTML and Text e-mails for sending transactional mail
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

use std::collections::HashMap;
use std::fmt::Display;

use serde::Serialize;

/// Email for rendering
#[derive(Debug, Clone, Serialize)]
pub struct Email<'a> {
    /// E-Mail summary, gets rendered in preview box on most email clients
    pub summary: Option<&'a str>,
    /// E-Mail greeting
    pub greeting: Option<Greeting<'a>>,
    /// Intro sentences, first displayed in the email
    pub intros: Option<Vec<&'a str>>,
    /// Highlighted text displayed prominently (e.g. OTP codes, verification tokens)
    pub highlight: Option<&'a str>,
    /// A list of key+value (useful for displaying parameters/settings/personal info)
    pub dictionary: Option<Vec<(&'a str, &'a str)>>,
    /// Table data to display in the email
    pub tables: Option<Vec<Table<'a>>>,
    /// Actions are a list of actions that the user will be able to execute via a button click
    pub actions: Option<Vec<Action<'a>>>,
    /// Outro sentences, last displayed in the email
    pub outros: Option<Vec<&'a str>>,
    /// Signature for the contacted person (default to 'Yours truly')
    pub signature: Option<&'a str>,
    /// Gmail Go-To Action for providing actionable content directly in the inbox
    pub go_to_action: Option<GoToAction<'a>>,
}

/// Column configuration for table
#[derive(Debug, Clone, Serialize)]
pub struct TableColumns<'a> {
    /// Custom width for specific columns
    pub custom_width: Option<HashMap<&'a str, &'a str>>,
    /// Custom alignment for specific columns
    pub custom_alignment: Option<HashMap<&'a str, &'a str>>,
}

/// Table data to display in the email
#[derive(Debug, Clone, Serialize)]
pub struct Table<'a> {
    /// Table title
    pub title: &'a str,
    /// Table data rows
    pub data: Vec<HashMap<&'a str, &'a str>>,
    /// Column configuration
    pub columns: Option<TableColumns<'a>>,
}

#[derive(Debug, Clone)]
pub enum Greeting<'a> {
    /// Displays a greeting by name. Renders as `Hey {name},`
    Name(&'a str),
    /// Custom greeting
    Custom(&'a str),
}

impl Display for Greeting<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Greeting::Name(name) => write!(f, "Hey {name},"),
            Greeting::Custom(custom) => f.write_str(custom),
        }
    }
}

impl Serialize for Greeting<'_> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.collect_str(self)
    }
}

/// Action is an action the user can do on the email (click on a button)
#[derive(Debug, Default, Clone, Serialize)]
pub struct Action<'a> {
    /// Button text
    pub text: &'a str,
    /// Button link
    pub link: &'a str,

    /// Text displayed before the button
    pub instructions: Option<&'a str>,
    /// Custom colors for the button in the format: (color, background-color)
    pub color: Option<(&'a str, &'a str)>,
}

/// Gmail Go-To Action for providing actionable content directly in the inbox
#[derive(Debug, Clone, Serialize)]
pub struct GoToAction<'a> {
    /// Button text
    pub text: &'a str,
    /// Button link
    pub link: &'a str,
    /// Description of the action
    pub description: &'a str,
}