rudiedirkx / imap-reader

src/IMAPTransport.php

Doc Comments +19 added lines

@@ -9,6 +9,12 @@ 
 
 	protected $resource; // imap_open() resource
 
+	/**
+	 * @param string $server
+	 * @param string $username
+	 * @param string $password
+	 * @param string $mailbox
+	 */
 	public function open( $server, $username, $password, $mailbox, array $flags ) {
 		if ( !empty($flags) ) {
 			$server .= '/' . implode('/', $flags);
@@ -34,6 +40,9 @@ 
 		return imap_utf8($string);
 	}
 
+	/**
+	 * @param integer $msgNumber
+	 */
 	public function headerinfo( $msgNumber ) {
 		return $this->iteratorToLowercaseArray(imap_headerinfo($this->resource, $msgNumber));
 	}
@@ -46,10 +55,17 @@ 
 		return imap_setflag_full($this->resource, $msgNumber, $flag);
 	}
 
+	/**
+	 * @param integer $msgNumber
+	 */
 	public function fetchstructure( $msgNumber ) {
 		return imap_fetchstructure($this->resource, $msgNumber);
 	}
 
+	/**
+	 * @param integer $msgNumber
+	 * @param string $section
+	 */
 	public function fetchbody( $msgNumber, $section ) {
 		return quoted_printable_decode(imap_fetchbody($this->resource, $msgNumber, $section, FT_PEEK));
 	}
@@ -58,6 +74,9 @@ 
 		return imap_expunge($this->resource);
 	}
 
+	/**
+	 * @param integer $msgNumber
+	 */
 	public function delete( $msgNumber ) {
 		return imap_delete($this->resource, $msgNumber);
 	}

Spacing +16 added lines, -16 removed lines

@@ -9,14 +9,14 @@ 
 
 	protected $resource; // imap_open() resource
 
