zytzagoo / smtp-validate-email

smtp-validate-email.php

Indentation +127 added lines, -127 removed lines

@@ -86,18 +86,18 @@ 
     public $connect_port = 25;
 
     /**
-    * Are 'catch-all' accounts considered valid or not?
-    * If not, the class checks for a "catch-all" and if it determines the box
-    * has a "catch-all", sets all the emails on that domain as invalid.
-    */
+     * Are 'catch-all' accounts considered valid or not?
+     * If not, the class checks for a "catch-all" and if it determines the box
+     * has a "catch-all", sets all the emails on that domain as invalid.
+     */
     public $catchall_is_valid = true;
     public $catchall_test = false; // Set to true to perform a catchall test
 
     /**
-    * Being unable to communicate with the remote MTA could mean an address
-    * is invalid, but it might not, depending on your use case, set the
-    * value appropriately.
-    */
+     * Being unable to communicate with the remote MTA could mean an address
+     * is invalid, but it might not, depending on your use case, set the
+     * value appropriately.
+     */
     public $no_comm_is_valid = false;
 
     /**
@@ -111,18 +111,18 @@ 
     public $greylisted_considered_valid = true;
 
     /**
-    * If on Windows (or other places that don't have getmxrr()), this is the
-    * nameserver that will be used for MX querying.
-    * Set as empty to use the DNS specified via your current network connection.
-    * @see getmxrr()
-    */
+     * If on Windows (or other places that don't have getmxrr()), this is the
+     * nameserver that will be used for MX querying.
+     * Set as empty to use the DNS specified via your current network connection.
+     * @see getmxrr()
+     */
     // protected $mx_query_ns = 'dns1.t-com.hr';
     protected $mx_query_ns = '';
 
     /**
-    * Timeout values for various commands (in seconds) per RFC 2821
-    * @see expect()
-    */
+     * Timeout values for various commands (in seconds) per RFC 2821
+     * @see expect()
+     */
     protected $command_timeouts = array(
         'ehlo' => 120,
         'helo' => 120,
@@ -176,10 +176,10 @@ 
     );
 
     /**
-    * Constructor.
-    * @param $emails array  [optional] Array of emails to validate
-    * @param $sender string [optional] Email address of the sender/validator
-    */
+     * Constructor.
+     * @param $emails array  [optional] Array of emails to validate
+     * @param $sender string [optional] Email address of the sender/validator
+     */
     function __construct($emails = array(), $sender = '') {
         if (!empty($emails)) {
             $this->set_emails($emails);
@@ -190,9 +190,9 @@ 
     }
 
     /**
-    * Disconnects from the SMTP server if needed.
-    * @return void
-    */
+     * Disconnects from the SMTP server if needed.
+     * @return void
+     */
     public function __destruct() {
         $this->disconnect(false);
     }
@@ -220,11 +220,11 @@ 
     }
 
     /**
-    * Performs validation of specified email addresses.
-    * @param array $emails  Emails to validate (recipient emails)
-    * @param string $sender Sender email address
-    * @return array         List of emails and their results
-    */
+     * Performs validation of specified email addresses.
+     * @param array $emails  Emails to validate (recipient emails)
+     * @param string $sender Sender email address
+     * @return array         List of emails and their results
+     */
     public function validate($emails = array(), $sender = '') {
 
         $this->results = array();
@@ -290,10 +290,10 @@ 
                         }
 
                         /**
-                        * if we're still connected, proceed (cause we might get
-                        * disconnected, or banned, or greylisted temporarily etc.)
-                        * see mail() for more
-                        */
+                         * if we're still connected, proceed (cause we might get
+                         * disconnected, or banned, or greylisted temporarily etc.)
+                         * see mail() for more
+                         */
                         if ($this->connected()) {
 
                             $this->noop();
@@ -368,11 +368,11 @@ 
     }
 
     /**
-    * Helper to set results for all the users on a domain to a specific value
-    * @param array $users   Array of users (usernames)
-    * @param string $domain The domain
-    * @param bool $val      Value to set
-    */
+     * Helper to set results for all the users on a domain to a specific value
+     * @param array $users   Array of users (usernames)
+     * @param string $domain The domain
+     * @param bool $val      Value to set
+     */
     private function set_domain_results($users, $domain, $val) {
         if (!is_array($users)) {
             $users = (array) $users;
@@ -383,20 +383,20 @@ 
     }
 
     /**
-    * Returns true if we're connected to an MTA
-    * @return bool
-    */
+     * Returns true if we're connected to an MTA
+     * @return bool
+     */
     protected function connected() {
         return is_resource($this->socket);
     }
 
     /**
-    * Tries to connect to the specified host on the pre-configured port.
-    * @param string $host   The host to connect to
-    * @return void
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_No_Timeout
-    */
+     * Tries to connect to the specified host on the pre-configured port.
+     * @param string $host   The host to connect to
+     * @return void
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_No_Timeout
+     */
     protected function connect($host) {
         $remote_socket = $host . ':' . $this->connect_port;
         $errnum = 0;
@@ -426,10 +426,10 @@ 
     }
 
     /**
-    * Disconnects the currently connected MTA.
-    * @param bool $quit Issue QUIT before closing the socket on our end.
-    * @return void
-    */
+     * Disconnects the currently connected MTA.
+     * @param bool $quit Issue QUIT before closing the socket on our end.
+     * @return void
+     */
     protected function disconnect($quit = true) {
         if ($quit) {
             $this->quit();
@@ -443,8 +443,8 @@ 
     }
 
     /**
-    * Resets internal state flags to defaults
-    */
+     * Resets internal state flags to defaults
+     */
     private function reset_state() {
         $this->state['helo'] = false;
         $this->state['mail'] = false;
@@ -452,10 +452,10 @@ 
     }
 
     /**
-    * Sends a HELO/EHLO sequence
-    * @todo Implement TLS
-    * @return bool|null  True if successful, false otherwise
-    */
+     * Sends a HELO/EHLO sequence
+     * @todo Implement TLS
+     * @return bool|null  True if successful, false otherwise
+     */
     protected function helo() {
         // don't try if it was already done
         if ($this->state['helo']) {
@@ -489,9 +489,9 @@ 
     }
 
     /**
-    * Send EHLO or HELO, depending on what's supported by the remote host.
-    * @return void
-    */
+     * Send EHLO or HELO, depending on what's supported by the remote host.
+     * @return void
+     */
     protected function ehlo() {
         try {
             // modern
@@ -505,11 +505,11 @@ 
     }
 
     /**
-    * Sends a MAIL FROM command to indicate the sender.
-    * @param string $from   The "From:" address
-    * @return bool          If MAIL FROM command was accepted or not
-    * @throws SMTP_Validate_Email_Exception_No_Helo
-    */
+     * Sends a MAIL FROM command to indicate the sender.
+     * @param string $from   The "From:" address
+     * @return bool          If MAIL FROM command was accepted or not
+     * @throws SMTP_Validate_Email_Exception_No_Helo
+     */
     protected function mail($from) {
         if (!$this->state['helo']) {
             throw new SMTP_Validate_Email_Exception_No_Helo('Need HELO before MAIL FROM');
@@ -533,11 +533,11 @@ 
     }
 
     /**
-    * Sends a RCPT TO command to indicate a recipient.
-    * @param string $to Recipient's email address
-    * @return bool      Is the recipient accepted
-    * @throws SMTP_Validate_Email_Exception_No_Mail_From
-    */
+     * Sends a RCPT TO command to indicate a recipient.
+     * @param string $to Recipient's email address
+     * @return bool      Is the recipient accepted
+     * @throws SMTP_Validate_Email_Exception_No_Mail_From
+     */
     protected function rcpt($to) {
         // need to have issued MAIL FROM first
         if (!$this->state['mail']) {
@@ -569,9 +569,9 @@ 
     }
 
     /**
-    * Sends a RSET command and resets our internal state.
-    * @return void
-    */
+     * Sends a RSET command and resets our internal state.
+     * @return void
+     */
     protected function rset() {
         $this->send('RSET');
         // MS ESMTP doesn't follow RFC according to ZF tracker, see [ZF-1377]
@@ -588,9 +588,9 @@ 
     }
 
     /**
-    * Sends a QUIT command.
-    * @return void
-    */
+     * Sends a QUIT command.
+     * @return void
+     */
     protected function quit() {
         // although RFC says QUIT can be issued at any time, we won't
         if ($this->state['helo']) {
@@ -600,9 +600,9 @@ 
     }
 
     /**
-    * Sends a NOOP command.
-    * @return void
-    */
+     * Sends a NOOP command.
+     * @return void
+     */
     protected function noop() {
         $this->send('NOOP');
         // erg... "SMTP" code fix some bad RFC implementations
@@ -620,12 +620,12 @@ 
     }
 
     /**
-    * Sends a command to the remote host.
-    * @param string $cmd    The cmd to send
-    * @return int|bool      Number of bytes written to the stream
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_Send_Failed
-    */
+     * Sends a command to the remote host.
+     * @param string $cmd    The cmd to send
+     * @return int|bool      Number of bytes written to the stream
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_Send_Failed
+     */
     protected function send($cmd) {
         // must be connected
         if (!$this->connected()) {
@@ -643,13 +643,13 @@ 
     }
 
     /**
-    * Receives a response line from the remote host.
-    * @param int $timeout Timeout in seconds
-    * @return string
-    * @throws SMTP_Validate_Email_Exception_No_Connection
-    * @throws SMTP_Validate_Email_Exception_Timeout
-    * @throws SMTP_Validate_Email_Exception_No_Response
-    */
+     * Receives a response line from the remote host.
+     * @param int $timeout Timeout in seconds
+     * @return string
+     * @throws SMTP_Validate_Email_Exception_No_Connection
+     * @throws SMTP_Validate_Email_Exception_Timeout
+     * @throws SMTP_Validate_Email_Exception_No_Response
+     */
     protected function recv($timeout = null) {
         if (!$this->connected()) {
             throw new SMTP_Validate_Email_Exception_No_Connection('No connection');
@@ -674,13 +674,13 @@ 
     }
 
     /**
-    * Receives lines from the remote host and looks for expected response codes.
-    * @param int|int[] $codes A list of one or more expected response codes
-    * @param int $timeout The timeout for this individual command, if any
-    * @param bool $empty_response_allowed When true, empty responses are allowed
-    * @return string The last text message received
-    * @throws SMTP_Validate_Email_Exception_Unexpected_Response
-    */
+     * Receives lines from the remote host and looks for expected response codes.
+     * @param int|int[] $codes A list of one or more expected response codes
+     * @param int $timeout The timeout for this individual command, if any
+     * @param bool $empty_response_allowed When true, empty responses are allowed
+     * @return string The last text message received
+     * @throws SMTP_Validate_Email_Exception_Unexpected_Response
+     */
     protected function expect($codes, $timeout = null, $empty_response_allowed = false) {
         if (!is_array($codes)) {
             $codes = (array) $codes;
@@ -712,11 +712,11 @@ 
     }
 
     /**
-    * Parses an email string into respective user and domain parts and
-    * returns those as an array.
-    * @param string $email 'user@domain'
-    * @return array        ['user', 'domain']
-    */
+     * Parses an email string into respective user and domain parts and
+     * returns those as an array.
+     * @param string $email 'user@domain'
+     * @return array        ['user', 'domain']
+     */
     protected function parse_email($email) {
         $parts = explode('@', $email);
         $domain = array_pop($parts);
@@ -725,10 +725,10 @@ 
     }
 
     /**
-    * Sets the email addresses that should be validated.
-    * @param array $emails  Array of emails to validate
-    * @return void
-    */
+     * Sets the email addresses that should be validated.
+     * @param array $emails  Array of emails to validate
+     * @return void
+     */
     public function set_emails($emails) {
         if (!is_array($emails)) {
             $emails = (array) $emails;
@@ -744,10 +744,10 @@ 
     }
 
     /**
-    * Sets the email address to use as the sender/validator.
-    * @param string $email
-    * @return void
-    */
+     * Sets the email address to use as the sender/validator.
+     * @param string $email
+     * @return void
+     */
     public function set_sender($email) {
         $parts = $this->parse_email($email);
         $this->from_user = $parts[0];
@@ -755,10 +755,10 @@ 
     }
 
     /**
-    * Queries the DNS server for MX entries of a certain domain.
-    * @param string $domain The domain for which to retrieve MX records
-    * @return array         MX hosts and their weights
-    */
+     * Queries the DNS server for MX entries of a certain domain.
+     * @param string $domain The domain for which to retrieve MX records
+     * @return array         MX hosts and their weights
+     */
     protected function mx_query($domain) {
         $hosts = array();
         $weight = array();
@@ -813,11 +813,11 @@ 
     }
 
     /**
-    * Debug helper. If run in a CLI env, it just dumps $str on a new line,
-    * else it prints stuff using <pre>.
-    * @param string $str    The debug message
-    * @return void
-    */
+     * Debug helper. If run in a CLI env, it just dumps $str on a new line,
+     * else it prints stuff using <pre>.
+     * @param string $str    The debug message
+     * @return void
+     */
     private function debug($str) {
         $str = $this->stamp($str);
         $this->log($str);
@@ -830,9 +830,9 @@ 
     }
 
     /**
-    * Adds a message to the log array
-    * @param string $msg The message to add
-    */
+     * Adds a message to the log array
+     * @param string $msg The message to add
+     */
     private function log($msg) {
         $this->log[] = $msg;
     }
@@ -852,15 +852,15 @@ 
     }
 
     /**
-    * Returns the log array
-    */
+     * Returns the log array
+     */
     public function get_log() {
         return $this->log;
     }
 
     /**
-    * Truncates the log array
-    */
+     * Truncates the log array
+     */
     public function clear_log() {
         $this->log = array();
     }