PHP 클래스 IMP_Mailbox_List, horde

저자: Michael Slusarz ([email protected])
상속: implements ArrayAccess, implements Countable, implements Iterator, implements Serializable
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$changed boolean Has the internal message list changed?
$headersUsed array The list of headers used by this class.

보호된 프로퍼티들

프로퍼티 타입 설명
$_buidmax integer Max assigned browser-UID.
$_buids array Mapping of browser-UIDs to UIDs.
$_cacheid string The IMAP cache ID of the mailbox.
$_mailbox IMP_Mailbox The mailbox to work with.
$_sorted array The array of sorted indices.
$_thread array The thread object representation(s) for the mailbox.
$_threadui array The thread tree UI cached data.

공개 메소드들

메소드 설명
__construct ( string $mbox ) Constructor.
count ( ) : integer Returns the current message count of the mailbox.
current ( ) : array
getArrayIndex ( integer $uid, string $mbox = null ) : mixed Returns the array index of the given message UID.
getBuid ( string $mbox, integer $uid ) : integer Create a browser-UID from a mail UID.
getFullThread ( integer $uid, string $mbox = null ) : IMP_Indices Returns the list of UIDs for an entire thread given one message in that thread.
getIndicesOb ( ) : IMP_Indices Generate an IMP_Indices object out of the contents of this mailbox.
getMailboxArray ( array $msgnum ) : array Build the array of message information.
getThreadOb ( integer $offset ) : IMP_Mailbox_List_Thread Returns a thread object for a message.
key ( ) : integer
mailboxStart ( integer $total ) : integer Determines the sequence number of the first message to display, based on the user's preferences.
next ( )
offsetExists ( integer $offset )
offsetGet ( integer $offset ) : array
offsetSet ( $offset, $value )
offsetUnset ( $offset )
rebuild ( boolean $reset = false ) Rebuilds/resets the mailbox list.
resolveBuid ( integer $buid ) : array Resolve a mail UID from a browser-UID.
rewind ( )
serialize ( ) : string Serialization.
unseenMessages ( integer $results, array $opts = [] ) : mixed Get the list of unseen messages in the mailbox (IMAP UNSEEN flag, with UNDELETED if we're hiding deleted messages).
unserialize ( string $data ) Unserialization.
valid ( )

보호된 메소드들

메소드 설명
_buildMailbox ( ) Builds the sorted list of messages in the mailbox.
_buildMailboxProcess ( IMP_Mailbox $mbox, array $sorted ) : array Run after the initial mailbox search is completed.
_buildMailboxQuery ( )
_getMbox ( integer $id ) : IMP_Mailbox Get the mailbox for a sequence ID.
_getThread ( string $mbox, array $extra = [] ) : Horde_Imap_Client_Data_Thread Returns the thread object for a mailbox.
_serialize ( )
_unserialize ( $data )

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( string $mbox )
$mbox string The mailbox to work with.

_buildMailbox() 보호된 메소드

Builds the sorted list of messages in the mailbox.
protected _buildMailbox ( )

_buildMailboxProcess() 보호된 메소드

Run after the initial mailbox search is completed.
protected _buildMailboxProcess ( IMP_Mailbox $mbox, array $sorted ) : array
$mbox IMP_Mailbox Mailbox searched.
$sorted array Sorted list of UIDs.
리턴 array Sorted list of UIDs.

_buildMailboxQuery() 보호된 메소드

protected _buildMailboxQuery ( )

_getMbox() 보호된 메소드

Get the mailbox for a sequence ID.
protected _getMbox ( integer $id ) : IMP_Mailbox
$id integer Sequence ID.
리턴 IMP_Mailbox The mailbox.

_getThread() 보호된 메소드

Returns the thread object for a mailbox.
protected _getThread ( string $mbox, array $extra = [] ) : Horde_Imap_Client_Data_Thread
$mbox string The mailbox.
$extra array Extra options to pass to IMAP thread() command.
리턴 Horde_Imap_Client_Data_Thread Thread object.

_serialize() 보호된 메소드

protected _serialize ( )

_unserialize() 보호된 메소드

protected _unserialize ( $data )

count() 공개 메소드

Returns the current message count of the mailbox.
public count ( ) : integer
리턴 integer The mailbox message count.

current() 공개 메소드

public current ( ) : array
리턴 array Two-element array: - m: (IMP_Mailbox) Mailbox of message. - u: (string) UID of message.

getArrayIndex() 공개 메소드

Returns the array index of the given message UID.
public getArrayIndex ( integer $uid, string $mbox = null ) : mixed
$uid integer The message UID.
$mbox string The message mailbox (defaults to the current mailbox).
리턴 mixed The array index of the location of the message UID in the current mailbox. Returns null if not found.

getBuid() 공개 메소드

Create a browser-UID from a mail UID.
public getBuid ( string $mbox, integer $uid ) : integer
$mbox string The mailbox.
$uid integer UID.
리턴 integer Browser-UID.

getFullThread() 공개 메소드

Returns the list of UIDs for an entire thread given one message in that thread.
public getFullThread ( integer $uid, string $mbox = null ) : IMP_Indices
$uid integer The message UID.
$mbox string The message mailbox (defaults to the current mailbox).
리턴 IMP_Indices An indices object.

getIndicesOb() 공개 메소드

Generate an IMP_Indices object out of the contents of this mailbox.
public getIndicesOb ( ) : IMP_Indices
리턴 IMP_Indices An indices object.

getMailboxArray() 공개 메소드

Build the array of message information.
public getMailboxArray ( array $msgnum ) : array
$msgnum array An array of index numbers.
리턴 array An array with the following keys:
  - overview: (array) The overview information. Contains the following:
    - envelope: (Horde_Imap_Client_Data_Envelope) Envelope information
                returned from the IMAP server.
    - flags: (array) The list of IMAP flags returned from the server.
    - headers: (array) Horde_Mime_Headers objects containing header
               data for non-envelope headers.
    - idx: (integer) Array index of this message.
    - mailbox: (string) The mailbox containing the message.
    - size: (integer) The size of the message in bytes.
    - uid: (string) The unique ID of the message.
  - uids: (IMP_Indices) An indices object.

getThreadOb() 공개 메소드

Returns a thread object for a message.
public getThreadOb ( integer $offset ) : IMP_Mailbox_List_Thread
$offset integer Sequence number of message.
리턴 IMP_Mailbox_List_Thread The thread object.

key() 공개 메소드

public key ( ) : integer
리턴 integer Sequence number of message.

mailboxStart() 공개 메소드

Determines the sequence number of the first message to display, based on the user's preferences.
public mailboxStart ( integer $total ) : integer
$total integer The total number of messages in the mailbox.
리턴 integer The sequence number in the sorted mailbox.

next() 공개 메소드

public next ( )

offsetExists() 공개 메소드

public offsetExists ( integer $offset )
$offset integer Sequence number of message.

offsetGet() 공개 메소드

public offsetGet ( integer $offset ) : array
$offset integer Sequence number of message.
리턴 array Two-element array: - m: (IMP_Mailbox) Mailbox of message. - u: (string) UID of message.

offsetSet() 공개 메소드

public offsetSet ( $offset, $value )

offsetUnset() 공개 메소드

public offsetUnset ( $offset )

rebuild() 공개 메소드

Rebuilds/resets the mailbox list.
public rebuild ( boolean $reset = false )
$reset boolean If true, resets the list instead of rebuilding.

resolveBuid() 공개 메소드

Resolve a mail UID from a browser-UID.
public resolveBuid ( integer $buid ) : array
$buid integer Browser-UID.
리턴 array Two-element array: - m: (IMP_Mailbox) Mailbox of message. - u: (string) UID of message.

rewind() 공개 메소드

public rewind ( )

serialize() 공개 메소드

Serialization.
public serialize ( ) : string
리턴 string Serialized data.

unseenMessages() 공개 메소드

Get the list of unseen messages in the mailbox (IMAP UNSEEN flag, with UNDELETED if we're hiding deleted messages).
public unseenMessages ( integer $results, array $opts = [] ) : mixed
$results integer A Horde_Imap_Client::SEARCH_RESULTS_* constant that indicates the desired return type.
$opts array Additional options: - sort: (array) List of sort criteria to use. - uids: (boolean) Return UIDs instead of sequence numbers (for $results queries that return message lists). DEFAULT: false
리턴 mixed Whatever is requested in $results.

unserialize() 공개 메소드

Unserialization.
public unserialize ( string $data )
$data string Serialized data.

valid() 공개 메소드

public valid ( )

프로퍼티 상세

$_buidmax 보호되어 있는 프로퍼티

Max assigned browser-UID.
protected int $_buidmax
리턴 integer

$_buids 보호되어 있는 프로퍼티

Mapping of browser-UIDs to UIDs.
protected array $_buids
리턴 array

$_cacheid 보호되어 있는 프로퍼티

The IMAP cache ID of the mailbox.
protected string $_cacheid
리턴 string

$_mailbox 보호되어 있는 프로퍼티

The mailbox to work with.
protected IMP_Mailbox $_mailbox
리턴 IMP_Mailbox

$_sorted 보호되어 있는 프로퍼티

The array of sorted indices.
protected array $_sorted
리턴 array

$_thread 보호되어 있는 프로퍼티

The thread object representation(s) for the mailbox.
protected array $_thread
리턴 array

$_threadui 보호되어 있는 프로퍼티

The thread tree UI cached data.
protected array $_threadui
리턴 array

$changed 공개적으로 프로퍼티

Has the internal message list changed?
public bool $changed
리턴 boolean

$headersUsed 공개적으로 정적으로 프로퍼티

The list of headers used by this class.
public static array $headersUsed
리턴 array