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
use crate::Client;
use crate::ClientResult;
pub struct SenderVerification {
pub client: Client,
}
impl SenderVerification {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
SenderVerification { client }
}
/**
* Domain Warn List.
*
* This function performs a `GET` to the `/verified_senders/domains` endpoint.
*
* **This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type — hard failure or soft failure**.
*
* Domains listed as hard failures will not deliver mail when used as a [Sender Identity](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/) due to the domain's DMARC policy settings.
*
* For example, using a `yahoo.com` email address as a Sender Identity will likely result in the rejection of your mail. For more information about DMARC, see [Everything about DMARC](https://sendgrid.com/docs/ui/sending-email/dmarc/).
*/
pub async fn get_verified_senders_domains(
&self,
) -> ClientResult<crate::Response<crate::types::GetVerifiedSendersDomainsResponse>> {
let url = self.client.url("/verified_senders/domains", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Completed Steps.
*
* This function performs a `GET` to the `/verified_senders/steps_completed` endpoint.
*
* **This endpoint allows you to determine which of SendGrid’s verification processes have been completed for an account**.
*
* This endpoint returns boolean values, `true` and `false`, for [Domain Authentication](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/#domain-authentication), `domain_verified`, and [Single Sender Verification](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/#single-sender-verification), `sender_verified`, for the account.
*
* An account may have one, both, or neither verification steps completed. If you need to authenticate a domain rather than a Single Sender, see the "Authenticate a domain" endpoint.
*/
pub async fn get_verified_senders_steps_completed(
&self,
) -> ClientResult<crate::Response<crate::types::GetVerifiedSendersStepsCompletedResponse>> {
let url = self.client.url("/verified_senders/steps_completed", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get All Verified Senders.
*
* This function performs a `GET` to the `/verified_senders` endpoint.
*
* **This endpoint allows you to retrieve all the Sender Identities associated with an account.**
*
* This endpoint will return both verified and unverified senders.
*
* You can limit the number of results returned using the `limit`, `lastSeenID`, and `id` query string parameters.
*
* * `limit` allows you to specify an exact number of Sender Identities to return.
* * `lastSeenID` will return senders with an ID number occuring after the passed in ID. In other words, the `lastSeenID` provides a starting point from which SendGrid will iterate to find Sender Identities associated with your account.
* * `id` will return information about only the Sender Identity passed in the request.
*
* **Parameters:**
*
* * `limit: f64` -- The number of errors found while adding recipients.
* * `last_seen_id: f64` -- The number of errors found while adding recipients.
* * `id: i64`
*/
pub async fn get_verified_senders(
&self,
limit: f64,
last_seen_id: f64,
id: i64,
) -> ClientResult<crate::Response<crate::types::GetVerifiedSendersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if id > 0 {
query_args.push(("id".to_string(), id.to_string()));
}
if !last_seen_id.to_string().is_empty() {
query_args.push(("lastSeenID".to_string(), last_seen_id.to_string()));
}
if !limit.to_string().is_empty() {
query_args.push(("limit".to_string(), limit.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/verified_senders?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create Verified Sender Request.
*
* This function performs a `POST` to the `/verified_senders` endpoint.
*
* **This endpoint allows you to create a new Sender Identify**.
*
* Upon successful submission of a `POST` request to this endpoint, an identity will be created, and a verification email will be sent to the address assigned to the `from_email` field. You must complete the verification process using the sent email to fully verify the sender.
*
* If you need to resend the verification email, you can do so with the Resend Verified Sender Request, `/resend/{id}`, endpoint.
*
* If you need to authenticate a domain rather than a Single Sender, see the [Domain Authentication API](https://sendgrid.api-docs.io/v3.0/domain-authentication/authenticate-a-domain).
*/
pub async fn post_verified_sender(
&self,
body: &crate::types::VerifiedSenderRequestSchema,
) -> ClientResult<crate::Response<crate::types::VerifiedSenderResponseSchema>> {
let url = self.client.url("/verified_senders", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: None,
},
)
.await
}
/**
* Verify Sender Request.
*
* This function performs a `GET` to the `/verified_senders/verify/{token}` endpoint.
*
* **This endpoint allows you to verify a sender requests.**
*
* The token is generated by SendGrid and included in a verification email delivered to the address that's pending verification.
*/
pub async fn get_verified_senders_verify_token(
&self,
token: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/verified_senders/verify/{}",
crate::progenitor_support::encode_path(token),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete Verified Sender.
*
* This function performs a `DELETE` to the `/verified_senders/{id}` endpoint.
*
* **This endpoint allows you to delete a Sender Identity**.
*
* Pass the `id` assigned to a Sender Identity to this endpoint to delete the Sender Identity from your account.
*
* You can retrieve the IDs associated with Sender Identities using the "Get All Verified Senders" endpoint.
*/
pub async fn delete_verified_senders(
&self,
id: &str,
) -> ClientResult<crate::Response<crate::types::Help>> {
let url = self.client.url(
&format!(
"/verified_senders/{}",
crate::progenitor_support::encode_path(id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Edit Verified Sender.
*
* This function performs a `PATCH` to the `/verified_senders/{id}` endpoint.
*
* **This endpoint allows you to update an existing Sender Identity**.
*
* Pass the `id` assigned to a Sender Identity to this endpoint as a path parameter. Include any fields you wish to update in the request body in JSON format.
*
* You can retrieve the IDs associated with Sender Identities by passing a `GET` request to the Get All Verified Senders endpoint, `/verified_senders`.
*
* **Note:** Unlike a `PUT` request, `PATCH` allows you to update only the fields you wish to edit. Fields that are not passed as part of a request will remain unaltered.
*/
pub async fn patch_verified_senders(
&self,
id: &str,
body: &crate::types::VerifiedSenderRequestSchema,
) -> ClientResult<crate::Response<crate::types::VerifiedSenderResponseSchema>> {
let url = self.client.url(
&format!(
"/verified_senders/{}",
crate::progenitor_support::encode_path(id),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: None,
},
)
.await
}
/**
* Resend Verified Sender Request.
*
* This function performs a `POST` to the `/verified_senders/resend/{id}` endpoint.
*
* **This endpoint allows you to resend a verification email to a specified Sender Identity**.
*
* Passing the `id` assigned to a Sender Identity to this endpoint will resend a verification email to the `from_address` associated with the Sender Identity. This can be useful if someone loses their verification email or needs to have it resent for any other reason.
*
* You can retrieve the IDs associated with Sender Identities by passing a "Get All Verified Senders" endpoint.
*/
pub async fn post_verified_senders_resend(
&self,
id: &str,
) -> ClientResult<crate::Response<crate::types::Help>> {
let url = self.client.url(
&format!(
"/verified_senders/resend/{}",
crate::progenitor_support::encode_path(id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}