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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
//! Deliverability — reputation, blocklists, full reports.

use reqwest::Method;
use serde::{Deserialize, Serialize};
use serde_json::Value;

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

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

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

    /// Reputation overview for the org or a specific domain.
    pub async fn get_reputation(
        &self,
        params: ReputationQuery,
    ) -> Result<ReputationResponse, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/deliverability/reputation",
                &q,
                None,
            ))
            .await
    }

    /// Per-domain reputation history (raw value, schema varies).
    pub async fn get_reputation_history(
        &self,
        domain_id: &str,
        params: ReputationHistoryQuery,
    ) -> Result<Value, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                &format!("/v1/deliverability/reputation/{domain_id}/history"),
                &q,
                None,
            ))
            .await
    }

    /// Blocklist status.
    pub async fn get_blocklist(&self, params: BlocklistQuery) -> Result<BlocklistResponse, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/deliverability/blocklist",
                &q,
                None,
            ))
            .await
    }

    /// On-demand blocklist check.
    pub async fn run_blocklist_check(&self, params: BlocklistCheckBody) -> Result<Value, Error> {
        self.client
            .request(self.client.build(
                Method::POST,
                "/v1/deliverability/blocklist/check",
                &[],
                Some(&params),
            ))
            .await
    }

    /// Dismiss a blocklist alert.
    pub async fn dismiss_alert(&self, alert_id: &str) -> Result<Value, Error> {
        #[derive(Serialize)]
        struct Body<'a> {
            status: &'a str,
        }
        self.client
            .request(self.client.build(
                Method::PATCH,
                &format!("/v1/deliverability/blocklist/alerts/{alert_id}"),
                &[],
                Some(&Body { status: "dismissed" }),
            ))
            .await
    }

    /// Full deliverability report.
    pub async fn get_report(
        &self,
        params: DeliverabilityReportQuery,
    ) -> Result<DeliverabilityReport, Error> {
        let q = params.to_query();
        self.client
            .request(self.client.build::<()>(
                Method::GET,
                "/v1/deliverability/report",
                &q,
                None,
            ))
            .await
    }
}

/// Reputation query parameters.
#[derive(Debug, Clone, Default)]
pub struct ReputationQuery {
    /// Optional domain filter.
    pub domain_id: Option<String>,
    /// Window in days (1–90).
    pub days: Option<u32>,
}

impl ReputationQuery {
    fn to_query(&self) -> Vec<(&'static str, String)> {
        let mut q = Vec::new();
        if let Some(v) = &self.domain_id {
            q.push(("domain_id", v.clone()));
        }
        if let Some(v) = self.days {
            q.push(("days", v.to_string()));
        }
        q
    }
}

/// Reputation history query parameters.
#[derive(Debug, Clone, Default)]
pub struct ReputationHistoryQuery {
    /// ISO date.
    pub from: Option<String>,
    /// ISO date.
    pub to: Option<String>,
}

impl ReputationHistoryQuery {
    fn to_query(&self) -> Vec<(&'static str, String)> {
        let mut q = Vec::new();
        if let Some(v) = &self.from {
            q.push(("from", v.clone()));
        }
        if let Some(v) = &self.to {
            q.push(("to", v.clone()));
        }
        q
    }
}

/// One reputation snapshot.
#[derive(Debug, Clone, Deserialize)]
pub struct ReputationSnapshot {
    /// Date.
    pub date: String,
    /// Sent.
    pub total_sent: u64,
    /// Delivered.
    pub total_delivered: u64,
    /// Bounced.
    pub total_bounced: u64,
    /// Complained.
    pub total_complained: u64,
    /// Opened.
    pub total_opened: u64,
    /// Clicked.
    pub total_clicked: u64,
    /// Delivery rate.
    pub delivery_rate: f64,
    /// Bounce rate.
    pub bounce_rate: f64,
    /// Complaint rate.
    pub complaint_rate: f64,
    /// Open rate.
    pub open_rate: f64,
    /// Click rate.
    pub click_rate: f64,
    /// Reputation score 0–100.
    pub reputation_score: f64,
}

/// Reputation factors.
#[derive(Debug, Clone, Deserialize)]
pub struct ReputationFactors {
    /// Bounce rate.
    #[serde(rename = "bounceRate")]
    pub bounce_rate: f64,
    /// Complaint rate.
    #[serde(rename = "complaintRate")]
    pub complaint_rate: f64,
    /// Delivery rate.
    #[serde(rename = "deliveryRate")]
    pub delivery_rate: f64,
    /// Engagement rate.
    #[serde(rename = "engagementRate")]
    pub engagement_rate: f64,
}

/// Current reputation.
#[derive(Debug, Clone, Deserialize)]
pub struct ReputationCurrent {
    /// Score 0–100.
    pub score: f64,
    /// Bucketed rating.
    pub rating: String,
    /// Contributing factors.
    pub factors: ReputationFactors,
    /// Recommendations.
    pub recommendations: Vec<String>,
}

/// Per-domain reputation.
#[derive(Debug, Clone, Deserialize)]
pub struct ReputationDomain {
    /// Domain id.
    pub domain_id: String,
    /// Domain name.
    pub domain_name: String,
    /// Score 0–100.
    pub score: f64,
    /// Rating.
    pub rating: String,
}

/// Reputation response.
#[derive(Debug, Clone, Deserialize)]
pub struct ReputationResponse {
    /// Current snapshot.
    pub current: ReputationCurrent,
    /// History.
    pub history: Vec<ReputationSnapshot>,
    /// Per-domain breakdown.
    pub domains: Vec<ReputationDomain>,
}

