|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Spatie\Newsletter; |
|
4
|
|
|
|
|
5
|
|
|
use DrewM\MailChimp\MailChimp; |
|
6
|
|
|
|
|
7
|
|
|
class Newsletter |
|
8
|
|
|
{ |
|
9
|
|
|
/** @var \DrewM\MailChimp\MailChimp */ |
|
10
|
|
|
protected $mailChimp; |
|
11
|
|
|
|
|
12
|
|
|
/** @var \Spatie\Newsletter\NewsletterListCollection */ |
|
13
|
|
|
protected $lists; |
|
14
|
|
|
|
|
15
|
|
|
public function __construct(MailChimp $mailChimp, NewsletterListCollection $lists) |
|
16
|
|
|
{ |
|
17
|
|
|
$this->mailChimp = $mailChimp; |
|
18
|
|
|
|
|
19
|
|
|
$this->lists = $lists; |
|
20
|
|
|
} |
|
21
|
|
|
|
|
22
|
|
View Code Duplication |
public function subscribe(string $email, array $mergeFields = [], string $listName = '', array $options = []) |
|
|
|
|
|
|
23
|
|
|
{ |
|
24
|
|
|
$list = $this->lists->findByName($listName); |
|
25
|
|
|
|
|
26
|
|
|
$options = $this->getSubscriptionOptions($email, $mergeFields, $options); |
|
27
|
|
|
|
|
28
|
|
|
$response = $this->mailChimp->post("lists/{$list->getId()}/members", $options); |
|
29
|
|
|
|
|
30
|
|
|
if (! $this->lastActionSucceeded()) { |
|
31
|
|
|
return false; |
|
32
|
|
|
} |
|
33
|
|
|
|
|
34
|
|
|
return $response; |
|
35
|
|
|
} |
|
36
|
|
|
|
|
37
|
|
|
public function subscribePending(string $email, array $mergeFields = [], string $listName = '', array $options = []) |
|
38
|
|
|
{ |
|
39
|
|
|
$options = array_merge($options, ['status' => 'pending']); |
|
40
|
|
|
|
|
41
|
|
|
return $this->subscribe($email, $mergeFields, $listName, $options); |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
View Code Duplication |
public function subscribeOrUpdate(string $email, array $mergeFields = [], string $listName = '', array $options = []) |
|
|
|
|
|
|
45
|
|
|
{ |
|
46
|
|
|
$list = $this->lists->findByName($listName); |
|
47
|
|
|
|
|
48
|
|
|
$options = $this->getSubscriptionOptions($email, $mergeFields, $options); |
|
49
|
|
|
|
|
50
|
|
|
$response = $this->mailChimp->put("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", $options); |
|
51
|
|
|
|
|
52
|
|
|
if (! $this->lastActionSucceeded()) { |
|
53
|
|
|
return false; |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
return $response; |
|
57
|
|
|
} |
|
58
|
|
|
|
|
59
|
|
|
public function getMembers(string $listName = '', array $parameters = []) |
|
60
|
|
|
{ |
|
61
|
|
|
$list = $this->lists->findByName($listName); |
|
62
|
|
|
|
|
63
|
|
|
return $this->mailChimp->get("lists/{$list->getId()}/members", $parameters); |
|
64
|
|
|
} |
|
65
|
|
|
|
|
66
|
|
|
public function getMember(string $email, string $listName = '') |
|
67
|
|
|
{ |
|
68
|
|
|
$list = $this->lists->findByName($listName); |
|
69
|
|
|
|
|
70
|
|
|
return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}"); |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
public function getMemberActivity(string $email, string $listName = '') |
|
74
|
|
|
{ |
|
75
|
|
|
$list = $this->lists->findByName($listName); |
|
76
|
|
|
|
|
77
|
|
|
return $this->mailChimp->get("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}/activity"); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
public function hasMember(string $email, string $listName = ''): bool |
|
81
|
|
|
{ |
|
82
|
|
|
$response = $this->getMember($email, $listName); |
|
83
|
|
|
|
|
84
|
|
|
if (! isset($response['email_address'])) { |
|
85
|
|
|
return false; |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
if (strtolower($response['email_address']) != strtolower($email)) { |
|
89
|
|
|
return false; |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
return true; |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
public function isSubscribed(string $email, string $listName = ''): bool |
|
96
|
|
|
{ |
|
97
|
|
|
$response = $this->getMember($email, $listName); |
|
98
|
|
|
|
|
99
|
|
|
if (! isset($response)) { |
|
100
|
|
|
return false; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
if ($response['status'] != 'subscribed') { |
|
104
|
|
|
return false; |
|
105
|
|
|
} |
|
106
|
|
|
|
|
107
|
|
|
return true; |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
|
View Code Duplication |
public function unsubscribe(string $email, string $listName = '') |
|
|
|
|
|
|
111
|
|
|
{ |
|
112
|
|
|
$list = $this->lists->findByName($listName); |
|
113
|
|
|
|
|
114
|
|
|
$response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}", [ |
|
115
|
|
|
'status' => 'unsubscribed', |
|
116
|
|
|
]); |
|
117
|
|
|
|
|
118
|
|
|
if (! $this->lastActionSucceeded()) { |
|
119
|
|
|
return false; |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
return $response; |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
View Code Duplication |
public function updateEmailAddress(string $currentEmailAddress, string $newEmailAddress, string $listName = '') |
|
|
|
|
|
|
126
|
|
|
{ |
|
127
|
|
|
$list = $this->lists->findByName($listName); |
|
128
|
|
|
|
|
129
|
|
|
$response = $this->mailChimp->patch("lists/{$list->getId()}/members/{$this->getSubscriberHash($currentEmailAddress)}", [ |
|
130
|
|
|
'email_address' => $newEmailAddress, |
|
131
|
|
|
]); |
|
132
|
|
|
|
|
133
|
|
|
return $response; |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
public function delete(string $email, string $listName = '') |
|
137
|
|
|
{ |
|
138
|
|
|
$list = $this->lists->findByName($listName); |
|
139
|
|
|
|
|
140
|
|
|
$response = $this->mailChimp->delete("lists/{$list->getId()}/members/{$this->getSubscriberHash($email)}"); |
|
141
|
|
|
|
|
142
|
|
|
return $response; |
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
public function createCampaign( |
|
146
|
|
|
string $fromName, |
|
147
|
|
|
string $replyTo, |
|
148
|
|
|
string $subject, |
|
149
|
|
|
string $html = '', |
|
150
|
|
|
string $listName = '', |
|
151
|
|
|
array $options = [], |
|
152
|
|
|
array $contentOptions = []) |
|
153
|
|
|
{ |
|
154
|
|
|
$list = $this->lists->findByName($listName); |
|
155
|
|
|
|
|
156
|
|
|
$defaultOptions = [ |
|
157
|
|
|
'type' => 'regular', |
|
158
|
|
|
'recipients' => [ |
|
159
|
|
|
'list_id' => $list->getId(), |
|
160
|
|
|
], |
|
161
|
|
|
'settings' => [ |
|
162
|
|
|
'subject_line' => $subject, |
|
163
|
|
|
'from_name' => $fromName, |
|
164
|
|
|
'reply_to' => $replyTo, |
|
165
|
|
|
], |
|
166
|
|
|
]; |
|
167
|
|
|
|
|
168
|
|
|
$options = array_merge($defaultOptions, $options); |
|
169
|
|
|
|
|
170
|
|
|
$response = $this->mailChimp->post('campaigns', $options); |
|
171
|
|
|
|
|
172
|
|
|
if (! $this->lastActionSucceeded()) { |
|
173
|
|
|
return false; |
|
174
|
|
|
} |
|
175
|
|
|
|
|
176
|
|
|
if ($html === '' && count($contentOptions) === 0) { |
|
177
|
|
|
return $response; |
|
178
|
|
|
} |
|
179
|
|
|
|
|
180
|
|
|
if (! $this->updateContent($response['id'], $html, $contentOptions)) { |
|
181
|
|
|
return false; |
|
182
|
|
|
} |
|
183
|
|
|
|
|
184
|
|
|
return $response; |
|
185
|
|
|
} |
|
186
|
|
|
|
|
187
|
|
|
public function updateContent(string $campaignId, string $html, array $options = []) |
|
188
|
|
|
{ |
|
189
|
|
|
if ($html !== '') { |
|
190
|
|
|
$defaultOptions = compact('html'); |
|
191
|
|
|
|
|
192
|
|
|
$options = array_merge($defaultOptions, $options); |
|
193
|
|
|
} |
|
194
|
|
|
|
|
195
|
|
|
$response = $this->mailChimp->put("campaigns/{$campaignId}/content", $options); |
|
196
|
|
|
|
|
197
|
|
|
if (! $this->lastActionSucceeded()) { |
|
198
|
|
|
return false; |
|
199
|
|
|
} |
|
200
|
|
|
|
|
201
|
|
|
return $response; |
|
202
|
|
|
} |
|
203
|
|
|
|
|
204
|
|
|
public function getApi(): MailChimp |
|
205
|
|
|
{ |
|
206
|
|
|
return $this->mailChimp; |
|
207
|
|
|
} |
|
208
|
|
|
|
|
209
|
|
|
/** |
|
210
|
|
|
* @return array|false |
|
211
|
|
|
*/ |
|
212
|
|
|
public function getLastError() |
|
213
|
|
|
{ |
|
214
|
|
|
return $this->mailChimp->getLastError(); |
|
215
|
|
|
} |
|
216
|
|
|
|
|
217
|
|
|
public function lastActionSucceeded(): bool |
|
218
|
|
|
{ |
|
219
|
|
|
return $this->mailChimp->success(); |
|
220
|
|
|
} |
|
221
|
|
|
|
|
222
|
|
|
protected function getSubscriberHash(string $email): string |
|
223
|
|
|
{ |
|
224
|
|
|
return $this->mailChimp->subscriberHash($email); |
|
225
|
|
|
} |
|
226
|
|
|
|
|
227
|
|
|
protected function getSubscriptionOptions(string $email, array $mergeFields, array $options): array |
|
228
|
|
|
{ |
|
229
|
|
|
$defaultOptions = [ |
|
230
|
|
|
'email_address' => $email, |
|
231
|
|
|
'status' => 'subscribed', |
|
232
|
|
|
'email_type' => 'html', |
|
233
|
|
|
]; |
|
234
|
|
|
|
|
235
|
|
|
if (count($mergeFields)) { |
|
236
|
|
|
$defaultOptions['merge_fields'] = $mergeFields; |
|
237
|
|
|
} |
|
238
|
|
|
|
|
239
|
|
|
$options = array_merge($defaultOptions, $options); |
|
240
|
|
|
|
|
241
|
|
|
return $options; |
|
242
|
|
|
} |
|
243
|
|
|
} |
|
244
|
|
|
|
spatie /
laravel-newsletter
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.