Class imap

Located at mail.lib.php

Methods summary

`public`	# `imap( )`
`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`

Classes

Interfaces

Traits

Functions

Class imap

Methods summary

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Properties summary