postmark 2.0.0

Postmark rust client
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

# Postmark endpoint coverage

Scope: endpoints represented in this crate.

Legend:

- `x` implemented
- `-` not implemented
- `deprecated` intentionally excluded

## Email

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| POST | `/email` | server | x | `api::email::SendEmailRequest` |
| POST | `/email/batch` | server | x | `api::email::SendEmailBatchRequest` |
| POST | `/email/withTemplate` | server | x | `api::email::SendEmailWithTemplateRequest` |
| POST | `/email/batchWithTemplates` | server | x | `api::email::SendEmailBatchWithTemplatesRequest` |

## Bulk

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| POST | `/email/bulk` | server | x | `api::bulk::SendBulkEmailRequest` |
| GET | `/email/bulk/{id}` | server | x | `api::bulk::GetBulkStatusRequest` |

## Bounce

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/deliverystats` | server | x | `api::bounce::GetDeliveryStatsRequest` |
| GET | `/bounces` | server | x | `api::bounce::ListBouncesRequest` |
| GET | `/bounces/{id}` | server | x | `api::bounce::GetBounceRequest` |
| GET | `/bounces/{id}/dump` | server | x | `api::bounce::GetBounceDumpRequest` |
| PUT | `/bounces/{id}/activate` | server | x | `api::bounce::ActivateBounceRequest` |

## Templates

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/templates/{id}` | server | x | `api::templates::GetTemplateRequest` |
| POST | `/templates` | server | x | `api::templates::CreateTemplateRequest` |
| PUT | `/templates/{id}` | server | x | `api::templates::EditTemplateRequest` |
| GET | `/templates?count={count}&offset={offset}` | server | x | `api::templates::ListTemplatesRequest` |
| DELETE | `/templates/{id}` | server | x | `api::templates::DeleteTemplateRequest` |
| POST | `/templates/validate` | server | x | `api::templates::ValidateTemplateRequest` |
| PUT | `/templates/push` | server | x | `api::templates::PushTemplatesRequest` |

## Server / Servers

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/server` | server | x | `api::server::GetCurrentServerRequest` |
| PUT | `/server` | server | x | `api::server::EditServerRequest` |
| GET | `/servers/{id}` | account | x | `api::server::GetServerRequest` |
| POST | `/servers` | account | x | `api::server::CreateServerRequest` |
| PUT | `/servers/{id}` | account | x | `api::server::EditServerByIdRequest` |
| GET | `/servers?count={count}&offset={offset}` | account | x | `api::server::ListServersRequest` |
| DELETE | `/servers/{id}` | account | x | `api::server::DeleteServerRequest` |

## Message Streams / Suppressions

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/message-streams` | server | x | `api::message_streams::ListMessageStreamsRequest` |
| GET | `/message-streams/{id}` | server | x | `api::message_streams::GetMessageStreamRequest` |
| PATCH | `/message-streams/{id}` | server | x | `api::message_streams::EditMessageStreamRequest` |
| POST | `/message-streams` | server | x | `api::message_streams::CreateMessageStreamRequest` |
| POST | `/message-streams/{id}/archive` | server | x | `api::message_streams::ArchiveMessageStreamRequest` |
| POST | `/message-streams/{id}/unarchive` | server | x | `api::message_streams::UnarchiveMessageStreamRequest` |
| GET | `/message-streams/{id}/suppressions/dump` | server | x | `api::message_streams::GetSuppressionsRequest` |
| POST | `/message-streams/{id}/suppressions` | server | x | `api::message_streams::CreateSuppressionRequest` |
| PUT | `/message-streams/{id}/suppressions/{email}` | server | x | `api::message_streams::DeleteSuppressionRequest` |

## Domains

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/domains` | account | x | `api::domains::ListDomainsRequest` |
| GET | `/domains/{id}` | account | x | `api::domains::GetDomainRequest` |
| POST | `/domains` | account | x | `api::domains::CreateDomainRequest` |
| PUT | `/domains/{id}` | account | x | `api::domains::EditDomainRequest` |
| DELETE | `/domains/{id}` | account | x | `api::domains::DeleteDomainRequest` |
| POST | `/domains/{id}/verifyDKIM` | account | x | `api::domains::VerifyDkimRequest` |
| POST | `/domains/{id}/verifyreturnpath` | account | x | `api::domains::VerifyReturnPathRequest` |
| POST | `/domains/{id}/verifyspf` | account | x | `api::domains::VerifySpfRequest` |
| POST | `/domains/{id}/rotatedkim` | account | x | `api::domains::RotateDkimRequest` |

## Sender signatures

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/senders?count={count}&offset={offset}` | account | x | `api::signatures::ListSignaturesRequest` |
| GET | `/senders/{id}` | account | x | `api::signatures::GetSignatureRequest` |
| POST | `/senders` | account | x | `api::signatures::CreateSignatureRequest` |
| PUT | `/senders/{id}` | account | x | `api::signatures::EditSignatureRequest` |
| DELETE | `/senders/{id}` | account | x | `api::signatures::DeleteSignatureRequest` |
| POST | `/senders/{id}/resend` | account | x | `api::signatures::ResendSignatureConfirmationRequest` |
| POST | `/senders/{id}/verifyspf` | account | deprecated | - |
| POST | `/senders/{id}/requestnewdkim` | account | deprecated | - |

