Class Hm_IMAP
public interface to IMAP commands
- Hm_IMAP_Base
-
Hm_IMAP_Parser
-
Hm_IMAP_Cache
-
Hm_IMAP
public
|
|
public
boolean
|
|
public
|
|
public
boolean
|
|
public
|
|
public
string
|
|
public
array
|
#
get_special_use_mailboxes( string $type = false )
special version of LIST to return just special use mailboxes |
public
array
|
#
get_mailbox_list( boolean $lsub = false, $mailbox = '', $keyword = '*' )
get a list of mailbox folders |
public
|
|
public
array
|
|
public
|
|
public
array
|
#
get_mailbox_status( string $mailbox, array $args = array('UNSEEN', 'UIDVALIDITY', 'UIDNEXT', 'MESSAGES', 'RECENT') )
issue IMAP status command on a mailbox |
public
boolean
|
|
public
array
|
#
get_message_list( mixed $uids, boolean $raw = false )
return a header list for the supplied message uids |
public
array
|
|
private
array
|
|
private
array
|
|
public
string
|
#
get_message_content( integer $uid, string $message_part, boolean $max = false, integer $struct = true, mixed $struct,… )
get content for a message part |
public
array
|
|
public
array
|
#
get_message_headers( integer $uid, string $message_part = false, $raw = false )
get the headers for the selected message |
public
integer
|
#
start_message_stream( integer $uid, string $message_part )
start streaming a message part. returns the number of characters in the message |
public
string
|
#
read_stream_line( integer $size = 1024 )
read a line from a message stream. Called until it returns false will "stream" a message part content one line at a time. useful for avoiding memory consumption when dealing with large attachments |
public
array
|
#
sort_by_fetch( string $sort, boolean $reverse, string $filter, string $uid_str = false )
use FETCH to sort a list of uids when SORT is not available |
public
boolean
|
|
public
boolean
|
|
public
boolean
|
|
public
|
#
message_action( string $action, mixed $uids, string $mailbox = false, string $keyword = false )
perform an IMAP action on a message |
public
|
#
append_start( string $mailbox, integer $size, boolean $seen = true )
start writing a message to a folder with IMAP APPEND |
public
integer
|
|
public
boolean
|
|
public
|
|
public
string
|
|
public
string
|
|
public
boolean
|
|
public
string
|
|
public
void/string
|
#
show_debug( boolean $full = false, boolean $return = false, boolean $list = false )
output IMAP session debug info |
public
array
|
#
search_bodystructure( array $struct, string $search_flds, array $all = true, $res = array() )
search a nested BODYSTRUCTURE response for a specific part |
public
array
|
|
public
array
|
#
get_quota_root( string $mailbox )
use the IMAP GETQUOTAROOT command to fetch quota information about a mailbox |
public
array
|
|
public
boolean
|
|
public
array
|
|
public
array
|
#
get_message_sort_order( string $sort = 'ARRIVAL', boolean $reverse = true, string $filter = 'ALL', $esort = array() )
use the SORT extension to get a sorted UID list |
public
array
|
|
public
|
|
public
string
|
#
get_first_message_part( integer $uid, string $type, string $subtype = false, $struct = false )
return the formatted message content of the first part that matches the supplied MIME type |
public
array
|
#
get_mailbox_page( string $mailbox, string $sort, string $rev, integer $filter, integer $offset = 0, $limit = 0 )
return a list of headers and UIDs for a page of a mailbox |
public
array
|
#
get_folder_list_by_level( string $level = '' )
return all the folders contained at a hierarchy level, and if possible, if they have sub-folders |
bust_cache(),
cache_return_val(),
check_cache(),
collect_cache_entries_to_prune(),
dump_cache(),
load_cache(),
prune_cache(),
update_cache_data()
|
apply_config(),
check_response(),
fgets(),
get_response(),
input_validate(),
is_clean(),
parse_line(),
send_command(),
utf7_decode(),
utf7_encode()
|
public
boolean
|
$max_read
|
#
false
|
public
boolean
|
$verify_peer_name
|
#
false
|
public
boolean
|
$verify_peer
|
#
false
|
public
string
|
$server
|
#
'127.0.0.1'
|
public
integer
|
$port
|
#
143
|
public
boolean
|
$tls
|
#
false
|
public
boolean
|
$read_only
|
#
false
|
public
boolean
|
$utf7_folders
|
#
true
|
public
boolean
|
$auth
|
#
false
|
public
string
|
$search_charset
|
#
''
|
public
boolean
|
$sort_speedup
|
#
true
|
public
boolean
|
$use_cache
|
#
true
|
public
integer
|
$folder_max
|
#
50000
|
public
integer
|
$max_history
|
#
1000
|
public
string
|
$default_delimiter
|
#
'/'
|
public
string
|
$default_prefix
|
#
''
|
public
array
|
$blacklisted_extensions
|
#
array()
|
public
integer
|
$cache_limit
|
#
100
|
public
boolean
|
$no_caps
|
#
false
|
public
string
|
$app_name
|
#
'Hm_IMAP'
|
public
string
|
$app_version
|
#
'3.0'
|
public
string
|
$app_vendor
|
#
'Hastymail Development Group'
|
public
string
|
$app_support_url
|
#
'http://hastymail.org/contact_us/'
|
public
string
|
$con_error_msg
|
#
''
|
public
integer
|
$con_error_num
|
#
0
|
public
boolean
|
$selected_mailbox
|
#
false
|
public
array
|
$special_use_mailboxes
|
#
array(
'\All' => false,
'\Archive' => false,
'\Drafts' => false,
'\Flagged' => false,
'\Junk' => false,
'\Sent' => false,
'\Trash' => false
)
|
private
string
|
$state
|
#
'disconnected'
|
private
integer
|
$stream_size
|
#
0
|
public
boolean
|
$folder_state
|
#
false
|