API Documentation
\

\Horde_Imap_Client_Url_Imap_Relative

Object representation of a relative IMAP (RFC 5092/5593) URL.

Absolute IMAP URLs takes one of the following forms:

  • imap://[/]
  • imap:///[][?]
  • imap:///[][][][]

Summary

Methods
Properties
Constants
__get()
__set()
__toString()
__construct()
serialize()
unserialize()
$mailbox
$partial
$search
$section
$uid
$uidvalidity
$urlauth
$auth
$host
$port
$username
No constants found
_toImapString()
_parseUrl()
_parse()
$_mailbox
$_partial
$_search
$_section
$_uid
$_uidvalidity
$_urlauth
$_auth
$_host
$_port
$_username
N/A
No private methods found
No private properties found
N/A

Properties

$mailbox

$mailbox : \Horde_Imap_Client_Mailbox

IMAP Mailbox.

Type

\Horde_Imap_Client_Mailbox

$partial

$partial : string

Byte range for use with IMAP FETCH command.

Type

string

$search

$search : string

Search query to be run with IMAP SEARCH.

Type

string

$section

$section : string

MIME part ID.

Type

string

$uid

$uid : string

IMAP UID.

Type

string

$uidvalidity

$uidvalidity : string

IMAP UIDVALIDITY for the mailbox.

Type

string

$urlauth

$urlauth : string

URLAUTH info.

Type

string

$auth

$auth : string

The authentication method.

Type

string

$host

$host : string

The server.

Type

string

$port

$port : integer

The port.

Type

integer

$username

$username : string

The username.

Type

string

$_partial

$_partial : string

Byte range for use with IMAP FETCH command.

Type

string

$_search

$_search : string

Search query to be run with IMAP SEARCH.

Type

string

$_section

$_section : string

MIME part ID.

Type

string

$_uid

$_uid : string

IMAP UID.

Type

string

$_uidvalidity

$_uidvalidity : integer

IMAP UIDVALIDITY for the given mailbox.

Type

integer

$_urlauth

$_urlauth : string

URLAUTH info (not parsed).

Type

string

$_auth

$_auth : string

The authentication method to use.

Type

string

$_host

$_host : string

The server name.

Type

string

$_port

$_port : integer

The port.

Type

integer

$_username

$_username : string

The username.

Type

string

Methods

__get()

__get(  $name)

Parameters

$name

__set()

__set(  $name,   $value)

Parameters

$name
$value

__toString()

__toString() : string

Create a relative IMAP URL (RFC 5092/5593).

Returns

string —

A URL string.

__construct()

__construct(string  $url = null)

Constructor.

Parameters

string $url

A URL string.

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data

_toImapString()

_toImapString()

_parseUrl()

_parseUrl(array  $data)

Parameters

array $data

_parse()

_parse(  $url)

Parameters

$url