sendry 0.2.0

Official Rust crate for the Sendry email API
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! Inbound email handling.

use reqwest::Method;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::{client::Sendry, error::Error, Page, PaginationParams};

/// Inbound resource handle.
#[derive(Debug, Clone)]
pub struct Inbound {
    client: Sendry,
}

impl Inbound {
    pub(crate) fn new(client: Sendry) -> Self {
        Self { client }
    }

    /// List received inbound emails.
    pub async fn list(&self, params: PaginationParams) -> Result<Page<InboundEmail>, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(Method::GET, "/v1/inbound", &q, None))
            .await
    }

    /// Retrieve a single inbound email.
    pub async fn get(&self, id: &str) -> Result<InboundEmail, Error> {
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                &format!("/v1/inbound/{id}"),
                &[],
                None,
            ))
            .await
    }

    /// Get the inbound forwarding configuration.
    pub async fn get_config(&self) -> Result<InboundConfig, Error> {
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/inbound/config",
                &[],
                None,
            ))
            .await
    }

    /// Update the inbound forwarding configuration.
    pub async fn update_config(
        &self,
        params: UpdateInboundConfig,
    ) -> Result<InboundConfig, Error> {
        self.client
            .request(self.client.build(
                Method::PUT,
                "/v1/inbound/config",
                &[],
                Some(&params),
            ))
            .await
    }
}

/// One inbound email attachment.
#[derive(Debug, Clone, Deserialize)]
pub struct InboundEmailAttachment {
    /// File name.
    pub filename: String,
    /// MIME type.
    #[serde(rename = "contentType")]
    pub content_type: String,
    /// Size in bytes.
    pub size: u64,
    /// Optional inline content id.
    #[serde(rename = "contentId", default)]
    pub content_id: Option<String>,
}

/// Inbound email record.
#[derive(Debug, Clone, Deserialize)]
pub struct InboundEmail {
    /// Inbound email id.
    pub id: String,
    /// From address.
    pub from: String,
    /// To addresses.
    pub to: Vec<String>,
    /// CC addresses.
    #[serde(default)]
    pub cc: Vec<String>,
    /// Subject.
    pub subject: Option<String>,
    /// Plain-text body.
    pub text: Option<String>,
    /// HTML body.
    pub html: Option<String>,
    /// Raw headers.
    pub headers: Option<HashMap<String, String>>,
    /// Attachments.
    #[serde(default)]
    pub attachments: Vec<InboundEmailAttachment>,
    /// Whether webhook delivery succeeded.
    pub webhook_delivered: bool,
    /// Received timestamp.
    pub created_at: String,
}

/// Inbound forwarding configuration.
#[derive(Debug, Clone, Deserialize)]
pub struct InboundConfig {
    /// Forwarding URL.
    pub url: Option<String>,
    /// HMAC signing secret.
    pub secret: Option<String>,
}

/// Parameters for [`Inbound::update_config`].
#[derive(Debug, Clone, Serialize)]
pub struct UpdateInboundConfig {
    /// Forwarding URL (or `None` to disable).
    pub url: Option<String>,
    /// Optional HMAC signing secret.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub secret: Option<String>,
}