Replyable::message() - Code Metrics - Inspection of "Update Replyable.php to fix threading when reply" - dacastro4/laravel-gmail - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#232)

unknown

created 2022-06-23 17:58 UTC

Replyable::message() A

↳ Parent: Replyable

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
rs	10

<?php

namespace Dacastro4\LaravelGmail\Traits;

use Dacastro4\LaravelGmail\Services\Message\Mail;
use Google_Service_Gmail;
use Google_Service_Gmail_Message;
use Swift_Attachment;
use Swift_Message;
use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;

/**
 * @property Google_Service_Gmail $service
 */
trait Replyable
{
	use HasHeaders;

	private $swiftMessage;

	/**
	 * Gmail optional parameters
	 *
	 * @var array
	 */
	private $parameters = [];

	/**
	 * Text or html message to send
	 *
	 * @var string
	 */
	private $message;

	/**
	 * Subject of the email
	 *
	 * @var string
	 */
	private $subject;

	/**
	 * Sender's email
	 *
	 * @var string
	 */
	private $from;

	/**
	 * Sender's name
	 *
	 * @var  string
	 */
	private $nameFrom;

	/**
	 * Email of the recipient
	 *
	 * @var string|array
	 */
	private $to;

	/**
	 * Name of the recipient
	 *
	 * @var string
	 */
	private $nameTo;

	/**
	 * Single email or array of email for a carbon copy
	 *
	 * @var array|string
	 */
	private $cc;

	/**
	 * Name of the recipient
	 *
	 * @var string
	 */
	private $nameCc;

	/**
	 * Single email or array of email for a blind carbon copy
	 *
	 * @var array|string
	 */
	private $bcc;

	/**
	 * Name of the recipient
	 *
	 * @var string
	 */
	private $nameBcc;

	/**
	 * List of attachments
	 *
	 * @var array
	 */
	private $attachments = [];

	private $priority = 2;

	public function __construct()
	{
		$this->swiftMessage = new Swift_Message();
	}

	/**
	 * Receives the recipient's
	 * If multiple recipients will receive the message an array should be used.
	 * Example: array('[email protected]', '[email protected]' => 'A name')
	 *
	 * If $name is passed and the first parameter is a string, this name will be
	 * associated with the address.
	 *
	 * @param  string|array  $to
	 *
	 * @param  string|null  $name
	 *
	 * @return Replyable
	 */
	public function to($to, $name = null)
	{
		$this->to = $to;
		$this->nameTo = $name;

		return $this;
	}

	public function from($from, $name = null)
	{
		$this->from = $from;
		$this->nameFrom = $name;

		return $this;
	}

	/**
	 * @param  array|string  $cc
	 *
	 * @param  string|null  $name
	 *
	 * @return Replyable
	 */
	public function cc($cc, $name = null)
	{
		$this->cc = $this->emailList($cc, $name);
		$this->nameCc = $name;

		return $this;
	}

	private function emailList($list, $name = null)
	{
		if (is_array($list)) {
			return $this->convertEmailList($list, $name);
		} else {
			return $list;
		}
	}

	private function convertEmailList($emails, $name = null)
	{
		$newList = [];
		$count = 0;
		foreach ($emails as $key => $email) {
			$emailName = isset($name[$count]) ? $name[$count] : explode('@', $email)[0];
			$newList[$email] = $emailName;
			$count = $count + 1;
		}

		return $newList;
	}

	/**
	 * @param  array|string  $bcc
	 *
	 * @param  string|null  $name
	 *
	 * @return Replyable
	 */
	public function bcc($bcc, $name = null)
	{
		$this->bcc = $this->emailList($bcc, $name);
		$this->nameBcc = $name;

		return $this;
	}

	/**
	 * @param  string  $subject
	 *
	 * @return Replyable
	 */
	public function subject($subject)
	{
		$this->subject = $subject;

		return $this;
	}

	/**
	 * @param  string  $view
	 * @param  array  $data
	 * @param  array  $mergeData
	 *
	 * @return Replyable
	 * @throws \Throwable
	 */
	public function view($view, $data = [], $mergeData = [])
	{
		$this->message = view($view, $data, $mergeData)->render();

		return $this;
	}

	/**
	 * @param  string  $message
	 *
	 * @return Replyable
	 */
	public function message($message)
	{
		$this->message = $message;

		return $this;
	}

