crVCL PHP Framework Version 2.9
  • Class
  • Tree
  • Todo
  • Download

Classes

  • _html_Doc
  • array2domxml
  • array2xml
  • cap_str
  • chart
  • chartline
  • config_crvcl_inc
  • Contoller
  • ContollerMain
  • ContollerPage
  • Controller
  • ControllerMain
  • ControllerPage
  • CouchDB
  • crAsync
  • crDateTime
  • CriticalSection
  • crJWT
  • crVCLSessionHandler
  • daemon
  • dictBase
  • domxml2array
  • DTA
  • DTAUS
  • DTAZV
  • ErrorHandler
  • ExceptionHandler
  • ffmpegbin
  • fsock
  • GeoIPLib
  • GoogleAnalyticsParser
  • htaccess
  • html5_Video
  • html_Anchor
  • html_Button
  • html_Calendar
  • html_Checkbox
  • html_ChkListbox
  • html_Choosebox
  • html_CKEditor
  • html_Colorbox
  • html_Combobox
  • html_Component
  • html_ComponentAMP
  • html_Datepicker
  • html_DivTable
  • html_Doc
  • html_DocAMP
  • html_Edit
  • html_Events
  • html_FlvBox
  • html_FocusEvents
  • html_FocusEventsEx
  • html_FoldingBox
  • html_Form
  • html_GroupBox
  • html_iFrame
  • html_Img
  • html_ImgAMP
  • html_InfoBox
  • html_Label
  • html_LinkLabel
  • html_List
  • html_Listbox
  • html_Marquee
  • html_Marquee2
  • html_Memo
  • html_Msgbox
  • html_OpenDialog
  • html_Optionbox
  • html_Panel
  • html_Radiobutton
  • html_Resultbar
  • html_RichText
  • html_Slider
  • html_Spinbutton
  • html_TabbedPane
  • html_TabControl
  • html_Table
  • html_tagCloud
  • html_TinyMCE
  • html_Window
  • http
  • httprequest
  • imap
  • imap_attachment
  • imap_body
  • imap_header
  • imap_msg
  • imgbar
  • Int64
  • JBridge
  • Logger
  • mail
  • multiAjaxHtmlResponse
  • mvc_module_loader
  • MySQL
  • MySQL_
  • MySQLBuilder
  • MySQLLang
  • MySQLResult
  • OpcodeCache
  • PDF
  • process_pid
  • QRCodeMinified
  • Redis
  • RESTful
  • RESTful_Client
  • RESTful_Server
  • RSS
  • rtf
  • sasl
  • sasl_basic
  • sasl_cram_md5
  • sasl_digest
  • sasl_interact
  • sasl_login
  • sasl_ntlm
  • sasl_plain
  • SepaRecord
  • SepaXML
  • SessionHandlerMemcache
  • SessionHandlerMySQL
  • SessionHandlerMySQLi
  • SessionHandlerRedis
  • shm
  • sitemap
  • SocialLib
  • sphinxAPI
  • sphinxQL
  • sphinxQLBuilder
  • sphinxResult
  • SQLiteDB
  • SQLiteDB_
  • SQLiteDBBuilder
  • SQLiteDBResult
  • template
  • TimeTrace
  • Viewer
  • whoisrequest
  • WSThread
  • XDXF_Parser
  • xml2array
  • xmlHelper
  • XMLRPC
  • XMLRPC_Client
  • XMLRPC_Server
  • zipLib

Interfaces

  • html_iComponent
  • icrVCLSessionHandler

Traits

  • html_tComponent

