Mailsender::Prepare() - Code Metrics - fwolf/fwlib - Measure and Improve Code Quality continuously with Scrutinizer

Mailsender::Prepare() A
last analyzed 2019-05-09 15:53 UTC

↳ Parent: Mailsender

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	4
nop	0
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php
/**
 * @package		fwolflib
 * @subpackage	class
 * @copyright	Copyright 2007-2008, Fwolf
 * @author		Fwolf <[email protected]>
 */


require_once(dirname(__FILE__) . '/fwolflib.php');
require_once("phpmailer/class.phpmailer.php");


/**
 * Mail Sender
 *
 * Subclass of PHPMailer, make it easier to use.
 *
 * Usage:
 * <code>
 * $m = new MailSender();
 * $m->SetHost('ssl://smtp.gmail.com', 465, true);
 * $m->SetTo($mail_to);
 * $m->SetFrom('Who send it ?');
 * $m->SetAuth($mail_user, $mail_pass);
 * $m->SetSubject($mail_subject);
 * $m->SetBody($mail_body);
 * $m->SetAttach($mail_attach);
 * $m->Send();
 * </code>
 *
 * @deprecated  Use Fwlib\Bridge\PHPMailer
 * @package		fwolflib
 * @subpackage	class
 * @copyright	Copyright 2007-2008, Fwolf
 * @author		Fwolf <[email protected]>
 * @since		2007-03-29
 * @version		$Id$
 */
class Mailsender extends PHPMailer
{
	/**
	 * Mail attachment
	 * Array of string
	 * @var	array
	 */
	public $mAttach = array();

	/**
	 * Mail body
	 * @var	string
	 */
	public $mBody = '';

	/**
	 * Charset of mail
	 * @var	string
	 */
	public $mCharset = 'utf-8';

	/**
	 * Encoding method of mail body
	 * @var	string
	 */
	public $mEncoding = 'base64';

	/**
	 * Error count
	 * Reset when mail send success
	 * @var	int
	 */
	public $mErrorCount = 0;

	/**
	 * Error message
	 * Reset when mail send success
	 * @var string
	 */
	public $mErrorMsg = '';

	/**
	 * Mail from address
	 * @var	string
	 */
	public $mFrom = '';

	/**
	 * Mail from name
	 * @var	string
	 */
	public $mFromName = 'Aliens';

	/**
	 * Mail host
	 * Don't include port number
	 * @see	$mPort
	 * @var	string
	 */
	public $mHost = '';

	/**
	 * Html format mail ?
	 * @var	boolean
	 */
	public $mIsHtml = false;

	/**
	 * Auth type
	 * Smtp default.
	 * @var	string
	 */
	public $mIsSmtp = true;

	/**
	 * Pass to login mail host
	 * @var	string
	 */
	public $mPass = '';

	/**
	 * Mail host port number
	 * @var	int
	 */
	public $mPort = 25;

	/**
	 * Keep smtp connection to furture useage ?
	 * Var in phpmailer is $SMTPKeepAlive default false
	 * @var	boolean
	 */
	public $mSmtpKeepAlive = false;

	/**
	 * Subject of mail
	 * @var	string
	 */
	public $mSubject = '';

	/**
	 * Address to be mailed to
	 * Parsed data, always is an array
	 * @var	array
	 */
	public $mTo = array();

	/**
	 * Username on mail host
	 * Some host is xxx, while some is [email protected]
	 * @var	string
	 */
	public $mUser = '';


	/**
	 * Construct
	 */
	public function __construct()
	{
		//parent::PHPMailer();
	} // end of func construct


	/**
	 * Parse mail to address
	 * Input any type address, output standard array of address
	 * Parse string including email name and address to address=>name array.
	 *
	 * @var	mixed	$to
	 * @return	array
	 */
	public function ParseTo($to)
	{
		if (is_array($to))
			return $to;
		else
		{
			//$addresses = ',,,;;; "@1>"1<1 ,\';" <[email protected]> , [email protected], f <[email protected]> ,,[email protected],;;; ';
			//$addresses = ', [email protected]';

			//First, find all mail address out
			$j = preg_match_all('/[\s<]?([\w\d\-_\.\+]+@([\w\d\-_]+\.){1,4}\w+)[\s>]?/', $to, $addr_addr);

			//if got addresses, find names according there position in string
			$addr = array();
			if (0 < $j)
			{
				$addr_addr = $addr_addr[1];
				for ($i=0; $i<$j; $i++)

				{
					//this can always find
					$k = strpos($to, $addr_addr[$i]);
					$name = substr($to, 0, $k);
					//prepare for next loop
					$to= substr($to, $k + strlen($addr_addr[$i]));
					//trim string we parsed out
					$name = trim($name, ' \t<>;,"');
					//gerenate addr array like address=>name style
					$addr[$addr_addr[$i]] = $name;
				}
				//foreach ($addr as $key=>$val)
				//	echo $key . '=>' . $val . "\n";
			}
			return($addr);
		}
	} // end of func ParseTo


