-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathEmail.php
executable file
·213 lines (212 loc) · 9.1 KB
/
Email.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
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
<?php
namespace FileCMS\Common\Contact;
/*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of the nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/**
* Sends email using PHPMailer
*/
use PHPMailer\PHPMailer\PHPMailer;
class Email
{
const BODY_PATTERN = '%-20s : %s' . "\n";
const DEFAULT_SUBJECT = 'Customer Request';
const DEFAULT_SUCCESS = 'SUCCESS: email sent';
const DEFAULT_ERROR = 'ERROR: unable to send email';
const ERR_MX = 'ERROR: unable to determine email address';
const DEBUG_MSG = 'DEBUG mode enabled: mail not sent';
// you can also directly set $pattern externally if you don't want to set it in config
public static $pattern = self::BODY_PATTERN;
public static $error = FALSE;
public static $phpMailer = NULL;
/**
* @param array $config : from /src/config/config.php
* @param array $inputs : filtered and validated $_POST data
* : $inputs['email'] === sender; $inputs['to'] === recipient
* @param string $body : message body is passed back by reference
* @param bool $mx_check : if set TRUE, runs "checkdnsrr($email, 'MX')"
* @param bool $debug : set TRUE to set debug mode: doesn't send mail
* @return string $msg : any error or other messages
*/
public static function processPost( array $config,
array $inputs,
string &$body,
bool $mx_check = FALSE,
bool $debug = FALSE)
{
$msg = $config['COMPANY_EMAIL']['ERROR'] ?? self::DEFAULT_ERROR;
// sanitize "from" email
$from = $inputs['email'] ?? $config['COMPANY_EMAIL']['from'] ?? '';
if (!empty($inputs)&& !empty($from) && static::validateEmail($from, $msg, $mx_check)) {
$from = filter_var($from, FILTER_SANITIZE_EMAIL);
// set pattern
$pattern = $config['COMPANY_EMAIL']['pattern']
?? static::$pattern
?? static::BODY_PATTERN;
// create body
$body = (!empty($body)) ? $body : "\n";
foreach ($inputs as $key => $value)
$body .= sprintf(self::BODY_PATTERN, ucfirst($key), $value);
$subject = $inputs['subject']
?? $config['COMPANY_EMAIL']['default_subject']
?? static::DEFAULT_SUBJECT;
$msg = $config['COMPANY_EMAIL']['ERROR'] ?? self::DEFAULT_ERROR;
$to = $inputs['to'] ?? $config['COMPANY_EMAIL']['to'];
$cc = $inputs['cc'] ?? $config['COMPANY_EMAIL']['cc'] ?? '';
$bcc = $inputs['bcc'] ?? $config['COMPANY_EMAIL']['bcc'] ?? '';
$phpmailerConfig = $config['COMPANY_EMAIL']['phpmailer'];
// validate email
if (static::validateEmail($to, $msg, $mx_check)) {
// send request
$msg = self::trustedSend($config, $to, $from, $subject, $body, $cc, $bcc, $debug);
}
}
return $msg;
}
/**
* Sends email using PHPMailer
* Trusts that all validation is done
*
* @param array $config : primary config file
* @param string $to : recipient's email address
* @param string $from : sender's email address
* @param string $subject : email subject line
* @param string $body : email message
* @param mixed $cc : optional CC list
* @param mixed $bcc : optional BCC list
* @param bool $debug : set TRUE to set debug mode: doesn't send mail
* @return string $msg : success/failure message
*/
public static function trustedSend( array $config,
string $to,
string $from,
string $subject,
string $body,
$cc = '',
$bcc = '',
bool $debug = FALSE)
{
$msg = $config['COMPANY_EMAIL']['ERROR'] ?? self::DEFAULT_ERROR;
$phpmailerConfig = $config['COMPANY_EMAIL']['phpmailer'];
// send request
try {
// set up SMTP
$mail = new PHPMailer();
if (!empty($phpmailerConfig['smtp'])) {
$mail->IsSMTP();
$mail->Host = $phpmailerConfig['smtp_host'] ?? '';
$mail->Port = $phpmailerConfig['smtp_port'];
$mail->SMTPAuth = $phpmailerConfig['smtp_auth'];
$mail->Username = $phpmailerConfig['smtp_username'] ?? '';
$mail->Password = $phpmailerConfig['smtp_password'] ?? '';
$mail->SMTPSecure = $phpmailerConfig['smtp_secure'] ?? 'tls';
}
// HTML email?
if (!empty($phpmailerConfig['html'])) $mail->isHTML(TRUE);
// set up mail obj
$mail->setFrom($from);
self::queueOutbound($to, 'to', $mail);
self::queueOutbound($cc, 'cc', $mail);
self::queueOutbound($bcc, 'bcc', $mail);
$mail->Subject = $subject;
$mail->Body = $body;
if ($debug === TRUE) {
self::$phpMailer = $mail;
$msg = self::DEBUG_MSG;
} else {
//send the message, check for errors
if ($mail->send()) {
$msg = $config['COMPANY_EMAIL']['SUCCESS'] ?? self::DEFAULT_SUCCESS;
} else {
$msg = $config['COMPANY_EMAIL']['ERROR'] ?? self::DEFAULT_ERROR;
self::$error = TRUE;
}
}
} catch (\Exception $e) {
self::$error = TRUE;
$msg = $config['COMPANY_EMAIL']['ERROR'] ?? self::DEFAULT_ERROR;
error_log(__METHOD__ . ':' . $e->getMessage());
}
return $msg;
}
/**
* If $data is an array, calls $method for each element
*
* @param mixed $data : data to be added to queued items
* @param string $method : to|cc|bcc
* @param PHPMailer $mail : PHPMailer instance
* @return void
*/
public static function queueOutbound($data, string $method, PHPMailer $mail) : void
{
if (!empty($data)) {
switch ($method) {
case 'cc' :
$method = 'addCC';
break;
case 'bcc' :
$method = 'addBCC';
break;
case 'to' :
default :
$method = 'addAddress';
break;
}
if (is_array($data)) {
foreach ($data as $item)
$mail->$method($item);
} else {
$mail->$method($data);
}
}
}
/**
* Uses PHPMailer to validate email address
*
* @param string $email : email address to validate
* @param string $msg : pass message by reference
* @param bool $mx_check : set TRUE to also perform an MX check (takes longer)
* @return bool
*/
public static function validateEmail(string $email, string &$msg = '', bool $mx_check = FALSE)
{
$expected = 1;
$actual = 0;
$actual += (int) PHPMailer::validateAddress($email);
if ($actual === 1 && $mx_check === TRUE) {
$expected++;
[$user, $host] = explode('@', $email);
$actual += (int) checkdnsrr($host, 'MX');
$msg = static::ERR_MX;
}
$valid = ($actual === $expected);
if (!$valid)
error_log(__METHOD__ . ':' . static::DEFAULT_ERROR . ':' . $email);
return $valid;
}
}