Function Mail_dispatcher_smtp->fread

Definitions

sources/mail.php

  • Wrapper for fread that adds logging.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$handle resource No No required parameter N/A N/A The file handle
$length integer No No required parameter N/A N/A Maximum length to read

Returns

  • The read data (false: error)
  • Type: ~string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Wrapper for fread that adds logging.
 *
 * @param  resource $handle The file handle
 * @param  integer $length Maximum length to read
 * @return ~string The read data (false: error)
 */

protected function fread($handle, int $length)