	/**
	 * Prepare - Common setup
	 */
	public function Prepare()
	{
		// NOTICE --> Char'S'et
		$this->CharSet = $this->mCharset;
		$this->Encoding = $this->mEncoding;
		if (true == $this->mIsSmtp)

			$this->IsSMTP();
		if (true == $this->mIsHtml)

			$this->IsHTML(true);
		else
			$this->IsHTML(false);
	} // end of func Prepare


	/**
	 * Send mail
	 * @param	string	$from	Only [email protected] format, no fromname
	 * @param	mixed	$to
	 * @param	string	$subject
	 * @param	string	$body
	 * @param	mixed	$attach
	 * @return	boolean
	 */
	public function Send($from = '', $to = '', $subject = '', $body = '', $attach = '')
	{
		$this->Prepare();
		if (!empty($from))
			$this->SetFrom($from);
		if (!empty($to))
			$this->SetTo($to);
		if (!empty($subject))
			$this->SetSubject($subject);
		if (!empty($body))
			$this->SetBody($body);
		if (!empty($attach))
			$this->SetAttach($attach);

		$sok = parent::Send();
		if (false == $sok)
		{
			$this->mErrorCount ++;
			$this->mErrorMsg = $this->ErrorInfo;
		}
		else
		{
			$this->mErrorCount = 0;
			$this->mErrorMsg = '';
		}

		if (false == $this->mSmtpKeepAlive)

			$this->SmtpClose();
		return $sok;
	} // end of function Send


	/**
	 * Set mail attachment
	 * @param	mixed	$attach
	 */
	public function SetAttach($attach)
	{
		if (is_array($attach))
		{
			$this->mAttach = &$attach;
			$this->ClearAttachments();
			foreach ($attach as $att)
				$this->AddAttachment($att);
		}
		elseif (!empty($attach))
		{
			$this->mAttach = array($attach);
			$this->AddAttachment($attach);
		}
	} // end of func SetAttach


	/**
	 * Set host auth information
	 * @param	string	$userid
	 * @param	string	$passwd
	 */
	public function SetAuth($userid, $passwd)
	{
		$this->mUser = $userid;
		$this->mPass = $passwd;
		$this->Username = $this->mUser;
		$this->Password = $this->mPass;
	} // end of func SetAuth


	/**
	 * Set mail body content
	 * @param	string	$body
	 */
	public function SetBody($body)
	{
		$this->mBody = $body;
		$this->Body = $this->mBody;
	} // end of func SetBody


	/**
	 * Set from & from name
	 * @param	string	$from
	 * @param	string	$fromname
	 */
	public function SetFrom($from, $fromname = 'Aliens')
	{
		$this->mFrom = $from;
		$this->mFromName = $fromname;
		$this->From = $this->mFrom;
		$this->FromName = $this->mFromName;
	} // end of func SetFrom


	/**
	 * Set host information
	 * @param	string	$addr
	 * @param	int		$port
	 * @param	boolean	$issmtp
	 */
	public function SetHost($addr, $port = 25, $issmtp = true)
	{
		$this->mHost = $addr;
		$this->mPort = $port;
		$this->mIsSmtp = $issmtp;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		$this->Host = $this->mHost;
		$this->Port = $this->mPort;
		$this->SMTPAuth = $this->mIsSmtp;
	} // end of func SetHost


	/**
	 * Set mail subject
	 * @param	string	$sub
	 */
	public function SetSubject($sub)
	{
		$this->mSubject = $sub;
		$this->Subject = $this->mSubject;
	} // end of func SetSubject


	/**
	 * Set address to mail to
	 * @param	mixed	$to
	 */
	public function SetTo($to)
	{
		$to_ar = $this->ParseTo($to);
		$this->mTo = &$to_ar;
		$this->ClearAddresses();
		foreach ($to_ar as $key => $val)
			$this->AddAddress($key, $val);
	} // end of func SetTo

}
?>



