refactor: Added Class to Store SMTP Options

example/sendMail.php

@@ -2,21 +2,22 @@
 
 require '../vendor/autoload.php';
 
+use webfiori\email\AccountOption;
 use webfiori\email\Email;
 use webfiori\email\SMTPAccount;
 
 //First, create new SMTP account that holds SMTP connection information.
 $smtp = new SMTPAccount([
-    'port' => 465,
+    AccountOption::PORT => 465,
     //Replace server address with your mail server address
-    'server-address' => 'mail.example.com',
+    AccountOption::SENDER_ADDRESS => 'mail.example.com',
     //Replace server username with your mail server username
-    'user' => '[email protected]',
-    'pass' => 'KnvcbxFYCz77',
-    'sender-name' => 'Ibrahim',
+    AccountOption::USERNAME => '[email protected]',
+    AccountOption::PASSWORD => 'KnvcbxFYCz77',
+    AccountOption::SENDER_NAME => 'Ibrahim',
     //Replace sender address with your mail server sender address
-    'sender-address' => '[email protected]',
-    'account-name' => 'no-reply'
+    AccountOption::SERVER_ADDRESS => '[email protected]',
+    AccountOption::NAME => 'no-reply'
 ]);
 
 //Second, create your actual email. using the account that was just created to

webfiori/email/AccountOption.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * This file is licensed under MIT License.
+ *
+ * Copyright (c) 2024 Ibrahim BinAlshikh
+ *
+ * For more information on the license, please visit:
+ * https://github.com/WebFiori/.github/blob/main/LICENSE
+ *
+ */
+namespace webfiori\email;
+
+/**
+ * A class that holds constants that represents SMTP account options.
+ *
+ * @author Ibrahim
+ */
+class AccountOption {
+    /**
+     * An option which is used to set the address of SMTP server.
+     */
+    const SERVER_ADDRESS = 'server-address';
+    /**
+     * An option which is used to set SMTP server port.
+     */
+    const PORT = 'port';
+    /**
+     * An option which is used to set the username at which it is used to log in to SMTP server.
+     */
+    const USERNAME = 'user';
+    /**
+     * An option which is used to set the password of the account.
+     */
+    const PASSWORD = 'pass';
+    /**
+     * An option which is used to set the name of the sender that will appear when the 
+     * message is sent.
+     */
+    const SENDER_NAME = 'sender-name';
+    /**
+     * An option which is used to set the address that will appear when the 
+     * message is sent. Usually, it is the same as the username.
+     */
+    const SENDER_ADDRESS = 'sender-address';
+    /**
+     * An option which is used to set a unique name for the account.
+     */
+    const NAME = 'account-name';
+}

webfiori/email/SMTPAccount.php

@@ -77,48 +77,44 @@ class SMTPAccount {
      * 
      */
     public function __construct(array $options = []) {
-        if (isset($options['port'])) {
-            $this->setPort($options['port']);
+        if (isset($options[AccountOption::PORT])) {
+            $this->setPort($options[AccountOption::PORT]);
         } else {
             $this->setPort(465);
         }
 
-        if (isset($options['user'])) {
-            $this->setUsername($options['user']);
-        } else if (isset($options['username'])) {
-            $this->setUsername($options['username']);
+        if (isset($options[AccountOption::USERNAME])) {
+            $this->setUsername($options[AccountOption::USERNAME]);
         } else {
             $this->setUsername('');
         }
 
-        if (isset($options['pass'])) {
-            $this->setPassword($options['pass']);
-        } else if (isset($options['password'])) {
-            $this->setPassword($options['password']);
+        if (isset($options[AccountOption::PASSWORD])) {
+            $this->setPassword($options[AccountOption::PASSWORD]);
         } else {
             $this->setPassword('');
         }
 
-        if (isset($options['server-address'])) {
-            $this->setServerAddress($options['server-address']);
+        if (isset($options[AccountOption::SERVER_ADDRESS])) {
+            $this->setServerAddress($options[AccountOption::SERVER_ADDRESS]);
         } else {
             $this->setServerAddress('');
         }
 
-        if (isset($options['sender-name'])) {
-            $this->setSenderName($options['sender-name']);
+        if (isset($options[AccountOption::SENDER_NAME])) {
+            $this->setSenderName($options[AccountOption::SERVER_ADDRESS]);
         } else {
             $this->setSenderName('');
         }
 
-        if (isset($options['sender-address'])) {
-            $this->setAddress($options['sender-address']);
+        if (isset($options[AccountOption::SERVER_ADDRESS])) {
+            $this->setAddress($options[AccountOption::SERVER_ADDRESS]);
         } else {
             $this->setAddress('');
         }
 
-        if (isset($options['account-name'])) {
-            $this->setAccountName($options['account-name']);
+        if (isset($options[AccountOption::NAME])) {
+            $this->setAccountName($options[AccountOption::NAME]);
         } else {
             $this->setAccountName($this->getSenderName());
         }

webfiori/email/SendMode.php

@@ -1,4 +1,13 @@
 <?php
+/**
+ * This file is licensed under MIT License.
+ *
+ * Copyright (c) 2024 Ibrahim BinAlshikh
+ *
+ * For more information on the license, please visit:
+ * https://github.com/WebFiori/.github/blob/main/LICENSE
+ *
+ */
 namespace webfiori\email;
 
 /**