mirror
/
PHPMailer
mirror of https://github.com/PHPMailer/PHPMailer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Standards cleanup

This commit is contained in:
Marcus Bointon 2019-10-08 13:35:03 +02:00
parent 7480e75c70
commit c9e4d921d4
No known key found for this signature in database
GPG Key ID: DE31CD6EB646AA24
18 changed files with 335 additions and 296 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
examples/DKIM_sign.phps
View File

@ -39,7 +39,7 @@ $mail->DKIM_extraHeaders = ['List-Unsubscribe', 'List-Help'];
//When you send, the DKIM settings will be used to sign the message
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}

2
examples/callback.phps
View File

@ -62,7 +62,7 @@ try {
//Alternative approach using a closure
try {
$mail->action_function = function ($result, $to, $cc, $bcc, $subject, $body) {
$mail->action_function = static function ($result, $to, $cc, $bcc, $subject, $body) {
if ($result) {
echo "Message sent successfully\n";
} else {

6
examples/extending.phps
View File

@ -40,7 +40,7 @@ class myPHPMailer extends PHPMailer
//Show debug output
$this->SMTPDebug = SMTP::DEBUG_SERVER;
//Inject a new debug output handler
$this->Debugoutput = function ($str, $level) {
$this->Debugoutput = static function ($str, $level) {
echo "Debug level $level; message: $str\n";
};
}
@ -50,7 +50,7 @@ class myPHPMailer extends PHPMailer
{
$this->Subject = '[Yay for me!] ' . $this->Subject;
$r = parent::send();
echo "I sent a message with subject " . $this->Subject;
echo 'I sent a message with subject '. $this->Subject;
return $r;
}
@ -67,5 +67,5 @@ try {
$mail->send(); //no need to check for errors - the exception handler will do it
} catch (Exception $e) {
//Note that this is catching the PHPMailer Exception class, not the global \Exception type!
echo "Caught a " . get_class($e) . ": " . $e->getMessage();
echo 'Caught a '. get_class($e) .': '. $e->getMessage();
}

10
examples/gmail.phps
View File

@ -40,10 +40,10 @@ $mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
$mail->SMTPAuth = true;
//Username to use for SMTP authentication - use full email address for gmail
$mail->Username = "username@gmail.com";
$mail->Username = 'username@gmail.com';
//Password to use for SMTP authentication
$mail->Password = "yourpassword";
$mail->Password = 'yourpassword';
//Set who the message is to be sent from
$mail->setFrom('from@example.com', 'First Last');
@ -69,9 +69,9 @@ $mail->addAttachment('images/phpmailer_mini.png');
//send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
//Section 2: IMAP
//Uncomment these to save your message in the 'Sent Mail' folder.
#if (save_mail($mail)) {
@ -87,7 +87,7 @@ if (!$mail->send()) {
function save_mail($mail)
{
//You can change 'Sent Mail' to any other folder or tag
$path = "{imap.gmail.com:993/imap/ssl}[Gmail]/Sent Mail";
$path = '{imap.gmail.com:993/imap/ssl}[Gmail]/Sent Mail';
//Tell your server to open an IMAP connection using the same username and password as you used for SMTP
$imapStream = imap_open($path, $mail->Username, $mail->Password);

4
examples/gmail_xoauth.phps
View File

@ -100,7 +100,7 @@ $mail->addAttachment('images/phpmailer_mini.png');
//send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}

4
examples/mail.phps
View File

@ -28,7 +28,7 @@ $mail->addAttachment('images/phpmailer_mini.png');
//send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}

4
examples/send_file_upload.phps
View File

@ -24,9 +24,9 @@ if (array_key_exists('userfile', $_FILES)) {
// Attach the uploaded file
$mail->addAttachment($uploadfile, 'My uploaded file');
if (!$mail->send()) {
$msg .= "Mailer Error: " . $mail->ErrorInfo;
$msg .= 'Mailer Error: '. $mail->ErrorInfo;
} else {
$msg .= "Message sent!";
$msg .= 'Message sent!';
}
} else {
$msg .= 'Failed to move file to ' . $uploadfile;

4
examples/send_multiple_file_upload.phps
View File

@ -26,9 +26,9 @@ if (array_key_exists('userfile', $_FILES)) {
}
}
if (!$mail->send()) {
$msg .= "Mailer Error: " . $mail->ErrorInfo;
$msg .= 'Mailer Error: '. $mail->ErrorInfo;
} else {
$msg .= "Message sent!";
$msg .= 'Message sent!';
}
}
?>

4
examples/sendmail.phps
View File

@ -30,7 +30,7 @@ $mail->addAttachment('images/phpmailer_mini.png');
//send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}

10
examples/simple_contact_form.phps
View File

@ -38,16 +38,16 @@ if (array_key_exists('to', $_POST)) {
//Validate to address
//Never allow arbitrary input for the 'to' address as it will turn your form into a spam gateway!
//Substitute appropriate addresses from your own domain, or simply use a single, fixed address
if (array_key_exists('to', $_POST) and in_array($_POST['to'], ['sales', 'support', 'accounts'])) {
if (array_key_exists('to', $_POST) && in_array($_POST['to'], ['sales', 'support', 'accounts'], true)) {
$to = $_POST['to'] . '@example.com';
} else {
$to = 'support@example.com';
}
//Make sure the address they provided is valid before trying to use it
if (array_key_exists('email', $_POST) and PHPMailer::validateAddress($_POST['email'])) {
if (array_key_exists('email', $_POST) && PHPMailer::validateAddress($_POST['email'])) {
$email = $_POST['email'];
} else {
$msg .= "Error: invalid email address provided";
$msg .= 'Error: invalid email address provided';
$err = true;
}
if (!$err) {
@ -65,9 +65,9 @@ if (array_key_exists('to', $_POST)) {
$mail->Subject = 'Contact form: ' . $subject;
$mail->Body = "Contact form submission\n\n" . $query;
if (!$mail->send()) {
$msg .= "Mailer Error: " . $mail->ErrorInfo;
$msg .= 'Mailer Error: '. $mail->ErrorInfo;
} else {
$msg .= "Message sent!";
$msg .= 'Message sent!';
}
}
} ?>

4
examples/smime_signed_mail.phps
View File

@ -85,9 +85,9 @@ $mail->sign(
//Send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}
/*
* REMARKS:

4
examples/smtp_check.phps
View File

@ -47,7 +47,7 @@ try {
//If server supports authentication, do it (even if no encryption)
if (is_array($e) && array_key_exists('AUTH', $e)) {
if ($smtp->authenticate('username', 'password')) {
echo "Connected ok!";
echo 'Connected ok!';
} else {
throw new Exception('Authentication failed: ' . $smtp->getError()['error']);
}
@ -56,4 +56,4 @@ try {
echo 'SMTP error: ' . $e->getMessage(), "\n";
}
//Whatever happened, close the connection.
$smtp->quit(true);
$smtp->quit();

6
examples/smtp_low_memory.phps
View File

@ -59,7 +59,7 @@ class SMTPLowMemory extends SMTP
//Remember where we have got to
$offset += ($linelen + 1);
$lines_out = [];
if ($in_headers and $line == '') {
if ($in_headers && $line === '') {
$in_headers = false;
}
//We need to break this line up into several smaller lines
@ -90,7 +90,7 @@ class SMTPLowMemory extends SMTP
//Send the lines to the server
foreach ($lines_out as $line_out) {
//RFC2821 section 4.5.2
if (!empty($line_out) and $line_out[0] == '.') {
if (!empty($line_out) && $line_out[0] === '.') {
$line_out = '.' . $line_out;
}
$this->client_send($line_out . self::LE);
@ -100,7 +100,7 @@ class SMTPLowMemory extends SMTP
//Message data has been sent, complete the command
//Increase timelimit for end of DATA command
$savetimelimit = $this->Timelimit;
$this->Timelimit = $this->Timelimit * 2;
$this->Timelimit *= 2;
$result = $this->sendCommand('DATA END', '.', 250);
//Restore timelimit
$this->Timelimit = $savetimelimit;

4
examples/smtp_no_auth.phps
View File

@ -46,7 +46,7 @@ $mail->addAttachment('images/phpmailer_mini.png');
//send the message, check for errors
if (!$mail->send()) {
echo "Mailer Error: " . $mail->ErrorInfo;
echo 'Mailer Error: '. $mail->ErrorInfo;
} else {
echo "Message sent!";
echo 'Message sent!';
}

2
src/OAuth.php
View File

@ -123,7 +123,7 @@ class OAuth
public function getOauth64()
{
// Get a new token if it's not available or has expired
if (null === $this->oauthToken or $this->oauthToken->hasExpired()) {
if (null === $this->oauthToken || $this->oauthToken->hasExpired()) {
$this->oauthToken = $this->getToken();
}

493
src/PHPMailer.php
View File

File diff suppressed because it is too large Load Diff

2
src/POP3.php
View File

@ -364,7 +364,7 @@ class POP3
*/
protected function checkResponse($string)
{
if (substr($string, 0, 3) !== '+OK') {
if (strpos($string, '+OK') !== 0) {
$this->setError("Server reported an error: $string");
return false;

64
src/SMTP.php
View File

@ -207,7 +207,7 @@ class SMTP
*
* @var string|null
*/
protected $helo_rply = null;
protected $helo_rply;
/**
* The set of SMTP extensions sent in reply to EHLO command.
@ -219,7 +219,7 @@ class SMTP
*
* @var array|null
*/
protected $server_caps = null;
protected $server_caps;
/**
* The most recent reply received from the server.
@ -249,7 +249,7 @@ class SMTP
return;
}
//Avoid clash with built-in function names
if (!in_array($this->Debugoutput, ['error_log', 'html', 'echo']) and is_callable($this->Debugoutput)) {
if (is_callable($this->Debugoutput) && !in_array($this->Debugoutput, ['error_log', 'html', 'echo'])) {
call_user_func($this->Debugoutput, $str, $level);
return;
@ -270,12 +270,12 @@ class SMTP
case 'echo':
default:
//Normalize line breaks
$str = preg_replace('/\r\n|\r/ms', "\n", $str);
$str = preg_replace('/\r\n|\r/m', "\n", $str);
echo gmdate('Y-m-d H:i:s'),
"\t",
//Trim trailing space
trim(
//Indent for readability, except for trailing break
//Indent for readability, except for trailing break
str_replace(
"\n",
"\n \t ",
@ -358,7 +358,7 @@ class SMTP
'Failed to connect to server',
'',
(string) $errno,
(string) $errstr
$errstr
);
$this->edebug(
'SMTP ERROR: ' . $this->error['error']
@ -371,10 +371,10 @@ class SMTP
$this->edebug('Connection: opened', self::DEBUG_CONNECTION);
// SMTP server can take longer to respond, give longer timeout for first read
// Windows does not have support for this timeout function
if (substr(PHP_OS, 0, 3) != 'WIN') {
if (strpos(PHP_OS, 'WIN') !== 0) {
$max = ini_get('max_execution_time');
// Don't bother if unlimited
if (0 != $max and $timeout > $max) {
if (0 !== $max && $timeout > $max) {
@set_time_limit($timeout);
}
stream_set_timeout($this->smtp_conn, $timeout, 0);
@ -454,14 +454,14 @@ class SMTP
return false;
}
$this->edebug('Auth method requested: ' . ($authtype ? $authtype : 'UNSPECIFIED'), self::DEBUG_LOWLEVEL);
$this->edebug('Auth method requested: ' . ($authtype ?: 'UNSPECIFIED'), self::DEBUG_LOWLEVEL);
$this->edebug(
'Auth methods available on the server: ' . implode(',', $this->server_caps['AUTH']),
self::DEBUG_LOWLEVEL
);
//If we have requested a specific auth type, check the server supports it before trying others
if (null !== $authtype and !in_array($authtype, $this->server_caps['AUTH'])) {
if (null !== $authtype && !in_array($authtype, $this->server_caps['AUTH'], true)) {
$this->edebug('Requested auth method not available: ' . $authtype, self::DEBUG_LOWLEVEL);
$authtype = null;
}
@ -470,7 +470,7 @@ class SMTP
//If no auth mechanism is specified, attempt to use these, in this order
//Try CRAM-MD5 first as it's more secure than the others
foreach (['CRAM-MD5', 'LOGIN', 'PLAIN', 'XOAUTH2'] as $method) {
if (in_array($method, $this->server_caps['AUTH'])) {
if (in_array($method, $this->server_caps['AUTH'], true)) {
$authtype = $method;
break;
}
@ -483,7 +483,7 @@ class SMTP
$this->edebug('Auth method selected: ' . $authtype, self::DEBUG_LOWLEVEL);
}
if (!in_array($authtype, $this->server_caps['AUTH'])) {
if (!in_array($authtype, $this->server_caps['AUTH'], true)) {
$this->setError("The requested authentication method \"$authtype\" is not supported by the server");
return false;
@ -673,13 +673,13 @@ class SMTP
$field = substr($lines[0], 0, strpos($lines[0], ':'));
$in_headers = false;
if (!empty($field) and strpos($field, ' ') === false) {
if (!empty($field) && strpos($field, ' ') === false) {
$in_headers = true;
}
foreach ($lines as $line) {
$lines_out = [];
if ($in_headers and $line == '') {
if ($in_headers && $line === '') {
$in_headers = false;
}
//Break this line up into several smaller lines if it's too long
@ -710,7 +710,7 @@ class SMTP
//Send the lines to the server
foreach ($lines_out as $line_out) {
//RFC2821 section 4.5.2
if (!empty($line_out) and $line_out[0] == '.') {
if (!empty($line_out) && $line_out[0] === '.') {
$line_out = '.' . $line_out;
}
$this->client_send($line_out . static::LE, 'DATA');
@ -720,7 +720,7 @@ class SMTP
//Message data has been sent, complete the command
//Increase timelimit for end of DATA command
$savetimelimit = $this->Timelimit;
$this->Timelimit = $this->Timelimit * 2;
$this->Timelimit *= 2;
$result = $this->sendCommand('DATA END', '.', 250);
$this->recordLastTransactionID();
//Restore timelimit
@ -848,7 +848,7 @@ class SMTP
{
$noerror = $this->sendCommand('QUIT', 'QUIT', 221);
$err = $this->error; //Save any error
if ($noerror or $close_on_error) {
if ($noerror || $close_on_error) {
$this->close();
$this->error = $err; //Restore any error from the quit command
}
@ -925,7 +925,7 @@ class SMTP
return false;
}
//Reject line breaks in all commands
if (strpos($commandstring, "\n") !== false or strpos($commandstring, "\r") !== false) {
if ((strpos($commandstring, "\n") !== false) || (strpos($commandstring, "\r") !== false)) {
$this->setError("Command '$command' contained line breaks");
return false;
@ -935,8 +935,8 @@ class SMTP
$this->last_reply = $this->get_lines();
// Fetch SMTP code and possible error code explanation
$matches = [];
if (preg_match('/^([0-9]{3})[ -](?:([0-9]\\.[0-9]\\.[0-9]{1,2}) )?/', $this->last_reply, $matches)) {
$code = $matches[1];
if (preg_match('/^([\d]{3})[ -](?:([\d]\\.[\d]\\.[\d]{1,2}) )?/', $this->last_reply, $matches)) {
$code = (int) $matches[1];
$code_ex = (count($matches) > 2 ? $matches[2] : null);
// Cut off error code from each response line
$detail = preg_replace(
@ -947,14 +947,14 @@ class SMTP
);
} else {
// Fall back to simple parsing if regex fails
$code = substr($this->last_reply, 0, 3);
$code = (int) substr($this->last_reply, 0, 3);
$code_ex = null;
$detail = substr($this->last_reply, 4);
}
$this->edebug('SERVER -> CLIENT: ' . $this->last_reply, self::DEBUG_SERVER);
if (!in_array($code, (array) $expect)) {
if (!in_array($code, (array) $expect, true)) {
$this->setError(
"$command command failed",
$detail,
@ -1045,9 +1045,9 @@ class SMTP
{
//If SMTP transcripts are left enabled, or debug output is posted online
//it can leak credentials, so hide credentials in all but lowest level
if (self::DEBUG_LOWLEVEL > $this->do_debug and
if (self::DEBUG_LOWLEVEL > $this->do_debug &&
in_array($command, ['User & Password', 'Username', 'Password'], true)) {
$this->edebug('CLIENT -> SERVER: <credentials hidden>', self::DEBUG_CLIENT);
$this->edebug('CLIENT -> SERVER: [credentials hidden]', self::DEBUG_CLIENT);
} else {
$this->edebug('CLIENT -> SERVER: ' . $data, self::DEBUG_CLIENT);
}
@ -1093,26 +1093,26 @@ class SMTP
*
* @param string $name Name of SMTP extension or 'HELO'|'EHLO'
*
* @return mixed
* @return null|string|bool
*/
public function getServerExt($name)
{
if (!$this->server_caps) {
$this->setError('No HELO/EHLO was sent');
return;
return null;
}
if (!array_key_exists($name, $this->server_caps)) {
if ('HELO' == $name) {
if ('HELO' === $name) {
return $this->server_caps['EHLO'];
}
if ('EHLO' == $name || array_key_exists('EHLO', $this->server_caps)) {
if ('EHLO' === $name || array_key_exists('EHLO', $this->server_caps)) {
return false;
}
$this->setError('HELO handshake was used; No information about server extensions available');
return;
return null;
}
return $this->server_caps[$name];
@ -1151,7 +1151,7 @@ class SMTP
}
$selR = [$this->smtp_conn];
$selW = null;
while (is_resource($this->smtp_conn) and !feof($this->smtp_conn)) {
while (is_resource($this->smtp_conn) && !feof($this->smtp_conn)) {
//Must pass vars in here as params are by reference
if (!stream_select($selR, $selW, $selW, $this->Timelimit)) {
$this->edebug(
@ -1167,7 +1167,7 @@ class SMTP
// If response is only 3 chars (not valid, but RFC5321 S4.2 says it must be handled),
// or 4th character is a space, we are done reading, break the loop,
// string array access is a micro-optimisation over strlen
if (!isset($str[3]) or (isset($str[3]) and $str[3] == ' ')) {
if (!isset($str[3]) || (isset($str[3]) && $str[3] === ' ')) {
break;
}
// Timed-out? Log and break
@ -1180,7 +1180,7 @@ class SMTP
break;
}
// Now check if reads took too long
if ($endtime and time() > $endtime) {
if ($endtime && time() > $endtime) {
$this->edebug(
'SMTP -> get_lines(): timelimit reached (' .
$this->Timelimit . ' sec)',