Mail::sendMailWithPHPMailer() - Code Metrics - panique/huge - Measure and Improve Code Quality continuously with Scrutinizer

Mail::sendMailWithPHPMailer() B
last analyzed 2020-05-13 16:02 UTC

↳ Parent: Mail

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	8.9599
c	0
b	0
f	0
cc	4
nc	6
nop	5

How to fix Long Method

<?php

/* Using PHPMailer's namespace */
use PHPMailer\PHPMailer\PHPMailer;

/**
 * Class Mail
 *
 * Handles everything regarding mail-sending.
 */
class Mail
{
    /** @var mixed variable to collect errors */
    private $error;

    /**
     * Try to send a mail by using PHP's native mail() function.
     * Please note that not PHP itself will send a mail, it's just a wrapper for Linux's sendmail or other mail tools
     *
     * Good guideline on how to send mails natively with mail():
     * @see http://stackoverflow.com/a/24644450/1114320
     * @see http://www.php.net/manual/en/function.mail.php
     */
    public function sendMailWithNativeMailFunction()
    {
        // no code yet, so we just return something to make IDEs and code analyzer tools happy
        return false;
    }

    /**
     * Try to send a mail by using SwiftMailer.
     * Make sure you have loaded SwiftMailer via Composer.
     *
     * @return bool
     */
    public function sendMailWithSwiftMailer()
    {
        // no code yet, so we just return something to make IDEs and code analyzer tools happy
        return false;
    }

    /**
     * Try to send a mail by using PHPMailer.
     * Make sure you have loaded PHPMailer via Composer.
     * Depending on your EMAIL_USE_SMTP setting this will work via SMTP credentials or via native mail()
     *
     * @param $user_email
     * @param $from_email
     * @param $from_name
     * @param $subject
     * @param $body
     *
     * @return bool
     * @throws Exception
     * @throws phpmailerException
     */
    public function sendMailWithPHPMailer($user_email, $from_email, $from_name, $subject, $body)
    {
        $mail = new PHPMailer;
        
        // you should use UTF-8 to avoid encoding issues
        $mail->CharSet = 'UTF-8';

        // if you want to send mail via PHPMailer using SMTP credentials
        if (Config::get('EMAIL_USE_SMTP')) {

            // set PHPMailer to use SMTP
            $mail->IsSMTP();

            // 0 = off, 1 = commands, 2 = commands and data, perfect to see SMTP errors
            $mail->SMTPDebug = 0;

            // enable SMTP authentication
            $mail->SMTPAuth = Config::get('EMAIL_SMTP_AUTH');

            // encryption
            if (Config::get('EMAIL_SMTP_ENCRYPTION')) {
                $mail->SMTPSecure = Config::get('EMAIL_SMTP_ENCRYPTION');
            }

            // set SMTP provider's credentials
            $mail->Host = Config::get('EMAIL_SMTP_HOST');
            $mail->Username = Config::get('EMAIL_SMTP_USERNAME');
            $mail->Password = Config::get('EMAIL_SMTP_PASSWORD');
            $mail->Port = Config::get('EMAIL_SMTP_PORT');

        } else {

            $mail->IsMail();
        }

        // fill mail with data
        $mail->From = $from_email;
        $mail->FromName = $from_name;
        $mail->AddAddress($user_email);
        $mail->Subject = $subject;
        $mail->Body = $body;

        // try to send mail, put result status (true/false into $wasSendingSuccessful)
        // I'm unsure if mail->send really returns true or false every time, tis method in PHPMailer is quite complex
        $wasSendingSuccessful = $mail->Send();

        if ($wasSendingSuccessful) {
            return true;

        } else {

            // if not successful, copy errors into Mail's error property
            $this->error = $mail->ErrorInfo;
            return false;
        }
    }

    /**
     * The main mail sending method, this simply calls a certain mail sending method depending on which mail provider
     * you've selected in the application's config.
     *
     * @param $user_email string email
     * @param $from_email string sender's email
     * @param $from_name string sender's name
     * @param $subject string subject
     * @param $body string full mail body text
     * @return bool the success status of the according mail sending method
     */
    public function sendMail($user_email, $from_email, $from_name, $subject, $body)
    {
        if (Config::get('EMAIL_USED_MAILER') == "phpmailer") {

            // returns true if successful, false if not
            return $this->sendMailWithPHPMailer(
                $user_email, $from_email, $from_name, $subject, $body
            );
        }

        if (Config::get('EMAIL_USED_MAILER') == "swiftmailer") {
            return $this->sendMailWithSwiftMailer();
        }

        if (Config::get('EMAIL_USED_MAILER') == "native") {
            return $this->sendMailWithNativeMailFunction();
        }
    }

    /**
     * The different mail sending methods write errors to the error property $this->error,
     * this method simply returns this error / error array.
     *
     * @return mixed
     */
    public function getError()
    {
        return $this->error;
    }
}