1		<?php
2		/**
3		* @package fwolflib
4		* @subpackage class
5		* @copyright Copyright 2007-2008, Fwolf
6		* @author Fwolf <[email protected]>
7		*/
8
9
10		require_once(dirname(__FILE__) . '/fwolflib.php');
11		require_once("phpmailer/class.phpmailer.php");
12
13
14		/**
15		* Mail Sender
16		*
17		* Subclass of PHPMailer, make it easier to use.
18		*
19		* Usage:
20		* <code>
21		* $m = new MailSender();
22		* $m->SetHost('ssl://smtp.gmail.com', 465, true);
23		* $m->SetTo($mail_to);
24		* $m->SetFrom('Who send it ?');
25		* $m->SetAuth($mail_user, $mail_pass);
26		* $m->SetSubject($mail_subject);
27		* $m->SetBody($mail_body);
28		* $m->SetAttach($mail_attach);
29		* $m->Send();
30		* </code>
31		*
32		* @deprecated Use Fwlib\Bridge\PHPMailer
33		* @package fwolflib
34		* @subpackage class
35		* @copyright Copyright 2007-2008, Fwolf
36		* @author Fwolf <[email protected]>
37		* @since 2007-03-29
38		* @version $Id$
39		*/
40		class Mailsender extends PHPMailer
41		{
42		/**
43		* Mail attachment
44		* Array of string
45		* @var array
46		*/
47		public $mAttach = array();
48
49		/**
50		* Mail body
51		* @var string
52		*/
53		public $mBody = '';
54
55		/**
56		* Charset of mail
57		* @var string
58		*/
59		public $mCharset = 'utf-8';
60
61		/**
62		* Encoding method of mail body
63		* @var string
64		*/
65		public $mEncoding = 'base64';
66
67		/**
68		* Error count
69		* Reset when mail send success
70		* @var int
71		*/
72		public $mErrorCount = 0;
73
74		/**
75		* Error message
76		* Reset when mail send success
77		* @var string
78		*/
79		public $mErrorMsg = '';
80
81		/**
82		* Mail from address
83		* @var string
84		*/
85		public $mFrom = '';
86
87		/**
88		* Mail from name
89		* @var string
90		*/
91		public $mFromName = 'Aliens';
92
93		/**
94		* Mail host
95		* Don't include port number
96		* @see $mPort
97		* @var string
98		*/
99		public $mHost = '';
100
101		/**
102		* Html format mail ?
103		* @var boolean
104		*/
105		public $mIsHtml = false;
106
107		/**
108		* Auth type
109		* Smtp default.
110		* @var string
111		*/
112		public $mIsSmtp = true;
113
114		/**
115		* Pass to login mail host
116		* @var string
117		*/
118		public $mPass = '';
119
120		/**
121		* Mail host port number
122		* @var int
123		*/
124		public $mPort = 25;
125
126		/**
127		* Keep smtp connection to furture useage ?
128		* Var in phpmailer is $SMTPKeepAlive default false
129		* @var boolean
130		*/
131		public $mSmtpKeepAlive = false;
132
133		/**
134		* Subject of mail
135		* @var string
136		*/
137		public $mSubject = '';
138
139		/**
140		* Address to be mailed to
141		* Parsed data, always is an array
142		* @var array
143		*/
144		public $mTo = array();
145
146		/**
147		* Username on mail host
148		* Some host is xxx, while some is [email protected]
149		* @var string
150		*/
151		public $mUser = '';
152
153
154		/**
155		* Construct
156		*/
157		public function __construct()
158		{
159		//parent::PHPMailer();
160		} // end of func construct
161
162
163		/**
164		* Parse mail to address
165		* Input any type address, output standard array of address
166		* Parse string including email name and address to address=>name array.
167		*
168		* @var mixed $to
169		* @return array
170		*/
171		public function ParseTo($to)
172		{
173		if (is_array($to))
174		return $to;
175		else
176		{
177		//$addresses = ',,,;;; "@1>"1<1 ,\';" <[email protected]> , [email protected], f <[email protected]> ,,[email protected],;;; ';
178		//$addresses = ', [email protected]';
179
180		//First, find all mail address out
181		$j = preg_match_all('/[\s<]?([\w\d\-_\.\+]+@([\w\d\-_]+\.){1,4}\w+)[\s>]?/', $to, $addr_addr);
182
183		//if got addresses, find names according there position in string
184		$addr = array();
185		if (0 < $j)
186		{
187		$addr_addr = $addr_addr[1];
188	View Code Duplication	for ($i=0; $i<$j; $i++)
		0 ignored issues – show Duplication introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
189		{
190		//this can always find
191		$k = strpos($to, $addr_addr[$i]);
192		$name = substr($to, 0, $k);
193		//prepare for next loop
194		$to= substr($to, $k + strlen($addr_addr[$i]));
195		//trim string we parsed out
196		$name = trim($name, ' \t<>;,"');
197		//gerenate addr array like address=>name style
198		$addr[$addr_addr[$i]] = $name;
199		}
200		//foreach ($addr as $key=>$val)
201		// echo $key . '=>' . $val . "\n";
202		}
203		return($addr);
204		}
205		} // end of func ParseTo
206
207
208		/**
209		* Prepare - Common setup
210		*/
211		public function Prepare()
212		{
213		// NOTICE --> Char'S'et
214		$this->CharSet = $this->mCharset;
215		$this->Encoding = $this->mEncoding;
216		if (true == $this->mIsSmtp)
		0 ignored issues – show Bug Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$this->mIsSmtp` of type `string` to the boolean `true`. If you are specifically checking for a non-empty string, consider using the more explicit `!== ''` instead. Loading history...
217		$this->IsSMTP();
218		if (true == $this->mIsHtml)
		0 ignored issues – show Coding Style Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
219		$this->IsHTML(true);
220		else
221		$this->IsHTML(false);
222		} // end of func Prepare
223
224
225		/**
226		* Send mail
227		* @param string $from Only [email protected] format, no fromname
228		* @param mixed $to
229		* @param string $subject
230		* @param string $body
231		* @param mixed $attach
232		* @return boolean
233		*/
234		public function Send($from = '', $to = '', $subject = '', $body = '', $attach = '')
235		{
236		$this->Prepare();
237		if (!empty($from))
238		$this->SetFrom($from);
239		if (!empty($to))
240		$this->SetTo($to);
241		if (!empty($subject))
242		$this->SetSubject($subject);
243		if (!empty($body))
244		$this->SetBody($body);
245		if (!empty($attach))
246		$this->SetAttach($attach);
247
248		$sok = parent::Send();
249		if (false == $sok)
250		{
251		$this->mErrorCount ++;
252		$this->mErrorMsg = $this->ErrorInfo;
253		}
254		else
255		{
256		$this->mErrorCount = 0;
257		$this->mErrorMsg = '';
258		}
259
260		if (false == $this->mSmtpKeepAlive)
		0 ignored issues – show Coding Style Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
261		$this->SmtpClose();
262		return $sok;
263		} // end of function Send
264
265
266		/**
267		* Set mail attachment
268		* @param mixed $attach
269		*/
270		public function SetAttach($attach)
271		{
272		if (is_array($attach))
273		{
274		$this->mAttach = &$attach;
275		$this->ClearAttachments();
276		foreach ($attach as $att)
277		$this->AddAttachment($att);
278		}
279		elseif (!empty($attach))
280		{
281		$this->mAttach = array($attach);
282		$this->AddAttachment($attach);
283		}
284		} // end of func SetAttach
285
286
287		/**
288		* Set host auth information
289		* @param string $userid
290		* @param string $passwd
291		*/
292		public function SetAuth($userid, $passwd)
293		{
294		$this->mUser = $userid;
295		$this->mPass = $passwd;
296		$this->Username = $this->mUser;
297		$this->Password = $this->mPass;
298		} // end of func SetAuth
299
300
301		/**
302		* Set mail body content
303		* @param string $body
304		*/
305		public function SetBody($body)
306		{
307		$this->mBody = $body;
308		$this->Body = $this->mBody;
309		} // end of func SetBody
310
311
312		/**
313		* Set from & from name
314		* @param string $from
315		* @param string $fromname
316		*/
317		public function SetFrom($from, $fromname = 'Aliens')
318		{
319		$this->mFrom = $from;
320		$this->mFromName = $fromname;
321		$this->From = $this->mFrom;
322		$this->FromName = $this->mFromName;
323		} // end of func SetFrom
324
325
326		/**
327		* Set host information
328		* @param string $addr
329		* @param int $port
330		* @param boolean $issmtp
331		*/
332		public function SetHost($addr, $port = 25, $issmtp = true)
333		{
334		$this->mHost = $addr;
335		$this->mPort = $port;
336		$this->mIsSmtp = $issmtp;
		0 ignored issues – show Documentation Bug introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report The property `$mIsSmtp` was declared of type `string`, but `$issmtp` is of type `boolean`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
337		$this->Host = $this->mHost;
338		$this->Port = $this->mPort;
339		$this->SMTPAuth = $this->mIsSmtp;
340		} // end of func SetHost
341
342
343		/**
344		* Set mail subject
345		* @param string $sub
346		*/
347		public function SetSubject($sub)
348		{
349		$this->mSubject = $sub;
350		$this->Subject = $this->mSubject;
351		} // end of func SetSubject
352
353
354		/**
355		* Set address to mail to
356		* @param mixed $to
357		*/
358		public function SetTo($to)
359		{
360		$to_ar = $this->ParseTo($to);
361		$this->mTo = &$to_ar;
362		$this->ClearAddresses();
363		foreach ($to_ar as $key => $val)
364		$this->AddAddress($key, $val);
365		} // end of func SetTo
366
367		}
368		?>
		0 ignored issues – show Best Practice introduced 2016-06-01 06:17 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
369

fwolf / fwlib

Mailsender::Prepare() A last analyzed 2019-05-09 15:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Mailsender::Prepare() A
last analyzed 2019-05-09 15:53 UTC