/// Blocklist query parameters.
#[derive(Debug, Clone, Default)]
pub struct BlocklistQuery {
    /// Target filter.
    pub target: Option<String>,
    /// `domain` or `ip`.
    pub target_type: Option<String>,
}

impl BlocklistQuery {
    fn to_query(&self) -> Vec<(&'static str, String)> {
        let mut q = Vec::new();
        if let Some(v) = &self.target {
            q.push(("target", v.clone()));
        }
        if let Some(v) = &self.target_type {
            q.push(("target_type", v.clone()));
        }
        q
    }
}

/// Body for [`Deliverability::run_blocklist_check`].
#[derive(Debug, Clone, Serialize)]
pub struct BlocklistCheckBody {
    /// Target (domain or IP).
    pub target: String,
    /// `domain` or `ip`.
    pub target_type: String,
}

/// One blocklist check.
#[derive(Debug, Clone, Deserialize)]
pub struct BlocklistCheckItem {
    /// Row id.
    pub id: String,
    /// Target.
    pub target: String,
    /// `domain` or `ip`.
    pub target_type: String,
    /// Provider (Spamhaus, etc).
    pub provider: String,
    /// Whether listed.
    pub listed: bool,
    /// Listing reason if listed.
    pub listing_reason: Option<String>,
    /// Response time.
    pub response_time_ms: Option<u32>,
    /// Check timestamp.
    pub checked_at: String,
}

/// One blocklist alert.
#[derive(Debug, Clone, Deserialize)]
pub struct BlocklistAlertItem {
    /// Alert id.
    pub id: String,
    /// Target.
    pub target: String,
    /// `domain` or `ip`.
    pub target_type: String,
    /// Provider.
    pub provider: String,
    /// Alert status.
    pub status: String,
    /// Listing date.
    pub listed_at: String,
    /// Resolved date if any.
    pub resolved_at: Option<String>,
}

/// Summary counts.
#[derive(Debug, Clone, Deserialize)]
pub struct BlocklistSummary {
    /// Total targets.
    pub total_targets: u32,
    /// Listed count.
    pub listed_count: u32,
    /// Clean count.
    pub clean_count: u32,
}

/// Blocklist response.
#[derive(Debug, Clone, Deserialize)]
pub struct BlocklistResponse {
    /// Per-provider checks.
    pub checks: Vec<BlocklistCheckItem>,
    /// Open alerts.
    pub alerts: Vec<BlocklistAlertItem>,
    /// Summary counts.
    pub summary: BlocklistSummary,
}

/// Report query parameters.
#[derive(Debug, Clone, Default)]
pub struct DeliverabilityReportQuery {
    /// Optional domain filter.
    pub domain_id: Option<String>,
    /// Window in days (7–90).
    pub days: Option<u32>,
}

impl DeliverabilityReportQuery {
    fn to_query(&self) -> Vec<(&'static str, String)> {
        let mut q = Vec::new();
        if let Some(v) = &self.domain_id {
            q.push(("domain_id", v.clone()));
        }
        if let Some(v) = self.days {
            q.push(("days", v.to_string()));
        }
        q
    }
}

/// Report period.
#[derive(Debug, Clone, Deserialize)]
pub struct ReportPeriod {
    /// ISO date.
    pub from: String,
    /// ISO date.
    pub to: String,
    /// Days.
    pub days: u32,
}

/// Report aggregate metrics.
#[derive(Debug, Clone, Deserialize)]
pub struct ReportMetrics {
    /// Sent count.
    pub total_sent: u64,
    /// Delivered count.
    pub total_delivered: u64,
    /// Bounced count.
    pub total_bounced: u64,
    /// Complained count.
    pub total_complained: u64,
    /// Delivery rate.
    pub delivery_rate: f64,
    /// Bounce rate.
    pub bounce_rate: f64,
    /// Complaint rate.
    pub complaint_rate: f64,
    /// Open rate.
    pub open_rate: f64,
    /// Click rate.
    pub click_rate: f64,
}

/// Report reputation summary.
#[derive(Debug, Clone, Deserialize)]
pub struct ReportReputation {
    /// Score 0–100.
    pub score: f64,
    /// Rating.
    pub rating: String,
    /// `up`, `down`, or `stable`.
    pub trend: String,
}

/// Blocklist status block.
#[derive(Debug, Clone, Deserialize)]
pub struct ReportBlocklistStatus {
    /// Number of lists checked.
    pub total_lists_checked: u32,
    /// Active listings.
    pub active_listings: u32,
    /// Whether currently clean.
    pub clean: bool,
}

/// Inbox placement estimate.
#[derive(Debug, Clone, Deserialize)]
pub struct InboxPlacementEstimate {
    /// Inbox percentage.
    pub inbox_pct: f64,
    /// Spam folder percentage.
    pub spam_pct: f64,
    /// Missing percentage.
    pub missing_pct: f64,
}

/// Authentication setup.
#[derive(Debug, Clone, Deserialize)]
pub struct AuthenticationStatus {
    /// SPF.
    pub spf: bool,
    /// DKIM.
    pub dkim: bool,
    /// DMARC.
    pub dmarc: bool,
    /// BIMI.
    pub bimi: bool,
}

/// Full deliverability report.
#[derive(Debug, Clone, Deserialize)]
pub struct DeliverabilityReport {
    /// Period.
    pub period: ReportPeriod,
    /// Aggregate metrics.
    pub metrics: ReportMetrics,
    /// Reputation summary.
    pub reputation: ReportReputation,
    /// Blocklist summary.
    pub blocklist_status: ReportBlocklistStatus,
    /// Inbox placement.
    pub inbox_placement_estimate: InboxPlacementEstimate,
    /// Recommendations.
    pub recommendations: Vec<String>,
    /// Authentication.
    pub authentication: AuthenticationStatus,
}