1			<?php
2
3			/* Using PHPMailer's namespace */
4			use PHPMailer\PHPMailer\PHPMailer;
5
6			/**
7			* Class Mail
8			*
9			* Handles everything regarding mail-sending.
10			*/
11			class Mail
12			{
13			/** @var mixed variable to collect errors */
14			private $error;
15
16			/**
17			* Try to send a mail by using PHP's native mail() function.
18			* Please note that not PHP itself will send a mail, it's just a wrapper for Linux's sendmail or other mail tools
19			*
20			* Good guideline on how to send mails natively with mail():
21			* @see http://stackoverflow.com/a/24644450/1114320
22			* @see http://www.php.net/manual/en/function.mail.php
23			*/
24			public function sendMailWithNativeMailFunction()
25			{
26			// no code yet, so we just return something to make IDEs and code analyzer tools happy
27			return false;
28			}
29
30			/**
31			* Try to send a mail by using SwiftMailer.
32			* Make sure you have loaded SwiftMailer via Composer.
33			*
34			* @return bool
35			*/
36			public function sendMailWithSwiftMailer()
37			{
38			// no code yet, so we just return something to make IDEs and code analyzer tools happy
39			return false;
40			}
41
42			/**
43			* Try to send a mail by using PHPMailer.
44			* Make sure you have loaded PHPMailer via Composer.
45			* Depending on your EMAIL_USE_SMTP setting this will work via SMTP credentials or via native mail()
46			*
47			* @param $user_email
48			* @param $from_email
49			* @param $from_name
50			* @param $subject
51			* @param $body
52			*
53			* @return bool
54			* @throws Exception
55			* @throws phpmailerException
56			*/
57			public function sendMailWithPHPMailer($user_email, $from_email, $from_name, $subject, $body)
58			{
59			$mail = new PHPMailer;
60
61			// you should use UTF-8 to avoid encoding issues
62			$mail->CharSet = 'UTF-8';
63
64			// if you want to send mail via PHPMailer using SMTP credentials
65			if (Config::get('EMAIL_USE_SMTP')) {
66
67			// set PHPMailer to use SMTP
68			$mail->IsSMTP();
69
70			// 0 = off, 1 = commands, 2 = commands and data, perfect to see SMTP errors
71			$mail->SMTPDebug = 0;
72
73			// enable SMTP authentication
74			$mail->SMTPAuth = Config::get('EMAIL_SMTP_AUTH');
75
76			// encryption
77			if (Config::get('EMAIL_SMTP_ENCRYPTION')) {
78			$mail->SMTPSecure = Config::get('EMAIL_SMTP_ENCRYPTION');
79			}
80
81			// set SMTP provider's credentials
82			$mail->Host = Config::get('EMAIL_SMTP_HOST');
83			$mail->Username = Config::get('EMAIL_SMTP_USERNAME');
84			$mail->Password = Config::get('EMAIL_SMTP_PASSWORD');
85			$mail->Port = Config::get('EMAIL_SMTP_PORT');
86
87			} else {
88
89			$mail->IsMail();
90			}
91
92			// fill mail with data
93			$mail->From = $from_email;
94			$mail->FromName = $from_name;
95			$mail->AddAddress($user_email);
96			$mail->Subject = $subject;
97			$mail->Body = $body;
98
99			// try to send mail, put result status (true/false into $wasSendingSuccessful)
100			// I'm unsure if mail->send really returns true or false every time, tis method in PHPMailer is quite complex
101			$wasSendingSuccessful = $mail->Send();
102
103			if ($wasSendingSuccessful) {
104			return true;
105
106			} else {
107
108			// if not successful, copy errors into Mail's error property
109			$this->error = $mail->ErrorInfo;
110			return false;
111			}
112			}
113
114			/**
115			* The main mail sending method, this simply calls a certain mail sending method depending on which mail provider
116			* you've selected in the application's config.
117			*
118			* @param $user_email string email
119			* @param $from_email string sender's email
120			* @param $from_name string sender's name
121			* @param $subject string subject
122			* @param $body string full mail body text
123			* @return bool the success status of the according mail sending method
124			*/
125			public function sendMail($user_email, $from_email, $from_name, $subject, $body)
126			{
127			if (Config::get('EMAIL_USED_MAILER') == "phpmailer") {
128
129			// returns true if successful, false if not
130			return $this->sendMailWithPHPMailer(
131			$user_email, $from_email, $from_name, $subject, $body
132			);
133			}
134
135			if (Config::get('EMAIL_USED_MAILER') == "swiftmailer") {
136			return $this->sendMailWithSwiftMailer();
137			}
138
139			if (Config::get('EMAIL_USED_MAILER') == "native") {
140			return $this->sendMailWithNativeMailFunction();
141			}
142			}
143
144			/**
145			* The different mail sending methods write errors to the error property $this->error,
146			* this method simply returns this error / error array.
147			*
148			* @return mixed
149			*/
150			public function getError()
151			{
152			return $this->error;
153			}
154			}
155

panique / huge

GitHub Access Token became invalid

Mail::sendMailWithPHPMailer() B last analyzed 2020-05-13 16:02 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

Mail::sendMailWithPHPMailer() B
last analyzed 2020-05-13 16:02 UTC