/
MailChimpDriver.php
178 lines (132 loc) · 4.55 KB
/
MailChimpDriver.php
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
<?php
namespace Spatie\Newsletter\Drivers;
use DrewM\MailChimp\MailChimp;
use Spatie\Newsletter\Support\Lists;
class MailChimpDriver implements Driver
{
protected Lists $lists;
protected MailChimp $mailChimp;
public static function make(array $arguments, Lists $lists)
{
return new self($arguments, $lists);
}
public function __construct(array $arguments, Lists $lists)
{
$this->mailChimp = new MailChimp(
$arguments['api_key'] ?? '',
$arguments['endpoint'] ?? null,
);
$this->lists = $lists;
}
public function getApi(): MailChimp
{
return $this->mailChimp;
}
public function subscribe(
string $email,
array $properties = [],
string $listName = '',
array $options = []
) {
$list = $this->lists->findByName($listName);
$options = $this->getSubscriptionOptions($email, $properties, $options);
$response = $this->mailChimp->post("lists/{$list->getId()}/members", $options);
if (! $this->lastActionSucceeded()) {
return false;
}
return $response;
}
public function subscribePending(string $email, array $properties = [], string $listName = '', array $options = [])
{
$options = array_merge($options, ['status' => 'pending']);
return $this->subscribe($email, $properties, $listName, $options);
}
public function subscribeOrUpdate(
string $email,
array $properties = [],
string $listName = '',
array $options = []
) {
$list = $this->lists->findByName($listName);
$options = $this->getSubscriptionOptions($email, $properties, $options);
$response = $this->mailChimp->put("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", $options);
if (! $this->lastActionSucceeded()) {
return false;
}
return $response;
}
public function getMembers(string $listName = '', array $parameters = [])
{
$list = $this->lists->findByName($listName);
return $this->mailChimp->get("lists/{$list->getId()}/members", $parameters);
}
public function getMember(string $email, string $listName = '')
{
$list = $this->lists->findByName($listName);
return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");
}
public function unsubscribe(string $email, string $listName = '')
{
$list = $this->lists->findByName($listName);
$response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", [
'status' => 'unsubscribed',
]);
if (! $this->lastActionSucceeded()) {
return false;
}
return $response;
}
public function delete(string $email, string $listName = '')
{
$list = $this->lists->findByName($listName);
$response = $this->mailChimp->delete("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}");
return $response;
}
public function hasMember(string $email, string $listName = ''): bool
{
$response = $this->getMember($email, $listName);
if (! isset($response['email_address'])) {
return false;
}
if (strtolower($response['email_address']) != strtolower($email)) {
return false;
}
return true;
}
public function isSubscribed(string $email, string $listName = ''): bool
{
$response = $this->getMember($email, $listName);
if (! $this->lastActionSucceeded()) {
return false;
}
if ($response['status'] != 'subscribed') {
return false;
}
return true;
}
protected function getSubscriptionOptions(string $email, array $mergeFields, array $options): array
{
$defaultOptions = [
'email_address' => $email,
'status' => 'subscribed',
'email_type' => 'html',
];
if (count($mergeFields)) {
$defaultOptions['merge_fields'] = $mergeFields;
}
$options = array_merge($defaultOptions, $options);
return $options;
}
public function getLastError(): string|false
{
return $this->mailChimp->getLastError();
}
public function lastActionSucceeded(): bool
{
return $this->mailChimp->success();
}
protected function getSubscriberHash(string $email): string
{
return $this->mailChimp->subscriberHash($email);
}
}