## Stats

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/stats/outbound` | server | x | `api::stats::GetOutboundOverviewRequest` |
| GET | `/stats/outbound/sends` | server | x | `api::stats::GetSentCountsRequest` |
| GET | `/stats/outbound/bounces` | server | x | `api::stats::GetBounceCountsRequest` |
| GET | `/stats/outbound/spam` | server | x | `api::stats::GetSpamComplaintsRequest` |
| GET | `/stats/outbound/tracked` | server | x | `api::stats::GetTrackedEmailCountsRequest` |
| GET | `/stats/outbound/opens` | server | x | `api::stats::GetEmailOpenCountsRequest` |
| GET | `/stats/outbound/opens/platforms` | server | x | `api::stats::GetEmailPlatformUsageRequest` |
| GET | `/stats/outbound/opens/emailclients` | server | x | `api::stats::GetEmailClientUsageRequest` |
| GET | `/stats/outbound/clicks` | server | x | `api::stats::GetClickCountsRequest` |
| GET | `/stats/outbound/clicks/browserfamilies` | server | x | `api::stats::GetBrowserUsageRequest` |
| GET | `/stats/outbound/clicks/platforms` | server | x | `api::stats::GetBrowserPlatformUsageRequest` |
| GET | `/stats/outbound/clicks/location` | server | x | `api::stats::GetClickLocationRequest` |

## Triggers: inbound rules

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/triggers/inboundrules?count={count}&offset={offset}` | server | x | `api::triggers::ListInboundRuleTriggersRequest` |
| POST | `/triggers/inboundrules` | server | x | `api::triggers::CreateInboundRuleTriggerRequest` |
| DELETE | `/triggers/inboundrules/{id}` | server | x | `api::triggers::DeleteInboundRuleTriggerRequest` |

## Webhooks

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/webhooks` | server | x | `api::webhooks::ListWebhooksRequest` |
| GET | `/webhooks/{id}` | server | x | `api::webhooks::GetWebhookRequest` |
| POST | `/webhooks` | server | x | `api::webhooks::CreateWebhookRequest` |
| PUT | `/webhooks/{id}` | server | x | `api::webhooks::EditWebhookRequest` |
| DELETE | `/webhooks/{id}` | server | x | `api::webhooks::DeleteWebhookRequest` |

## Data removal

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| POST | `/data-removals` | account | x | `api::data_removal::CreateDataRemovalRequest` |
| GET | `/data-removals/{id}` | account | x | `api::data_removal::GetDataRemovalStatusRequest` |

## Messages

| Method | Path | Token | Status | Rust request type |
|---|---|---|---|---|
| GET | `/messages/outbound` | server | x | `api::messages::OutboundSearchRequest` |
| GET | `/messages/outbound/{messageid}/details` | server | x | `api::messages::OutboundDetailsRequest` |
| GET | `/messages/outbound/{messageid}/dump` | server | x | `api::messages::OutboundDumpRequest` |
| GET | `/messages/inbound` | server | x | `api::messages::InboundSearchRequest` |
| GET | `/messages/inbound/{messageid}/details` | server | x | `api::messages::InboundDetailsRequest` |
| PUT | `/messages/inbound/{messageid}/bypass` | server | x | `api::messages::BypassBlockedInboundRequest` |
| PUT | `/messages/inbound/{messageid}/retry` | server | x | `api::messages::RetryFailedInboundRequest` |
| GET | `/messages/outbound/opens` | server | x | `api::messages::MessageOpensRequest` |
| GET | `/messages/outbound/opens/{messageid}` | server | x | `api::messages::SingleMessageOpensRequest` |
| GET | `/messages/outbound/clicks` | server | x | `api::messages::MessageClicksRequest` |
| GET | `/messages/outbound/clicks/{messageid}` | server | x | `api::messages::SingleMessageClicksRequest` |