Functions

  • _ISO_Lang_Convert
  • acount
  • add_trailing_slash
  • addAjaxAnswerToElement
  • ajax_callback
  • ajax_request
  • ajax_setFormData2Fragment
  • ajax_setFragment2FormData
  • ajax_translate_special_char
  • Ansi2OEM
  • apache_request_headers
  • apc_opcode_priming_compiler
  • array2js_form_set
  • array2js_from_set
  • Array2strAttribute
  • array2string
  • array2UrlData
  • array_combine_values
  • array_concat
  • array_del
  • array_filelist
  • array_gcd
  • array_insert
  • array_isearch
  • array_key_existsEx
  • array_lcm
  • array_mix
  • array_remove_empty
  • array_search_inner
  • array_search_key
  • array_search_needle
  • array_trim
  • array_xunique
  • ascii_non_visible_decode
  • authcode
  • authenticate
  • average
  • bandwidth2byteInt
  • base64_encode_bin
  • bitInValue
  • bitVal2array
  • boolstr
  • boolToSetting
  • boolval
  • boolvalEx
  • breakpoint_set
  • breakpoint_stop
  • breakpoint_watch
  • browserSupportAjax
  • byte2str
  • calculate_RFC2104HMAC
  • cast_str
  • checkdnsrr
  • checkEmail
  • chrEx
  • cidr_match
  • clearscreen
  • com_create_guid
  • copyEx
  • cpu_get_usage
  • create_menu
  • createVisiblePageRank
  • CRLF_fix
  • cron_scheduling
  • crVCLProfiler
  • cursor_color
  • cursor_down
  • cursor_erase_eol
  • cursor_erase_line
  • cursor_erase_sol
  • cursor_left
  • cursor_pos
  • cursor_restore
  • cursor_right
  • cursor_save
  • cursor_unsave
  • cursor_up
  • data_uri
  • date2MySQLDate
  • date2Timestamp
  • dateFormat
  • dateToMySQLDate
  • debug_backtrace_string
  • debugbreak
  • debugOut
  • DEC2DMS
  • dec2str
  • decryptEx
  • deepCopy
  • defineEx
  • diffDays
  • diffHour
  • diffMin
  • diffSec
  • dir_exists
  • DMS2Array
  • DMS2DEC
  • dns_get_mx
  • download
  • download_authcode_url
  • download_from_authcode
  • download_iframe
  • download_popup
  • enableCORS
  • encryptEx
  • escape_js
  • EU_VAT_Validate
  • even
  • extractFileExt
  • extractFileName
  • file_get_mimetype
  • file_read
  • file_write
  • fileExist
  • filepermsEx
  • firebugOut
  • fix_https
  • fix_session_register
  • fixpath
  • font
  • free
  • ftok
  • fw_exception_error_handler
  • fw_mvc_reset_component_changed
  • fwErrorHandler
  • fwExceptionHandler
  • gc_collect_cycles_overX
  • gcd
  • get_browserEx
  • get_defined_constantsEx
  • get_file_from_url
  • get_include_contents
  • get_Post_RAW_Data
  • get_profiler_info
  • getAlexaPageRank
  • getallheadersEx
  • getallheadersSize
  • getBrowser
  • getClientLanguage
  • getCountryList
  • getEthnicList
  • getFrameworkCSS
  • getFrameworkJS
  • getGooglePageRank
  • getLanguageList
  • getMonthList
  • getOrigin
  • getOS
  • getPHP_OS
  • getPHP_Version
  • getProxyInfo
  • getQuarter
  • getRealIp
  • getScript
  • getScriptPath
  • getServer
  • getSTDIN
  • getSubdomain
  • gettickcount
  • getURL
  • getURLPath
  • getWeekdayList
  • googleCH
  • googleTranslator
  • GUID
  • guidEx
  • gzdecodeEx
  • header_cache
  • header_http_error
  • header_nocache
  • hex2rgb
  • hex2str
  • html2text
  • html_entity_decode
  • htmldecode
  • http
  • httpAuth
  • https
  • imagick_fingerprint
  • in_arrayEx
  • iniBuffer2BlockArray
  • iniRead
  • iniWrite
  • interval
  • intval32
  • is_base64_encoded
  • is_bin
  • is_crawler
  • is_date
  • is_https
  • is_IE
  • is_mobile
  • is_number
  • is_robot
  • is_spider
  • is_ssl
  • is_utf8
  • is_utf8Ex
  • is_windows
  • iso_decode
  • ISOLang2Letter3Letter
  • ISOLang3Letter2Letter
  • issetOr
  • js
  • js_getFormData
  • js_mailto
  • js_removeFormData
  • js_safeEMail
  • JSON_FixDoubleSerialization
  • JSON_FixSingleElementArray
  • lcm
  • left
  • levenshtein_ratio
  • levenshteinEx
  • linefeed_detect
  • luhnCheck
  • marquee
  • mb_str_replace
  • measure
  • mix
  • mount
  • move
  • msgbox
  • mssleep
  • mvc_ajax_event
  • mvc_alert
  • mvc_component_changed
  • mvc_confirmbox
  • mvc_event
  • mvc_flags
  • mvc_prompt
  • mysql_isDateEmpty
  • mysql_isDateSet
  • mysql_SET_isCondition
  • mysql_unix_timestamp
  • MySQLFilter
  • normalize
  • normalize_filename
  • object2array
  • OEM2Ansi
  • optimizeCSS
  • optimizeHTML
  • optimizeJS
  • ordEx
  • parse_include
  • parseCmdPara
  • parseHeaders
  • passwordStrength
  • pcntl_pid_exists
  • phpinfoEx
  • portscan
  • pp
  • pp_xml
  • preg_last_error_msg
  • print_ajax
  • print_br
  • print_chunked
  • print_d
  • print_gz
  • print_pretty
  • print_pretty_xml
  • protocol
  • pwGen
  • quoted_printable_encode
  • random
  • redirect
  • remove_tags
  • request_async
  • reset_last_modified_for_internal_http_cache
  • rgb2hex
  • rgb2hsb
  • rgb2hsv
  • right
  • runExternal
  • rval
  • ScriptProtection
  • sec2str
  • seo_code_to_text_ratio
  • seo_keyword_density
  • seo_page_informations
  • session_clean_user_cookies
  • session_commitEx
  • session_end
  • session_expires
  • session_is_started
  • session_logout
  • setAjaxAnswerToElement
  • setting_sqlite_read
  • setting_sqlite_write
  • showFrameworkError
  • shutdown_function_crVCL_FatalError
  • socket_writeEx
  • space
  • str2bin
  • str2byteInt
  • str2dec
  • str2hex
  • str2sec
  • str_del
  • str_extract
  • str_getAttributeVal
  • str_getCssValue
  • str_parse_tags
  • str_random
  • str_replace_bin
  • str_trim_len
  • strAttribute2Array
  • strax
  • strcut
  • strcut_bin
  • strftimeEx
  • strhtmlformat
  • stricut
  • stricut_bin
  • string2array
  • strip_chars
  • strip_linebreaks
  • strip_spaces
  • stripHTML
  • stripInvalidXml
  • stripos_bin
  • stripWhiteSpace
  • strlen_bin
  • strOrd
  • strpos_bin
  • strpos_next_word
  • strrcut
  • strrcut_bin
  • strricut
  • strricut_bin
  • strripos_bin
  • strrpos_bin
  • strrpos_next_word
  • strtolower_bin
  • strtonum
  • strtoupper_bin
  • strzero
  • strzerocast
  • substr_bin
  • terminal_beep
  • terminal_cols
  • terminal_lines
  • text2html
  • timestamp2MySQLDateTime
  • trim_specialchars
  • trim_text
  • umount
  • unauthorized
  • unicode_array
  • unique_key
  • unix2DosTime
  • unlink_files
  • unpack31
  • unserializeEx
  • unserializeEx_v1
  • unserializeEx_v2
  • unzip
  • urlData2Array
  • utcdate
  • utf8_encodeEx
  • utf8_fix
  • utf8_to_RTF
  • UUID
  • validateEmail
  • var_dumpEx
  • var_dumpExHTML
  • var_name
  • waitForInput
  • wordwarp_detect
  • writeTrace
  • wsthread_exception_error_handler
  • XML2JSON
  • xmlentities
  • xmlentities_decode
  • xmlentitiesEx
  • xmlGetPara
  • xmlGetVal
  • xor32
  • XSSFilter
  • zeroFill
  • zlib_compression

