Use proper Exceptions in new email system

diff --git a/wcfsetup/install/files/lib/system/email/Email.class.php b/wcfsetup/install/files/lib/system/email/Email.class.php
index ba917cc5d67747aa8d5915dfcf8ff1ac8f881ca0..4bc1dedf3d8d6420b75ea9e494108056473cdd47 100644 (file)
--- a/wcfsetup/install/files/lib/system/email/Email.class.php
+++ b/wcfsetup/install/files/lib/system/email/Email.class.php
@@ -179,7 +179,7 @@ class Email {
         * Sets the part left of the at sign (@) in the email's 'Message-Id'.
         * 
         * @param       string          $messageID
-        * @throws      SystemException
+        * @throws      \DomainException
         */
        public function setMessageID($messageID = null) {
                if ($messageID === null) {
@@ -188,10 +188,10 @@ class Email {
                }
                
                if (!preg_match('(^'.EmailGrammar::getGrammar('id-left').'$)', $messageID)) {
-                       throw new SystemException("The given message id '".$messageID."' is invalid. Note: You must not specify the part right of the at sign (@).");
+                       throw new \DomainException("The given message id '".$messageID."' is invalid. Note: You must not specify the part right of the at sign (@).");
                }
                if (strlen($messageID) > 50) {
-                       throw new SystemException("The given message id '".$messageID."' is not allowed. The maximum allowed length is 50 bytes.");
+                       throw new \DomainException("The given message id '".$messageID."' is not allowed. The maximum allowed length is 50 bytes.");
                }
                
                $this->messageID = $messageID;
@@ -215,11 +215,11 @@ class Email {
         * Adds a message id to the email's 'In-Reply-To'.
         * 
         * @param       string          $messageID
-        * @throws      SystemException
+        * @throws      \DomainException
         */
        public function addInReplyTo($messageID) {
                if (!preg_match('(^'.EmailGrammar::getGrammar('msg-id').'$)', $messageID)) {
-                       throw new SystemException("The given reference '".$messageID."' is invalid.");
+                       throw new \DomainException("The given reference '".$messageID."' is invalid.");
                }
                
                $this->inReplyTo[$messageID] = $messageID;
@@ -247,11 +247,11 @@ class Email {
         * Adds a message id to the email's 'References'.
         * 
         * @param       string          $messageID
-        * @throws      SystemException
+        * @throws      \DomainException
         */
        public function addReferences($messageID) {
                if (!preg_match('(^'.EmailGrammar::getGrammar('msg-id').'$)', $messageID)) {
-                       throw new SystemException("The given reference '".$messageID."' is invalid.");
+                       throw new \DomainException("The given reference '".$messageID."' is invalid.");
                }
                
                $this->references[$messageID] = $messageID;
@@ -326,7 +326,7 @@ class Email {
         * 
         * @param       Mailbox         $recipient
         * @param       string          $type           One of 'to', 'cc', 'bcc'
-        * @throws      SystemException
+        * @throws      \DomainException
         */
        public function addRecipient(Mailbox $recipient, $type = 'to') {
                switch ($type) {
@@ -335,7 +335,7 @@ class Email {
                        case 'bcc':
                        break;
                        default:
-                               throw new SystemException("The given type '".$type."' is invalid. Must be one of 'to', 'cc', 'bcc'.");
+                               throw new \DomainException("The given type '".$type."' is invalid. Must be one of 'to', 'cc', 'bcc'.");
                }
                
                $this->recipients[$recipient->getAddress()] = [$type, $recipient];
@@ -364,12 +364,12 @@ class Email {
         * 
         * @param       string          $header
         * @param       string          $value
-        * @throws      SystemException
+        * @throws      \DomainException
         */
        public function addHeader($header, $value) {
                $header = mb_strtolower($header);
                if (!StringUtil::startsWith($header, 'x-')) {
-                       throw new SystemException("The header '".$header."' may not be set. You may only set user defined headers (starting with 'X-').");
+                       throw new \DomainException("The header '".$header."' may not be set. You may only set user defined headers (starting with 'X-').");
                }
                
                $this->extraHeaders[] = [$header, EmailGrammar::encodeQuotedPrintableHeader($value)];
@@ -383,17 +383,18 @@ class Email {
         * 
         * @param       AbstractMimePart        $part
         * @param       integer                 $priority
-        * @throws      SystemException
+        * @throws      \InvalidArgumentException
+        * @throws      \DomainException
         */
        public function addMimePart(AbstractMimePart $part, $priority = 1000) {
                foreach ($part->getAdditionalHeaders() as $header) {
                        $header[0] = mb_strtolower($header[0]);
                        if ($header[0] == 'content-type' || $header[0] == 'content-transfer-encoding') {
-                               throw new SystemException("The header '".$header[0]."' may not be set. Use the proper methods.");
+                               throw new \InvalidArgumentException("The header '".$header[0]."' may not be set. Use the proper methods.");
                        }
                        
                        if (!StringUtil::startsWith($header[0], 'x-') && !StringUtil::startsWith($header[0], 'content-')) {
-                               throw new SystemException("The header '".$header[0]."' may not be set. You may only set headers starting with 'X-' or 'Content-'.");
+                               throw new \DomainException("The header '".$header[0]."' may not be set. You may only set headers starting with 'X-' or 'Content-'.");
                        }
                }
                
@@ -402,7 +403,7 @@ class Email {
                        case 'quoted-printable':
                        break;
                        default:
-                               throw new SystemException("The Content-Transfer-Encoding '".$part->getContentTransferEncoding()."' may not be set. You may only use 'quoted-printable' or 'base64'.");
+                               throw new \DomainException("The Content-Transfer-Encoding '".$part->getContentTransferEncoding()."' may not be set. You may only use 'quoted-printable' or 'base64'.");
                }
                
                if ($part instanceof TextMimePart) {
@@ -437,7 +438,7 @@ class Email {
         *       headers will fail.
         * 
         * @return      array
-        * @throws      SystemException
+        * @throws      \LogicException
         */
        public function getHeaders() {
                $headers = [];
@@ -456,7 +457,7 @@ class Email {
                        $headers[] = ['to', implode(",\r\n   ", $to)];
                }
                else {
-                       throw new SystemException("Cannot generate message headers, you must specify a recipient.");
+                       throw new \LogicException("Cannot generate message headers, you must specify a recipient.");
                }
                
                if ($cc) {
@@ -466,7 +467,7 @@ class Email {
                        $headers[] = ['subject', EmailGrammar::encodeQuotedPrintableHeader($this->getSubject())];
                }
                else {
-                       throw new SystemException("Cannot generate message headers, you must specify a subject.");
+                       throw new \LogicException("Cannot generate message headers, you must specify a subject.");
                }
                
                $headers[] = ['date', $this->getDate()->format(\DateTime::RFC2822)];
@@ -480,7 +481,7 @@ class Email {
                $headers[] = ['mime-version', '1.0'];
                
                if (!$this->text) {
-                       throw new SystemException("Cannot generate message headers, you must specify at least one 'Text' part.");
+                       throw new \LogicException("Cannot generate message headers, you must specify at least one 'Text' part.");
                }
                if ($this->attachments) {
                        $headers[] = ['content-type', "multipart/mixed;\r\n   boundary=\"".$this->mimeBoundary."\""];

diff --git a/wcfsetup/install/files/lib/system/email/Mailbox.class.php b/wcfsetup/install/files/lib/system/email/Mailbox.class.php
index 4ed0dbb6b288811da2ea54ecd5136f454363a267..17fc76d0651f2969d041d61adbf92c93c5a9535e 100644 (file)
--- a/wcfsetup/install/files/lib/system/email/Mailbox.class.php
+++ b/wcfsetup/install/files/lib/system/email/Mailbox.class.php
@@ -34,11 +34,11 @@ class Mailbox {
         * @param       string          $address        email address of this mailbox
         * @param       string          $name           human readable name of this mailbox (or null)
         * @param       Language        $language       Language to use for localization (or null for the default language)
-        * @throws      SystemException
+        * @throws      DomainException
         */
        public function __construct($address, $name = null, Language $language = null) {
                if (!preg_match('(^'.EmailGrammar::getGrammar('addr-spec').'$)', $address)) {
-                       throw new SystemException("The given email address '".$address."' is invalid.");
+                       throw new \DomainException("The given email address '".$address."' is invalid.");
                }
                
                $this->address = $address;

diff --git a/wcfsetup/install/files/lib/system/email/mime/AttachmentMimePart.class.php b/wcfsetup/install/files/lib/system/email/mime/AttachmentMimePart.class.php
index bb5df9fb9ff54ea6b9eefcca538d75406155d90e..40c488c0b65cae0bf73f4e9866dabc8fd8229e40 100644 (file)
--- a/wcfsetup/install/files/lib/system/email/mime/AttachmentMimePart.class.php
+++ b/wcfsetup/install/files/lib/system/email/mime/AttachmentMimePart.class.php
@@ -1,7 +1,6 @@
 <?php
 namespace wcf\system\email\mime;
 use wcf\system\email\EmailGrammar;
-use wcf\system\exception\SystemException;
 use wcf\util\FileUtil;
 
 /**
@@ -46,11 +45,11 @@ class AttachmentMimePart extends AbstractMimePart {
         * @param       string  $path           Path to read the file from.
         * @param       string  $filename       Filename to provide in the email or null to use the $path's basename.
         * @param       string  $mimeType       Mime type to provide in the email or null to guess the mime type.
-        * @throws      SystemException
+        * @throws      \InvalidArgumentException
         */
        public function __construct($path, $filename = null, $mimeType = null) {
                if (!is_file($path) || !is_readable($path)) {
-                       throw new SystemException("Cannot attach file '".$path."'. It either does not exist or is not readable.");
+                       throw new \InvalidArgumentException("Cannot attach file '".$path."'. It either does not exist or is not readable.");
                }
                
                $this->mimeType = $mimeType ?: (FileUtil::getMimeType($path) ?: 'application/octet-stream');

diff --git a/wcfsetup/install/files/lib/system/email/transport/SmtpEmailTransport.class.php b/wcfsetup/install/files/lib/system/email/transport/SmtpEmailTransport.class.php
index c42673349e7b85790d194191554ecbdbca41a249..fcdb9efe17373e1d1b0c86704909f5a4bdf723d3 100644 (file)
--- a/wcfsetup/install/files/lib/system/email/transport/SmtpEmailTransport.class.php
+++ b/wcfsetup/install/files/lib/system/email/transport/SmtpEmailTransport.class.php
@@ -83,7 +83,7 @@ class SmtpEmailTransport implements EmailTransport {
         * @param       string  $username       username to use for authentication
         * @param       string  $password       corresponding password
         * @param       string  $starttls       one of 'none', 'may' and 'encrypt'
-        * @throws      SystemException
+        * @throws      \InvalidArgumentException
         */
        public function __construct($host = MAIL_SMTP_HOST, $port = MAIL_SMTP_PORT, $username = MAIL_SMTP_USER, $password = MAIL_SMTP_PASSWORD, $starttls = MAIL_SMTP_STARTTLS) {
                $this->host = $host;
@@ -98,7 +98,7 @@ class SmtpEmailTransport implements EmailTransport {
                                $this->starttls = $starttls;
                        break;
                        default:
-                               throw new SystemException("Invalid STARTTLS preference '".$starttls."'. Must be one of 'none', 'may' and 'encrypt'.");
+                               throw new \InvalidArgumentException("Invalid STARTTLS preference '".$starttls."'. Must be one of 'none', 'may' and 'encrypt'.");
                }
        }
        
@@ -174,6 +174,8 @@ class SmtpEmailTransport implements EmailTransport {
        /**
         * Connects to the server and enables STARTTLS if available. Bails
         * out if STARTTLS is not available and connection is set to 'encrypt'.
+        * 
+        * @throws      PermanentFailure
         */
        protected function connect() {
                $this->connection = new RemoteFile($this->host, $this->port);
@@ -221,6 +223,8 @@ class SmtpEmailTransport implements EmailTransport {
        
        /**
         * Enables STARTTLS on the connection.
+        * 
+        * @throws      TransientFailure
         */
        protected function starttls() {
                $this->write("STARTTLS");
@@ -313,6 +317,7 @@ class SmtpEmailTransport implements EmailTransport {
         * @param       Mailbox         $envelopeTo
         * @throws      \Exception
         * @throws      PermanentFailure
+        * @throws      TransientFailure
         * @throws      SystemException
         */
        public function deliver(Email $email, Mailbox $envelopeTo) {