Documentation

Horde_Imap_Client_Url_Imap_Relative extends Horde_Imap_Client_Url_Imap
in package

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

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2008-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.25.0

Table of Contents

$auth  : string
$host  : string
$mailbox  : Horde_Imap_Client_Mailbox
$partial  : string
$port  : int
$search  : string
$section  : string
$uid  : string
$uidvalidity  : string
$urlauth  : string
$username  : string
$_auth  : string
The authentication method to use.
$_host  : string
The server name.
$_mailbox  : Horde_Imap_Client_Mailbox
IMAP mailbox.
$_partial  : string
Byte range for use with IMAP FETCH command.
$_port  : int
The port.
$_search  : string
Search query to be run with IMAP SEARCH.
$_section  : string
MIME part ID.
$_uid  : string
IMAP UID.
$_uidvalidity  : int
IMAP UIDVALIDITY for the given mailbox.
$_urlauth  : string
URLAUTH info (not parsed).
$_username  : string
The username.
__construct()  : mixed
Constructor.
__get()  : mixed
__serialize()  : array<string|int, mixed>
__set()  : mixed
__toString()  : string
Create a relative IMAP URL (RFC 5092/5593).
__unserialize()  : mixed
serialize()  : mixed
unserialize()  : mixed
_parse()  : mixed
_parseUrl()  : mixed
_toImapString()  : mixed

Properties

$auth

public string $auth

The authentication method.

$host

public string $host

The server.

$partial

public string $partial

Byte range for use with IMAP FETCH command.

$port

public int $port

The port.

public string $search

Search query to be run with IMAP SEARCH.

$section

public string $section

MIME part ID.

$uid

public string $uid

IMAP UID.

$uidvalidity

public string $uidvalidity

IMAP UIDVALIDITY for the mailbox.

$urlauth

public string $urlauth

URLAUTH info.

$username

public string $username

The username.

$_auth

The authentication method to use.

protected string $_auth = \null

$_host

The server name.

protected string $_host = \null

$_partial

Byte range for use with IMAP FETCH command.

protected string $_partial

$_port

The port.

protected int $_port = \null

Search query to be run with IMAP SEARCH.

protected string $_search

$_section

MIME part ID.

protected string $_section

$_uid

IMAP UID.

protected string $_uid

$_uidvalidity

IMAP UIDVALIDITY for the given mailbox.

protected int $_uidvalidity

$_urlauth

URLAUTH info (not parsed).

protected string $_urlauth

$_username

The username.

protected string $_username = \null

Methods

__construct()

Constructor.

public __construct([string $url = null ]) : mixed
Parameters
$url : string = null

A URL string.

Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__set()

public __set(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed
Return values
mixed

__toString()

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

public __toString() : string
Return values
string

A URL string.

__unserialize()

public __unserialize(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

serialize()

public serialize() : mixed
Return values
mixed

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

_parse()

protected _parse(mixed $url) : mixed
Parameters
$url : mixed
Return values
mixed

_parseUrl()

protected abstract _parseUrl(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

_toImapString()

protected _toImapString() : mixed
Return values
mixed

Search results