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);
 	}

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 );