-	public function open( $server, $username, $password, $mailbox, array $flags ) {
-		if ( !empty($flags) ) {
-			$server .= '/' . implode('/', $flags);
+	public function open($server, $username, $password, $mailbox, array $flags) {
+		if (!empty($flags)) {
+			$server .= '/'.implode('/', $flags);
 		}
 
-		$mailbox = '{' . $server . '}' . $mailbox;
+		$mailbox = '{'.$server.'}'.$mailbox;
 		$this->resource = @imap_open($mailbox, $username, $password);
-		if ( !$this->resource ) {
+		if (!$this->resource) {
 			$error = imap_last_error();
 			imap_errors();
 			imap_alerts();
@@ -30,27 +30,27 @@ 
 		return imap_headers($this->resource);
 	}
 
-	public function utf8( $string ) {
+	public function utf8($string) {
 		return imap_utf8($string);
 	}
 
-	public function headerinfo( $msgNumber ) {
+	public function headerinfo($msgNumber) {
 		return $this->iteratorToLowercaseArray(imap_headerinfo($this->resource, $msgNumber));
 	}
 
-	public function unflag( $msgNumber, $flag ) {
+	public function unflag($msgNumber, $flag) {
 		return imap_clearflag_full($this->resource, $msgNumber, $flag);
 	}
 
-	public function flag( $msgNumber, $flag ) {
+	public function flag($msgNumber, $flag) {
 		return imap_setflag_full($this->resource, $msgNumber, $flag);
 	}
 
-	public function fetchstructure( $msgNumber ) {
+	public function fetchstructure($msgNumber) {
 		return imap_fetchstructure($this->resource, $msgNumber);
 	}
 
-	public function fetchbody( $msgNumber, $section ) {
+	public function fetchbody($msgNumber, $section) {
 		return quoted_printable_decode(imap_fetchbody($this->resource, $msgNumber, $section, FT_PEEK));
 	}
 
@@ -58,18 +58,18 @@ 
 		return imap_expunge($this->resource);
 	}
 
-	public function delete( $msgNumber ) {
+	public function delete($msgNumber) {
 		return imap_delete($this->resource, $msgNumber);
 	}
 
 	public function mailboxmsginfo() {
-		return (object) $this->iteratorToLowercaseArray(imap_mailboxmsginfo($this->resource));
+		return (object)$this->iteratorToLowercaseArray(imap_mailboxmsginfo($this->resource));
 	}
 
-	protected function iteratorToLowercaseArray( $iterator ) {
+	protected function iteratorToLowercaseArray($iterator) {
 		$data = [];
-		foreach ( $iterator as $name => $value ) {
-			$data[ strtolower($name) ] = $value;
+		foreach ($iterator as $name => $value) {
+			$data[strtolower($name)] = $value;
 		}
 
 		return $data;

src/IMAPTransportInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -5,7 +5,7 @@
 interface IMAPTransportInterface {
 
 	/**
-	 * @return rdx\imap\IMAPTransportInterface
+	 * @return IMAPTransport
 	 */
 	public function open( $server, $username, $password, $mailbox, array $flags );
 

Spacing +8 added lines, -8 removed lines

@@ -7,7 +7,7 @@ 
 	/**
 	 * @return rdx\imap\IMAPTransportInterface
 	 */
-	public function open( $server, $username, $password, $mailbox, array $flags );
+	public function open($server, $username, $password, $mailbox, array $flags);
 
 	/**
 	 * @return array<string>
@@ -17,32 +17,32 @@ 
 	/**
 	 * @return string
 	 */
-	public function utf8( $string );
+	public function utf8($string);
 
 	/**
 	 * @return array<mixed>
 	 */
-	public function headerinfo( $msgNumber );
+	public function headerinfo($msgNumber);
 
 	/**
 	 * @return bool
 	 */
-	public function unflag( $msgNumber, $flag );
+	public function unflag($msgNumber, $flag);
 
 	/**
 	 * @return bool
 	 */
-	public function flag( $msgNumber, $flag );
+	public function flag($msgNumber, $flag);
 
 	/**
 	 * @return object<mixed>
 	 */
-	public function fetchstructure( $msgNumber );
+	public function fetchstructure($msgNumber);
 
 	/**
 	 * @return string
 	 */
-	public function fetchbody( $msgNumber, $section );
+	public function fetchbody($msgNumber, $section);
 
 	/**
 	 * @return bool
@@ -52,7 +52,7 @@ 
 	/**
 	 * @return bool
 	 */
-	public function delete( $msgNumber );
+	public function delete($msgNumber);
 
 	/**
 	 * @return object

src/IMAPMessagePart.php

Spacing +4 added lines, -4 removed lines

@@ -13,7 +13,7 @@ 
 	protected $message; // rdx\imap\IMAPMessage
 	protected $skippedParts = []; // Array<stdClass>
 
-	public function __construct( IMAPMessage $message, $structure, array $section ) {
+	public function __construct(IMAPMessage $message, $structure, array $section) {
 		$this->message = $message;
 		$this->structure = $structure;
 		$this->section = $section;
@@ -23,14 +23,14 @@ 
 	}
 
 	public function parts() {
-		if ( empty($this->parts) && !empty($this->structure()->parts) ) {
+		if (empty($this->parts) && !empty($this->structure()->parts)) {
 			$parts = $this->structure()->parts;
-			while ( count($parts) == 1 && empty($parts[0]->bytes) && !empty($parts[0]->parts) ) {
+			while (count($parts) == 1 && empty($parts[0]->bytes) && !empty($parts[0]->parts)) {
 				$this->skippedParts[] = $parts[0];
 				$parts = $parts[0]->parts;
 			}
 
-			foreach ( $parts as $n => $part ) {
+			foreach ($parts as $n => $part) {
 				$this->parts[] = $this->message()->createMessagePart(
 					$part,
 					array_merge($this->section(), [$n+1])

src/IMAPMessage.php

Spacing +23 added lines, -23 removed lines

@@ -17,33 +17,33 @@ 
 	protected $subject = '';
 	protected $subtype = '';
 
-	public function __construct( IMAPMailbox $mailbox, $msgNumber, $unseen = null ) {
+	public function __construct(IMAPMailbox $mailbox, $msgNumber, $unseen = null) {
 		$this->mailbox = $mailbox;
 		$this->msgNumber = $msgNumber;
 		$this->unseen = $unseen;
 
-		if ( $unseen === null ) {
-			$this->unseen = (bool) trim($this->header('unseen'));
+		if ($unseen === null) {
+			$this->unseen = (bool)trim($this->header('unseen'));
 		}
 	}
 
-	protected function flags( $flags, $clear ) {
+	protected function flags($flags, $clear) {
 		$cb = [$this->mailbox()->imap(), $clear ? 'unflag' : 'flag'];
 
 		$feedback = [];
-		foreach ( (array)$flags AS $flag ) {
-			$flag = '\\' . ucfirst($flag);
+		foreach ((array)$flags AS $flag) {
+			$flag = '\\'.ucfirst($flag);
 			$feedback[] = call_user_func($cb, $this->msgNumber, $flag);
 		}
 
 		return is_array($flags) ? $feedback : $feedback[0];
 	}
 
-	public function flag( $flags ) {
+	public function flag($flags) {
 		return $this->flags($flags, false);
 	}
 
-	public function unflag( $flags ) {
+	public function unflag($flags) {
 		return $this->flags($flags, true);
 	}
 
@@ -52,7 +52,7 @@ 
 	}
 
 	public function subject() {
-		if ( empty($this->subject) ) {
+		if (empty($this->subject)) {
 			$subject = $this->mailbox()->imap()->utf8($this->header('subject'));
 			$this->subject = trim($subject);
 		}
@@ -61,24 +61,24 @@ 
 	}
 
 	public function headers() {
-		if ( empty($this->headers) ) {
+		if (empty($this->headers)) {
 			$this->headers = $this->mailbox()->imap()->headerinfo($this->msgNumber);
 		}
 
 		return $this->headers;
 	}
 
-	public function header( $name ) {
+	public function header($name) {
 		$headers = $this->headers();
-		return @$headers[ strtolower($name) ];
+		return @$headers[strtolower($name)];
 	}
 
-	public function createMessagePart( $structure, $section ) {
+	public function createMessagePart($structure, $section) {
 		return new IMAPMessagePart($this, $structure, $section);
 	}
 
 	public function parts() {
-		if ( empty($this->parts) ) {
+		if (empty($this->parts)) {
 			$structure = $this->structure();
 
 			// Possibilities:
@@ -92,7 +92,7 @@ 
 			// - CALENDAR
 			// - JPEG
 
-			if ( empty($structure->parts) ) {
+			if (empty($structure->parts)) {
 				$this->parts[] = $this->createMessagePart(
 					$structure,
 					[1]
@@ -112,7 +112,7 @@ 
 	}
 
 	public function structure() {
-		if ( empty($this->structure) ) {
+		if (empty($this->structure)) {
 			$this->structure = $this->mailbox()->imap()->fetchstructure($this->msgNumber);
 		}
 
@@ -120,7 +120,7 @@ 
 	}
 
 	public function subtype() {
-		if ( empty($this->subtype) ) {
+		if (empty($this->subtype)) {
 			$structure = $this->structure();
 			$this->subtype = @$structure->subtype ?: '';
 		}
@@ -133,7 +133,7 @@ 
 	}
 
 	public function content() {
-		if ( count($this->parts()) == 1 ) {
+		if (count($this->parts()) == 1) {
 			return $this->part(0)->content();
 		}
 
@@ -146,16 +146,16 @@ 
 
 	public function simpleStructure() {
 		$parts = [];
-		foreach ( $this->allParts(true) as $part ) {
+		foreach ($this->allParts(true) as $part) {
 			$name = '';
 
-			$name .= implode('.', $part->section()) . '. ';
-			if ( $part->parts() ) {
+			$name .= implode('.', $part->section()).'. ';
+			if ($part->parts()) {
 				$name .= '*';
 			}
 			$name .= $part->subtype();
-			if ( $bytes = $part->parameter('bytes') ) {
-				$name .= ' (' . $bytes . ')';
+			if ($bytes = $part->parameter('bytes')) {
+				$name .= ' ('.$bytes.')';
 			}
 
 			$parts[] = $name;