MC-15295: Refactoring Exceptions

Author: Stepa4man

lib/internal/Magento/Framework/Mail/AddressConverter.php

@@ -7,7 +7,7 @@
 
 namespace Magento\Framework\Mail;
 
-use Magento\Framework\Exception\MailException;
+use Magento\Framework\Mail\Exception\InvalidArgumentException;
 
 /**
  * Class AddressConverter
@@ -54,7 +54,7 @@ public function convert(string $email, ?string $name = null): Address
      * @param array $addresses
      *
      * @return Address[]
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     public function convertMany(array $addresses): array
     {
@@ -67,7 +67,7 @@ public function convertMany(array $addresses): array
             }
 
             if (!is_string($key)) {
-                throw new MailException(
+                throw new InvalidArgumentException(
                     __(
                         'Invalid key type in provided addresses array ("%1")',
                         (is_object($key) ? get_class($key) : var_export($key, 1))

lib/internal/Magento/Framework/Mail/EmailMessage.php

@@ -7,7 +7,7 @@
 
 namespace Magento\Framework\Mail;
 
-use Magento\Framework\Exception\MailException;
+use Magento\Framework\Mail\Exception\InvalidArgumentException;
 use Zend\Mail\Address as ZendAddress;
 use Zend\Mail\AddressList;
 use Zend\Mail\Message as ZendMessage;
@@ -47,8 +47,8 @@ class EmailMessage implements EmailMessageInterface
      * @param Address|null $sender
      * @param string|null $subject
      * @param string|null $encoding
+     * @throws InvalidArgumentException
      *
-     * @throws MailException
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -80,7 +80,7 @@ public function __construct(
             $this->message->setSender($sender->getEmail(), $sender->getName());
         }
         if (count($to) < 1) {
-            throw new MailException(__('Email message must have at list one addressee'));
+            throw new InvalidArgumentException(__('Email message must have at list one addressee'));
         }
         if ($to) {
             $this->message->setTo($this->convertAddressArrayToAddressList($to));

lib/internal/Magento/Framework/Mail/Exception/InvalidArgumentException.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright (c) 2019 TechDivision GmbH
+ * All rights reserved
+ *
+ * This product includes proprietary software developed at TechDivision GmbH, Germany
+ * For more information see https://www.techdivision.com/
+ *
+ * To obtain a valid license for using this software please contact us at
+ * license@techdivision.com
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\Mail\Exception;
+
+/**
+ * Class InvalidArgumentException
+ */
+class InvalidArgumentException extends \InvalidArgumentException
+{
+}

lib/internal/Magento/Framework/Mail/MimePart.php

@@ -7,11 +7,11 @@
 
 namespace Magento\Framework\Mail;
 
-use Magento\Framework\Exception\MailException;
+use Magento\Framework\Mail\Exception\InvalidArgumentException;
 use Zend\Mime\Part as ZendMimePart;
 
 /**
- * Class MimePart
+ * @inheritDoc
  */
 class MimePart implements MimePartInterface
 {
@@ -39,7 +39,7 @@ class MimePart implements MimePartInterface
      * @SuppressWarnings(PHPMD.NPathComplexity)
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     public function __construct(
         $content,
@@ -58,7 +58,7 @@ public function __construct(
         try {
             $this->mimePart = new ZendMimePart($content);
         } catch (\Exception $e) {
-            throw new MailException(__($e->getMessage()));
+            throw new InvalidArgumentException(__($e->getMessage()));
         }
         $this->mimePart->setType($type);
         $this->mimePart->setEncoding($encoding);

lib/internal/Magento/Framework/Mail/MimePartInterface.php

@@ -7,7 +7,7 @@
 namespace Magento\Framework\Mail;
 
 /**
- * Interface MimePartInterface
+ * Interface representing a MIME part.
  */
 interface MimePartInterface
 {

lib/internal/Magento/Framework/Mail/Template/TransportBuilder.php

@@ -15,6 +15,7 @@
 use Magento\Framework\Mail\EmailMessageInterface;
 use Magento\Framework\Mail\EmailMessageInterfaceFactory;
 use Magento\Framework\Mail\AddressConverter;
+use Magento\Framework\Mail\Exception\InvalidArgumentException;
 use Magento\Framework\Mail\MessageInterface;
 use Magento\Framework\Mail\MessageInterfaceFactory;
 use Magento\Framework\Mail\MimeInterface;
@@ -178,7 +179,6 @@ public function __construct(
      * @param string $name
      *
      * @return $this
-     * @throws MailException
      */
     public function addCc($address, $name = '')
     {
@@ -194,7 +194,7 @@ public function addCc($address, $name = '')
      * @param string $name
      *
      * @return $this
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     public function addTo($address, $name = '')
     {
@@ -209,7 +209,7 @@ public function addTo($address, $name = '')
      * @param array|string $address
      *
      * @return $this
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     public function addBcc($address)
     {
@@ -225,7 +225,7 @@ public function addBcc($address)
      * @param string|null $name
      *
      * @return $this
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     public function setReplyTo($email, $name = null)
     {
@@ -240,7 +240,7 @@ public function setReplyTo($email, $name = null)
      * @param string|array $from
      *
      * @return $this
-     * @throws MailException
+     * @throws InvalidArgumentException
      * @see setFromByScope()
      *
      * @deprecated This function sets the from address but does not provide
@@ -258,6 +258,7 @@ public function setFrom($from)
      * @param string|int $scopeId
      *
      * @return $this
+     * @throws InvalidArgumentException
      * @throws MailException
      */
     public function setFromByScope($from, $scopeId = null)
@@ -412,7 +413,7 @@ protected function prepareMessage()
      * @param string|null $name
      *
      * @return void
-     * @throws MailException
+     * @throws InvalidArgumentException
      */
     private function addAddressByType(string $addressType, $email, ?string $name = null): void
     {

lib/internal/Magento/Framework/composer.json

@@ -38,6 +38,7 @@
         "zendframework/zend-uri": "^2.5.1",
         "zendframework/zend-validator": "^2.6.0",
         "zendframework/zend-mail": "^2.9.0",
+        "zendframework/zend-mime": "^2.5.0",
         "guzzlehttp/guzzle": "^6.3.3"
     },
     "archive": {