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
|
<?php
/*
* Copyright (C) 2013-2016 Mailgun
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace Mailgun\Api\Suppression;
use Mailgun\Api\HttpApi;
use Mailgun\Api\Pagination;
use Mailgun\Assert;
use Mailgun\Model\Suppression\Complaint\CreateResponse;
use Mailgun\Model\Suppression\Complaint\DeleteResponse;
use Mailgun\Model\Suppression\Complaint\IndexResponse;
use Mailgun\Model\Suppression\Complaint\ShowResponse;
/**
* @see https://documentation.mailgun.com/api-suppressions.html#complaints
*
* @author Sean Johnson <sean@mailgun.com>
*/
class Complaint extends HttpApi
{
use Pagination;
/**
* @param string $domain Domain to get complaints for
* @param int $limit optional
*
* @return IndexResponse
*/
public function index($domain, $limit = 100)
{
Assert::stringNotEmpty($domain);
Assert::range($limit, 1, 10000, 'Limit parameter must be between 1 and 10000');
$params = [
'limit' => $limit,
];
$response = $this->httpGet(sprintf('/v3/%s/complaints', $domain), $params);
return $this->hydrateResponse($response, IndexResponse::class);
}
/**
* @param string $domain Domain to show complaint for
* @param string $address Complaint address
*
* @return ShowResponse
*/
public function show($domain, $address)
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($address);
$response = $this->httpGet(sprintf('/v3/%s/complaints/%s', $domain, $address));
return $this->hydrateResponse($response, ShowResponse::class);
}
/**
* @param string $domain Domain to create complaint for
* @param string $address Complaint address
* @param string $createdAt (optional) rfc2822 compliant format. (new \DateTime())->format('r')
*
* @return CreateResponse
*/
public function create($domain, $address, $createdAt = null)
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($address);
Assert::stringNotEmpty($createdAt);
$params['address'] = $address;
if (null !== $createdAt) {
$params['created_at'] = $createdAt;
}
$response = $this->httpPost(sprintf('/v3/%s/complaints', $domain), $params);
return $this->hydrateResponse($response, CreateResponse::class);
}
/**
* @param string $domain Domain to delete complaint for
* @param string $address Complaint address
*
* @return DeleteResponse
*/
public function delete($domain, $address)
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($address);
$response = $this->httpDelete(sprintf('/v3/%s/complaints/%s', $domain, $address));
return $this->hydrateResponse($response, DeleteResponse::class);
}
/**
* @param string $domain Domain to delete all bounces for
*
* @return DeleteResponse
*/
public function deleteAll($domain)
{
Assert::stringNotEmpty($domain);
$response = $this->httpDelete(sprintf('/v3/%s/complaints', $domain));
return $this->hydrateResponse($response, DeleteResponse::class);
}
}
|