Class imap

Located at mail.lib.php

Methods summary

public
# __construct( )
public
# __destruct( )
public
# free( )
public &
# getLogger( )
public
# writeTrace( $s, $header = "" )
public
# receive( )
public
# send( $string )
public
# connect( )
public
# disconnect( )
public boolean
# aut( string $str_type = null, string $str1 = null, string $str2 = null )

used if imap server need authentication instead of login (SASL)

used if imap server need authentication instead of login (SASL)

Parameters

$str_type
$str sample: LOGIN
$str1
sample: myuser
$str2
sample: mypw

Returns

boolean
public boolean
# login( )

login

login

Returns

boolean
public boolean
# logout( )

logout

logout

Returns

boolean
public array
# list_mailbox( string $ref_mail_box = "", string $wild_card = "*", boolean $active_sub = false )

list of mailsbox

list of mailsbox

Parameters

$ref_mail_box
$wild_card
$active_sub
"ture" to get mailbox user has declared as being "active" or "subscribed"

Returns

array
public boolean
# open( string $mailbox, string $readonly = false )

open/select a mailbox

open/select a mailbox

Parameters

$mailbox
$readonly

Returns

boolean
public boolean
# select( string $mailbox = "INBOX" )

select a mailbox

select a mailbox

Parameters

$mailbox

