• Home
  • Horde_Imap_Client_Url

PHP Class Horde_Imap_Client_Url, horde

Deprecation: Use Horde_Imap_Client_Url_Base instead
Author: Michael Slusarz ([email protected])
Inheritance: implements Serializable
Show file Open project: horde/horde

Public Properties

Property Type Description
$auth string The authentication method to use.
$hostspec string The remote server (not present for relative URLs).
$mailbox string The IMAP mailbox.
$partial string A byte range for use with IMAP FETCH.
$port integer The remote port (not present for relative URLs).
$protocol string The protocol type. Either 'imap' or 'pop' (not present for relative URLs).
$search string A search query to be run with IMAP SEARCH.
$section string A MIME part ID.
$uid string The IMAP UID.
$uidvalidity integer The IMAP UIDVALIDITY for the given mailbox.
$urlauth string URLAUTH info (not parsed).
$username string The username to use on the remote server.

Public Methods

Method Description
__construct ( string $url = null ) Constructor.
__get ( $name )
__toString ( ) : string Create a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.
serialize ( )
unserialize ( $data )

Protected Methods

Method Description
_parse ( $url )

Method Details

__construct() public method

Absolute IMAP URLs takes one of the following forms: - imap://[/] - imap:///[][?] - imap:///[][][][] POP URLs take one of the following forms: - pop://;auth=@:
public __construct ( string $url = null )
$url string A URL string.

__get() public method

public __get ( $name )

__toString() public method

Create a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.
public __toString ( ) : string
return string A URL string.

_parse() protected method

protected _parse ( $url )

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )

Property Details

$auth public property

The authentication method to use.
public string $auth
return string

$hostspec public property

The remote server (not present for relative URLs).
public string $hostspec
return string

$mailbox public property

The IMAP mailbox.
public string $mailbox
return string

$partial public property

A byte range for use with IMAP FETCH.
public string $partial
return string

$port public property

The remote port (not present for relative URLs).
public int $port
return integer

$protocol public property

The protocol type. Either 'imap' or 'pop' (not present for relative URLs).
public string $protocol
return string

$section public property

A MIME part ID.
public string $section
return string

$uid public property

The IMAP UID.
public string $uid
return string

$uidvalidity public property

The IMAP UIDVALIDITY for the given mailbox.
public int $uidvalidity
return integer

$urlauth public property

URLAUTH info (not parsed).
public string $urlauth
return string

$username public property

The username to use on the remote server.
public string $username
return string