Function EmailIntegration->_incoming_scan

Definitions

sources/mail_integration.php

  • Scan for new e-mails.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$type string No No required parameter N/A N/A Server type (blank: get from global configuration)
$host string No No required parameter N/A N/A Server hostname (blank: get from global configuration)
$port ?integer No No required parameter N/A N/A Server port (null: get from global configuration)
$folder string No No required parameter N/A N/A Inbox folder (blank: get from global configuration)
$username string No No required parameter N/A N/A Username (blank: get from global configuration)
$password string No No required parameter N/A N/A Password (blank: get from global configuration)

Preview

Code (PHP)

/**
 * Scan for new e-mails.
 *
 * @param  string $type Server type (blank: get from global configuration)
 * @param  string $host Server hostname (blank: get from global configuration)
 * @param  ?integer $port Server port (null: get from global configuration)
 * @param  string $folder Inbox folder (blank: get from global configuration)
 * @param  string $username Username (blank: get from global configuration)
 * @param  string $password Password (blank: get from global configuration)
 */
protected function _incoming_scan(string $type, string $host, ?int $port, string $folder, string $username, string $password)