Returns

boolean
public string
# getSelected( )

get last open/selected mailbox

get last open/selected mailbox

Returns

string
public string
# status( string $mailbox, string $flag )

get status of mailbox

get status of mailbox

flags:

MESSAGES The number of messages in the mailbox.

RECENT The number of messages with the \Recent flag set.

UIDNEXT The next unique identifier value of the mailbox.

UIDVALIDITY The unique identifier validity value of the mailbox.

UNSEEN The number of messages which do not have the \Seen flag set.

Parameters

$mailbox
$flag

Returns

string
public integer
# count( $mailbox = "INBOX" )

number of messages in the mailbox

number of messages in the mailbox

Returns

integer
public boolean
# noop( )

noop function can be used as a periodic poll for new messages or message status updates during a period of inactivity

noop function can be used as a periodic poll for new messages or message status updates during a period of inactivity

Returns

boolean
public boolean
# create( string $mailbox )

create a mailbox

create a mailbox

Parameters

$mailbox

Returns

boolean
public boolean
# delete( string $mailbox )

delete a mailbox

delete a mailbox

Parameters

$mailbox

Returns

boolean
public boolean
# rename( string $mailbox_name_old, string $mailbox_name_new )

rename a mailbox

rename a mailbox

Parameters

$mailbox_name_old
$mailbox_name_new

Returns

boolean
public boolean
# subscribe( string $mailbox )

adds the specified mailbox name to the server's set of "active" or "subscribed" mailboxes

adds the specified mailbox name to the server's set of "active" or "subscribed" mailboxes

Parameters

$mailbox

Returns

boolean
public boolean
# unsubscribe( string $mailbox )

remove the specified mailbox name from the server's set of "active" or "subscribed" mailboxes

remove the specified mailbox name from the server's set of "active" or "subscribed" mailboxes

Parameters

$mailbox

Returns

boolean
public string
# check( )

The CHECK command requests a checkpoint of the currently selected mailbox. A checkpoint refers to any implementation-dependent housekeeping associated with the mailbox

The CHECK command requests a checkpoint of the currently selected mailbox. A checkpoint refers to any implementation-dependent housekeeping associated with the mailbox

Returns

string
public boolean
# close( )

close the currently selected mailbox

close the currently selected mailbox

Returns

boolean
public array
# search( string $query, string $charset = "", boolean $use_uid = false )

searches the mailbox for messages that match the given searching query

searches the mailbox for messages that match the given searching query

Parameters

$query
possible search keys SUBJECT , BODY , sample: SUBJECT "test mail", also see http://www.isi.edu/in-notes/rfc3501.txt
$charset
$use_uid

Returns

array
public string
# fetch( string $msg_set, string $msg_data_name, boolean $use_uid = false )

retrieves data associated with a message in the mailbox sample: $imap->fetch("30:103", "BODY[HEADER]") return the header for mail 30 and 103 sample: $imap->fetch("30:103", "BODY[TEXT]") return the TEXT for mail 30 and 103 also see http://www.isi.edu/in-notes/rfc3501.txt

