API Documentation
\

\Horde_Imap_Client_Url

Object representation of a a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.

Summary

Methods
Properties
Constants
__construct()
__toString()
__get()
serialize()
unserialize()
$auth
$hostspec
$mailbox
$partial
$port
$protocol
$search
$section
$username
$uid
$uidvalidity
$urlauth
$relative
No constants found
_parse()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$auth

$auth : string

The authentication method to use.

Type

string

$hostspec

$hostspec : string

The remote server (not present for relative URLs).

Type

string

$mailbox

$mailbox : string

The IMAP mailbox.

Type

string

$partial

$partial : string

A byte range for use with IMAP FETCH.

Type

string

$port

$port : integer

The remote port (not present for relative URLs).

Type

integer

$protocol

$protocol : string

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

Type

string

$search

$search : string

A search query to be run with IMAP SEARCH.

Type

string

$section

$section : string

A MIME part ID.

Type

string

$username

$username : string

The username to use on the remote server.

Type

string

$uid

$uid : string

The IMAP UID.

Type

string

$uidvalidity

$uidvalidity : integer

The IMAP UIDVALIDITY for the given mailbox.

Type

integer

$urlauth

$urlauth : string

URLAUTH info (not parsed).

Type

string

$relative

$relative : boolean

Is this a relative URL?

Type

boolean

Methods

__toString()

__toString() : string

Create a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.

Returns

string —

A URL string.

__get()

__get(  $name)

Parameters

$name

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data

_parse()

_parse(  $url)

Parameters

$url