-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMail.php
More file actions
479 lines (430 loc) · 11 KB
/
Mail.php
File metadata and controls
479 lines (430 loc) · 11 KB
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
<?php
/**
* @author : Jakiboy
* @package : FloatPHP
* @subpackage : Classes Http Component
* @version : 1.5.x
* @copyright : (c) 2018 - 2025 Jihad Sinnaour <me@jihadsinnaour.com>
* @link : https://floatphp.com
* @license : MIT
*
* This file is a part of FloatPHP Framework.
*/
declare(strict_types=1);
namespace FloatPHP\Classes\Http;
use FloatPHP\Classes\Filesystem\{Stringify, TypeCheck, File};
use FloatPHP\Classes\Security\{Tokenizer, Sanitizer};
use \InvalidArgumentException;
use \RuntimeException;
/**
* Advanced mail manipulation.
*/
class Mail
{
/**
* @access protected
* @var int $wrap
* @var array $to
* @var string $subject
* @var string $body
* @var array $headers
* @var string $params
* @var array $attachments
* @var string $uid
*/
protected $wrap = 78;
protected $to = [];
protected $subject;
protected $body;
protected $headers = [];
protected $params = '';
protected $attachments = [];
protected $uid;
protected $isHtml = false;
protected const FROM = 'From';
protected const CC = 'Cc';
protected const BCC = 'Bcc';
protected const REPLY = 'Reply-To';
protected const HTML = 'text/html; charset="utf-8"';
/**
* Set UID.
*
* @access public
* @param string $email, Sender
* @param string $name, Sender
*/
public function __construct(?string $email = null, ?string $name = null)
{
$this->uid = Tokenizer::getUniqueId();
if ( $email ) {
$this->from($email, $name);
}
}
/**
* Set receiver(s).
*
* @access public
* @param string $email
* @param string $name
* @return object
*/
public function to(string $email, ?string $name = null) : self
{
$this->to[] = $this->formatAddressHeader($email, $name);
return $this;
}
/**
* Set sender.
*
* @access public
* @param string $email
* @param string $name
* @return object
*/
public function from(string $email, ?string $name = null) : self
{
$this->setAddressHeader(static::FROM, $email, $name);
return $this;
}
/**
* Set Reply-To.
*
* @access public
* @param string $email
* @param string $name
* @return object
*/
public function replyTo(string $email, ?string $name = null) : self
{
$this->setAddressHeader(static::REPLY, $email, $name);
return $this;
}
/**
* Set CC (Carbon Copy).
*
* @access public
* @param array $pair
* @return object
*/
public function setCc(array $pair) : self
{
$this->setAddressPairHeader(static::CC, $pair);
return $this;
}
/**
* Set BCC (Blind Carbon Copy).
*
* @access public
* @param array $pair
* @return object
*/
public function setBcc(array $pair) : self
{
$this->setAddressPairHeader(static::BCC, $pair);
return $this;
}
/**
* Send body as HTML.
*
* @access public
* @return object
*/
public function asHtml() : self
{
$this->addHeader('Content-Type', static::HTML);
$this->isHtml = true;
return $this;
}
/**
* Set subject.
*
* @access public
* @param string $subject
* @return object
*/
public function setSubject(string $subject) : self
{
$this->subject = Sanitizer::sanitizeMail($subject, 'subject');
return $this;
}
/**
* Set body (message).
*
* @access public
* @param string $body
* @return object
*/
public function setBody(string $body) : self
{
$escape = ($this->isHtml) ? false : true;
$this->body = Sanitizer::sanitizeMail($body, 'body', $escape);
return $this;
}
/**
* Add content to body.
*
* @access public
* @param string $content
* @param bool $break
* @return object
*/
public function addContent(string $content, bool $break = true) : self
{
$escape = ($this->isHtml) ? false : true;
$content = Sanitizer::sanitizeMail($content, 'body', $escape);
if ( $break ) {
$this->addBreak();
}
$this->body .= $content;
return $this;
}
/**
* Add break to body.
*
* @access public
* @return object
*/
public function addBreak() : self
{
$this->body .= "\n";
return $this;
}
/**
* Set attachment(s).
*
* @param string $path
* @param string $name.
* @param string $data
* @return object
*/
public function setAttachment(string $path, ?string $name = null, ?string $data = null) : self
{
$name = $name ?: Stringify::basename($path);
$data = $data ?: $this->getAttachmentData($path);
$data = Stringify::chunk(Tokenizer::base64($data));
$this->attachments[] = [
'path' => $path,
'file' => $name,
'data' => $data
];
return $this;
}
/**
* Set additional mail parameters.
*
* @param string $params
* @return object
*/
public function setParams(string $params) : self
{
$this->params = (string)$params;
return $this;
}
/**
* Set body words wrapper.
*
* @param int $wrap
* @return object
*/
public function wrap(int $wrap) : self
{
$this->wrap = ($wrap > 1)
? $wrap : $this->wrap;
return $this;
}
/**
* Send mail.
*
* @return boolean
* @throws RuntimeException
*/
public function send() : bool
{
if ( !($to = $this->getReceivers()) ) {
throw new RuntimeException(
'Unable to send, Undefined receiver address'
);
}
$headers = $this->getHeaders();
$message = wordwrap($this->body, $this->wrap);
if ( $this->attachments ) {
$message = $this->getAttachmentBody();
$headers .= $this->getAttachmentHeader();
}
return mail($to, $this->subject, $message, $headers, $this->params);
}
/**
* Add mail header.
*
* @access public
* @param string $name
* @param string $value
* @return object
*/
public function addHeader(string $name, string $value) : self
{
$this->headers[] = sprintf('%s: %s', $name, $value);
return $this;
}
/**
* Set address header.
*
* @access protected
* @param string $type
* @param string $email
* @param string $name
* @return void
*/
protected function setAddressHeader(string $type, string $email, ?string $name = null) : void
{
$address = $this->formatAddressHeader($email, $name);
$this->addHeader($type, $address);
}
/**
* Set address pair header.
*
* @access protected
* @param string $type
* @param array $pairs
* @return void
* @throws InvalidArgumentException
*/
protected function setAddressPairHeader(string $type, array $pairs)
{
$address = [];
foreach ($pairs as $name => $email) {
if ( TypeCheck::isInt($name) ) {
$name = null;
}
if ( TypeCheck::isString($email) ) {
$address[] = $this->formatAddressHeader($email, $name);
}
}
if ( !$address ) {
throw new InvalidArgumentException(
'Invali mail header pairs'
);
}
$address = implode(',', $address);
$this->addHeader($type, $address);
}
/**
* Format address header.
*
* @access protected
* @param string $email
* @param string $name
* @return string
* @throws InvalidArgumentException
*/
protected function formatAddressHeader(string $email, ?string $name = null) : string
{
$email = Sanitizer::sanitizeEmail($email);
if ( empty($email) ) {
throw new InvalidArgumentException('Invalid email address');
}
if ( $name ) {
$name = Sanitizer::sanitizeMail($name, 'name');
$email = sprintf('"%s" <%s>', $name, $email);
}
return $email;
}
/**
* Get headers.
*
* @access protected
* @return string
*/
protected function getHeaders() : string
{
if ( $this->headers ) {
$this->headers = join(Stringify::break(), $this->headers);
}
return $this->headers;
}
/**
* Get receivers.
*
* @access protected
* @return string
*/
protected function getReceivers() : string
{
return join(', ', $this->to);
}
/**
* Get attachment data.
*
* @access protected
* @param string $path
* @return mixed
*/
protected function getAttachmentData(string $path) : mixed
{
return File::read($path);
}
/**
* Get attachment header.
*
* @access protected
* @return string
*/
protected function getAttachmentHeader() : string
{
$boundary = 'boundary="' . $this->uid . '"';
$header = [];
$header[] = 'MIME-Version: 1.0';
$header[] = "Content-Type: multipart/mixed; {$boundary}";
$header = join(Stringify::break(), $header);
$header = Stringify::break() . $header;
return $header;
}
/**
* Get attachment body.
*
* @access protected
* @return string
*/
protected function getAttachmentBody() : string
{
$charset = 'charset="utf-8"';
$body = [];
$body[] = 'This is a multi-part message in MIME format.';
$body[] = "--{$this->uid}";
$body[] = "Content-Type: text/html; {$charset}";
$body[] = 'Content-Transfer-Encoding: quoted-printable';
$body[] = '';
$body[] = Sanitizer::sanitizeBody($this->body);
$body[] = '';
$body[] = "--{$this->uid}";
foreach ($this->attachments as $attachment) {
$body[] = $this->getAttachmentMimeTemplate($attachment);
}
$body = implode(Stringify::break(), $body);
return "{$body}--";
}
/**
* Get attachment mime template.
*
* @access protected
* @param array $attachment
* @return string
*/
protected function getAttachmentMimeTemplate(array $attachment) : string
{
$file = $attachment['file'] ?? null;
$data = $attachment['data'] ?? null;
$name = 'name="' . $file . '"';
$filename = 'filename="' . $file . '"';
$header = [];
$header[] = "Content-Type: application/octet-stream; {$name}";
$header[] = "Content-Transfer-Encoding: base64";
$header[] = "Content-Disposition: attachment; {$filename}";
$header[] = '';
$header[] = $data;
$header[] = '';
$header[] = "--{$this->uid}";
$header = implode(Stringify::break(), $header);
return $header;
}
}