Horde_Imap_Client_Url
in package
implements
Serializable
Object representation of a a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.
Tags
Interfaces, Classes, Traits and Enums
- Serializable
Table of Contents
- $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 : int
- The remote port (not present for relative URLs).
- $protocol : string
- The protocol type. Either 'imap' or 'pop' (not present for relative URLs).
- $relative : bool
- $search : string
- A search query to be run with IMAP SEARCH.
- $section : string
- A MIME part ID.
- $uid : string
- The IMAP UID.
- $uidvalidity : int
- The IMAP UIDVALIDITY for the given mailbox.
- $urlauth : string
- URLAUTH info (not parsed).
- $username : string
- The username to use on the remote server.
- __construct() : mixed
- Constructor.
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __toString() : string
- Create a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.
- __unserialize() : mixed
- serialize() : mixed
- unserialize() : mixed
- _parse() : mixed
Properties
$auth
The authentication method to use.
public
string
$auth
= \null
$hostspec
The remote server (not present for relative URLs).
public
string
$hostspec
= \null
$mailbox
The IMAP mailbox.
public
string
$mailbox
= \null
Tags
$partial
A byte range for use with IMAP FETCH.
public
string
$partial
= \null
$port
The remote port (not present for relative URLs).
public
int
$port
= \null
$protocol
The protocol type. Either 'imap' or 'pop' (not present for relative URLs).
public
string
$protocol
= \null
$relative read-only
public
bool
$relative
Is this a relative URL?
$search
A search query to be run with IMAP SEARCH.
public
string
$search
= \null
$section
A MIME part ID.
public
string
$section
= \null
$uid
The IMAP UID.
public
string
$uid
= \null
$uidvalidity
The IMAP UIDVALIDITY for the given mailbox.
public
int
$uidvalidity
= \null
$urlauth
URLAUTH info (not parsed).
public
string
$urlauth
= \null
$username
The username to use on the remote server.
public
string
$username
= \null
Methods
__construct()
Constructor.
public
__construct([string $url = null ]) : mixed
Absolute IMAP URLs takes one of the following forms:
- imap://
[/] - imap://
/ [ ][? ] - imap://
/ [ ] [ ][ ][ ]
POP URLs take one of the following forms:
- pop://
;auth= @ :
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> —__toString()
Create a POP3 (RFC 2384) or IMAP (RFC 5092/5593) URL.
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