Mailbox bridge class
| Methods | ||
|---|---|---|
public
|
__construct($server_id, $user_config, $session, $config)
|
# |
public
|
connect()
|
# |
public
|
get_connection()
|
# |
public
|
is_imap()
|
# |
public
|
is_smtp()
|
# |
public
|
server_type()
|
# |
public
|
authed()
|
# |
public
|
state()
|
# |
public
|
folder_exists($folder)
|
# |
public
|
get_folder_status($folder, $report_error = true)
|
# |
public
|
get_folder_name($folder)
|
# |
public
|
create_folder($folder, $parent = null)
|
# |
public
|
rename_folder($folder, $new_name, $parent = null)
|
# |
public
|
delete_folder($folder)
|
# |
public
|
prep_folder_name($folder)
|
# |
public
|
folder_subscription($folder, $action)
|
# |
public
|
get_folders($only_subscribed = false)
|
# |
public
|
get_subfolders($folder, $only_subscribed = false, $with_input = false, $count_children = false)
|
# |
public
|
get_folder_state()
|
# |
public
|
get_selected_folder()
|
# |
public
|
get_special_use_mailboxes($folder = false)
|
# |
public
|
get_messages(
$folder,
$sort,
$reverse,
$flag_filter,
$offset = 0,
$limit = 50,
$keyword = false,
$trusted_senders = [],
$include_preview = false,
): array
Get messages in a folder applying filters, sorting and pagination
Get messages in a folder applying filters, sorting and pagination Returns
|
# |
public
|
get_message_headers($folder, $msg_id)
|
# |
public
|
get_message_content($folder, $msg_id, $part = 0)
|
# |
public
|
get_structured_message($folder, $msg_id, $part, $text_only)
|
# |
public
|
store_message($folder, $msg, $seen = true, $draft = false)
|
# |
public
|
delete_message($folder, $msg_id, $trash_folder)
|
# |
public
|
message_action($folder, $action, $uids, $mailbox = false, $keyword = false)
|
# |
public
|
stream_message_part($folder, $msg_id, $part_id, $start_cb)
|
# |
public
|
remove_attachment($folder, $msg_id, $part_id)
|
# |
public
|
get_quota($folder, $root = false)
|
# |
public
|
get_debug()
|
# |
public
|
use_cache()
|
# |
public
|
dump_cache($type = 'string')
|
# |
public
|
get_state()
|
# |
public
|
get_capability()
|
# |
public
|
set_read_only($read_only)
|
# |
public
|
set_search_charset($charset)
|
# |
public
|
search(
$folder,
$target = 'ALL',
$terms = [],
$sort = null,
$reverse = null,
$exclude_deleted = true,
$exclude_auto_bcc = true,
$only_auto_bcc = false,
)
|
# |
public
|
get_message_list($folder, $msg_ids)
|
# |
public
|
send_message($from, $recipients, $message, $delivery_receipt = false)
|
# |
public
|
select_folder($folder)
|
# |
public
|
is_archive_folder($id, $user_config, $current_folder)
|
# |
public
|
get_config()
|
# |
| Constants | ||
|---|---|---|
public
|
TYPE_IMAP = 1
|
# |
public
|
TYPE_JMAP = 2
|
# |
public
|
TYPE_EWS = 3
|
# |
public
|
TYPE_SMTP = 4
|
# |
| Properties | |||
|---|---|---|---|
protected
|
|
$type
|
# |
protected
|
|
$connection
|
# |
protected
|
|
$selected_folder
|
# |
protected
|
|
$folder_state
|
# |
protected
|
|
$server_id
|
# |
protected
|
|
$user_config
|
# |
protected
|
|
$session
|
# |
protected
|
|
$config
|
# |