retrieves data associated with a message in the mailbox sample: $imap->fetch("30:103", "BODY[HEADER]") return the header for mail 30 and 103 sample: $imap->fetch("30:103", "BODY[TEXT]") return the TEXT for mail 30 and 103 also see http://www.isi.edu/in-notes/rfc3501.txt

Parameters

$msg_set
$msg_data_name
$use_uid

Returns

string
public imap_msg
# fetch_msg( integer $id, boolean $use_uid = false, $limit = 0 )

fetch a mail

fetch a mail

Parameters

$id
$use_uid
$limit

Returns

imap_msg
public string
# store( string $msg_set, string $msg_data_name, boolean $value, $use_uid = false )

The STORE command alters data associated with a message in the mailbox.

The STORE command alters data associated with a message in the mailbox.

Parameters

$msg_set
$msg_data_name
$value
$use_uid
$use_uid

Returns

string
public boolean
# seen( integer $id, boolean $use_uid = false )

mark message as seen

mark message as seen

Parameters

$id
$use_uid

Returns

boolean
public boolean
# recent( integer $id, boolean $use_uid = false )

mark message as recent / unseen

mark message as recent / unseen

Parameters

$id
$use_uid

Returns

boolean
public boolean
# unseen( integer $id, boolean $use_uid = false )

mark message as unseen / recent

mark message as unseen / recent

Parameters

$id
$use_uid

Returns

boolean
public boolean
# delete_msg( integer $id, boolean $use_uid = false )

delete a mail

delete a mail

Parameters

$id
$use_uid

Returns

boolean
public boolean
# undelete_msg( integer $id, boolean $use_uid = false )

undelete a mail

undelete a mail

Parameters

$id
$use_uid

Returns

boolean
public array
# list_msg_unseen( $use_uid = false )

array with unseen mails

array with unseen mails

Returns

array
public array
# list_msg_undeleted( $use_uid = false )

array with undeleted mails

array with undeleted mails

Returns

array
public array
# list_msg_seen( $use_uid = false )

array with seen mails

array with seen mails

Returns

array
public array
# list_msg_deleted( $use_uid = false )

array with deleted mails

array with deleted mails

Returns

array
public string
# expung_deleted_msg( )

The EXPUNGE command permanently removes from the currently selected mailbox all messages that have the \Deleted flag set.

The EXPUNGE command permanently removes from the currently selected mailbox all messages that have the \Deleted flag set.

Returns

string

Properties summary

public $m_logger
# null
public $m_uid
# null
public $m_socket
# null
public boolean $m_login
# false
public string $m_mailbox
# ""
public string $m_host

imap host

imap host

# ""
public integer $m_port

port of imap

port of imap

# 143
public string $m_usr

user for imap auth.

user for imap auth.

# ""
public string $m_pw

pw of imap auth.

pw of imap auth.

# ""
public integer $m_error

errorcode

errorcode

# 0
public string $m_errormsg

error message

error message

# ""
public integer $m_timeout_s

connection timeout

connection timeout

# 5
public integer $m_socket_timeout_s

socket timeout

socket timeout

# 5
public mixed $m_trace_delAfter

size before trace file will set to zero

size before trace file will set to zero

# "1024K"
public string $m_trace_path

path for trace file

path for trace file

# ""
public string $m_trace_file

filename of tracefile

filename of tracefile

# ""
public string $m_trace_critical_section_id

enable critical section for write trace files

enable critical section for write trace files

# null
public string $m_trace_critical_section_path

path to share the critical section for write trace files

path to share the critical section for write trace files

# "./"
public integer $m_trace_critical_section_maxlock_ms

max lock time for zombie processes

max lock time for zombie processes

# 1000
public integer $m_trace_critical_section_sleep_ms

sleep for retry enter critical section

sleep for retry enter critical section

# 10
public string $m_charset_decode

charset allowed "ISO-8859-1" or "UFT-8";

charset allowed "ISO-8859-1" or "UFT-8";

# "UTF-8"
public boolean $m_trace_sqlite

write the trace to a SQLite file instead of a text file

write the trace to a SQLite file instead of a text file

# false
crVCL PHP Framework Version 2.9 API documentation generated by ApiGen