	/**
	 * Attaches new file to the email from the Storage folder
	 *
	 * @param  array  $files  comma separated of files
	 *
	 * @return Replyable
	 * @throws \Exception
	 */
	public function attach(...$files)
	{

		foreach ($files as $file) {

			if (!file_exists($file)) {
				throw new FileNotFoundException($file);
			}

			array_push($this->attachments, $file);
		}

		return $this;
	}

	/**
	 * The value is an integer where 1 is the highest priority and 5 is the lowest.
	 *
	 * @param  int  $priority
	 *
	 * @return Replyable
	 */
	public function priority($priority)
	{
		$this->priority = $priority;

		return $this;
	}

	/**
	 * @param  array  $parameters
	 *
	 * @return Replyable
	 */
	public function optionalParameters(array $parameters)
	{
		$this->parameters = $parameters;

		return $this;
	}

	/**
	 * Reply to a specific email
	 *
	 * @return Mail
	 * @throws \Exception
	 */
	public function reply()
	{
		if (!$this->getId()) {
			throw new \Exception('This is a new email. Use send().');
		}

		$this->setReplyThread();
		$this->setReplySubject();
		$this->setReplyTo();
		$this->setReplyFrom();
		$body = $this->getMessageBody();
		$body->setThreadId($this->getThreadId());

		return new Mail($this->service->users_messages->send('me', $body, $this->parameters));
	}

	public abstract function getId();

	private function setReplyThread()
	{
		$threadId = $this->getThreadId();
		if ($threadId) {
			$this->setHeader('In-Reply-To', $this->getMessageIdHeader());
			$this->setHeader('References', $this->getHeader('References'));
			$this->setHeader('Message-ID', $this->getMessageIdHeader());
		}
	}
	
	private function getMessageIdHeader() {
		if($this->getHeader('Message-ID')) {
			return $this->getHeader('Message-ID');
		}
		if($this->getHeader('Message-Id')) {
			return $this->getHeader('Message-Id');
		}
		return null;
	}

	public abstract function getThreadId();

	/**
	 * Add a header to the email
	 *
	 * @param  string  $header
	 * @param  string  $value
	 */
	public function setHeader($header, $value)
	{
		$headers = $this->swiftMessage->getHeaders();

		$headers->addTextHeader($header, $value);

	}

	private function setReplySubject()
	{
		if (!$this->subject) {
			$this->subject = $this->getSubject();
		}
	}

	private function setReplyTo()
	{
		if (!$this->to) {
			$replyTo = $this->getReplyTo();

			$this->to = $replyTo['email'];
			$this->nameTo = $replyTo['name'];
		}
	}

	private function setReplyFrom()
	{
		if (!$this->from) {
			$this->from = $this->getUser();
			if(!$this->from) {
				throw new \Exception('Reply from is not defined');
			}
		}
	}

	public abstract function getSubject();

	public abstract function getReplyTo();

	public abstract function getUser();

	/**
	 * @return Google_Service_Gmail_Message
	 */
	private function getMessageBody()
	{
		$body = new Google_Service_Gmail_Message();

		$this->swiftMessage
			->setSubject($this->subject)
			->setFrom($this->from, $this->nameFrom)
			->setTo($this->to, $this->nameTo)
			->setCc($this->cc, $this->nameCc)
			->setBcc($this->bcc, $this->nameBcc)
			->setBody($this->message, 'text/html')
			->setPriority($this->priority);

		foreach ($this->attachments as $file) {
			$this->swiftMessage
				->attach(Swift_Attachment::fromPath($file));
		}

		$body->setRaw($this->base64_encode($this->swiftMessage->toString()));

		return $body;
	}

	private function base64_encode($data)
	{
		return rtrim(strtr(base64_encode($data), ['+' => '-', '/' => '_']), '=');
	}

	/**
	 * Sends a new email
	 *
	 * @return self|Mail
	 */
	public function send()
	{
		$body = $this->getMessageBody();

		$this->setMessage($this->service->users_messages->send('me', $body, $this->parameters));

		return $this;
	}

	protected abstract function setMessage(\Google_Service_Gmail_Message $message);
}


1			<?php
2
3			namespace Dacastro4\LaravelGmail\Traits;
4
5			use Dacastro4\LaravelGmail\Services\Message\Mail;
6			use Google_Service_Gmail;
7			use Google_Service_Gmail_Message;
8			use Swift_Attachment;
9			use Swift_Message;
10			use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;
11
12			/**
13			* @property Google_Service_Gmail $service
14			*/
15			trait Replyable
16			{
17			use HasHeaders;
18
19			private $swiftMessage;
20
21			/**
22			* Gmail optional parameters
23			*
24			* @var array
25			*/
26			private $parameters = [];
27
28			/**
29			* Text or html message to send
30			*
31			* @var string
32			*/
33			private $message;
34
35			/**
36			* Subject of the email
37			*
38			* @var string
39			*/
40			private $subject;
41
42			/**
43			* Sender's email
44			*
45			* @var string
46			*/
47			private $from;
48
49			/**
50			* Sender's name
51			*
52			* @var string
53			*/
54			private $nameFrom;
55
56			/**
57			* Email of the recipient
58			*
59			* @var string\|array
60			*/
61			private $to;
62
63			/**
64			* Name of the recipient
65			*
66			* @var string
67			*/
68			private $nameTo;
69
70			/**
71			* Single email or array of email for a carbon copy
72			*
73			* @var array\|string
74			*/
75			private $cc;
76
77			/**
78			* Name of the recipient
79			*
80			* @var string
81			*/
82			private $nameCc;
83
84			/**
85			* Single email or array of email for a blind carbon copy
86			*
87			* @var array\|string
88			*/
89			private $bcc;
90
91			/**
92			* Name of the recipient
93			*
94			* @var string
95			*/
96			private $nameBcc;
97
98			/**
99			* List of attachments
100			*
101			* @var array
102			*/
103			private $attachments = [];
104
105			private $priority = 2;
106
107			public function __construct()
108			{
109			$this->swiftMessage = new Swift_Message();
110			}
111
112			/**
113			* Receives the recipient's
114			* If multiple recipients will receive the message an array should be used.
115			* Example: array('[email protected]', '[email protected]' => 'A name')
116			*
117			* If $name is passed and the first parameter is a string, this name will be
118			* associated with the address.
119			*
120			* @param string\|array $to
121			*
122			* @param string\|null $name
123			*
124			* @return Replyable
125			*/
126			public function to($to, $name = null)
127			{
128			$this->to = $to;
129			$this->nameTo = $name;
130
131			return $this;
132			}
133
134			public function from($from, $name = null)
135			{
136			$this->from = $from;
137			$this->nameFrom = $name;
138
139			return $this;
140			}
141
142			/**
143			* @param array\|string $cc
144			*
145			* @param string\|null $name
146			*
147			* @return Replyable
148			*/
149			public function cc($cc, $name = null)
150			{
151			$this->cc = $this->emailList($cc, $name);
152			$this->nameCc = $name;
153
154			return $this;
155			}
156
157			private function emailList($list, $name = null)
158			{
159			if (is_array($list)) {
160			return $this->convertEmailList($list, $name);
161			} else {
162			return $list;
163			}
164			}
165
166			private function convertEmailList($emails, $name = null)
167			{
168			$newList = [];
169			$count = 0;
170			foreach ($emails as $key => $email) {
171			$emailName = isset($name[$count]) ? $name[$count] : explode('@', $email)[0];
172			$newList[$email] = $emailName;
173			$count = $count + 1;
174			}
175
176			return $newList;
177			}
178
179			/**
180			* @param array\|string $bcc
181			*
182			* @param string\|null $name
183			*
184			* @return Replyable
185			*/
186			public function bcc($bcc, $name = null)
187			{
188			$this->bcc = $this->emailList($bcc, $name);
189			$this->nameBcc = $name;
190
191			return $this;
192			}
193
194			/**
195			* @param string $subject
196			*
197			* @return Replyable
198			*/
199			public function subject($subject)
200			{
201			$this->subject = $subject;
202
203			return $this;
204			}
205
206			/**
207			* @param string $view
208			* @param array $data
209			* @param array $mergeData
210			*
211			* @return Replyable
212			* @throws \Throwable
213			*/
214			public function view($view, $data = [], $mergeData = [])
215			{
216			$this->message = view($view, $data, $mergeData)->render();
217
218			return $this;
219			}
220
221			/**
222			* @param string $message
223			*
224			* @return Replyable
225			*/
226			public function message($message)
227			{
228			$this->message = $message;
229
230			return $this;
231			}
232
233			/**
234			* Attaches new file to the email from the Storage folder
235			*
236			* @param array $files comma separated of files
237			*
238			* @return Replyable
239			* @throws \Exception
240			*/
241			public function attach(...$files)
242			{
243
244			foreach ($files as $file) {
245
246			if (!file_exists($file)) {
247			throw new FileNotFoundException($file);
248			}
249
250			array_push($this->attachments, $file);
251			}
252
253			return $this;
254			}
255
256			/**
257			* The value is an integer where 1 is the highest priority and 5 is the lowest.
258			*
259			* @param int $priority
260			*
261			* @return Replyable
262			*/
263			public function priority($priority)
264			{
265			$this->priority = $priority;
266
267			return $this;
268			}
269
270			/**
271			* @param array $parameters
272			*
273			* @return Replyable
274			*/
275			public function optionalParameters(array $parameters)
276			{
277			$this->parameters = $parameters;
278
279			return $this;
280			}
281
282			/**
283			* Reply to a specific email
284			*
285			* @return Mail
286			* @throws \Exception
287			*/
288			public function reply()
289			{
290			if (!$this->getId()) {
291			throw new \Exception('This is a new email. Use send().');
292			}
293
294			$this->setReplyThread();
295			$this->setReplySubject();
296			$this->setReplyTo();
297			$this->setReplyFrom();
298			$body = $this->getMessageBody();
299			$body->setThreadId($this->getThreadId());
300
301			return new Mail($this->service->users_messages->send('me', $body, $this->parameters));
302			}
303
304			public abstract function getId();
305
306			private function setReplyThread()
307			{
308			$threadId = $this->getThreadId();
309			if ($threadId) {
310			$this->setHeader('In-Reply-To', $this->getMessageIdHeader());
311			$this->setHeader('References', $this->getHeader('References'));
312			$this->setHeader('Message-ID', $this->getMessageIdHeader());
313			}
314			}
315
316			private function getMessageIdHeader() {
317			if($this->getHeader('Message-ID')) {
318			return $this->getHeader('Message-ID');
319			}
320			if($this->getHeader('Message-Id')) {
321			return $this->getHeader('Message-Id');
322			}
323			return null;
324			}
325
326			public abstract function getThreadId();
327
328			/**
329			* Add a header to the email
330			*
331			* @param string $header
332			* @param string $value
333			*/
334			public function setHeader($header, $value)
335			{
336			$headers = $this->swiftMessage->getHeaders();
337
338			$headers->addTextHeader($header, $value);
339
340			}
341
342			private function setReplySubject()
343			{
344			if (!$this->subject) {
345			$this->subject = $this->getSubject();
346			}
347			}
348
349			private function setReplyTo()
350			{
351			if (!$this->to) {
352			$replyTo = $this->getReplyTo();
353
354			$this->to = $replyTo['email'];
355			$this->nameTo = $replyTo['name'];
356			}
357			}
358
359			private function setReplyFrom()
360			{
361			if (!$this->from) {
362			$this->from = $this->getUser();
363			if(!$this->from) {
364			throw new \Exception('Reply from is not defined');
365			}
366			}
367			}
368
369			public abstract function getSubject();
370
371			public abstract function getReplyTo();
372
373			public abstract function getUser();
374
375			/**
376			* @return Google_Service_Gmail_Message
377			*/
378			private function getMessageBody()
379			{
380			$body = new Google_Service_Gmail_Message();
381
382			$this->swiftMessage
383			->setSubject($this->subject)
384			->setFrom($this->from, $this->nameFrom)
385			->setTo($this->to, $this->nameTo)
386			->setCc($this->cc, $this->nameCc)
387			->setBcc($this->bcc, $this->nameBcc)
388			->setBody($this->message, 'text/html')
389			->setPriority($this->priority);
390
391			foreach ($this->attachments as $file) {
392			$this->swiftMessage
393			->attach(Swift_Attachment::fromPath($file));
394			}
395
396			$body->setRaw($this->base64_encode($this->swiftMessage->toString()));
397
398			return $body;
399			}
400
401			private function base64_encode($data)
402			{
403			return rtrim(strtr(base64_encode($data), ['+' => '-', '/' => '_']), '=');
404			}
405
406			/**
407			* Sends a new email
408			*
409			* @return self\|Mail
410			*/
411			public function send()
412			{
413			$body = $this->getMessageBody();
414
415			$this->setMessage($this->service->users_messages->send('me', $body, $this->parameters));
416
417			return $this;
418			}
419
420			protected abstract function setMessage(\Google_Service_Gmail_Message $message);
421			}
422

dacastro4 / laravel-gmail

Pull Request — master (#232)

Replyable::message() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like