Docs For Class Net

Net_IMAP (Constructor) [line 43]

Net_IMAP Net_IMAP(
[string
$host = 'localhost'], [int
$port = 143], string
2)

Constructor

Instantiates a new Net_SMTP object, overriding any defaults with parameters that are passed in.

Parameters:

string	`2`	—	The value to give when sending EHLO or HELO.
string	`$host`	—	The server to connect to.
int	`$port`	—	The port to connect to.

[ Top ]

addAnswered [line 1626]

mixed addAnswered(
mixed
$msg_id)

adds the Answered flag (\Answered) to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

addDeleted [line 1639]

mixed addDeleted(
mixed
$msg_id)

adds the Deleted flag (\Deleted) to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

addDraft [line 1665]

mixed addDraft(
mixed
$msg_id)

adds the Draft flag (\Draft) to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

addFlagged [line 1652]

mixed addFlagged(
mixed
$msg_id)

adds the Flagged flag (\Flagged) to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

addFlags [line 1600]

mixed addFlags(
mixed
$msg_id, mixed
$flags)

adds flags to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed	`$flags`	—	flags to set (space separated String or array)
mixed	`$msg_id`	—	the message list or string "all" for all

[ Top ]

addSeen [line 1613]

mixed addSeen(
mixed
$msg_id)

adds the Seen flag (\Seen) to the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

appendMessage [line 1061]

mixed appendMessage(
string
$rfc_message, [string
$mailbox = null], [
$flags_list = ''])

Appends a mail to a mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$rfc_message`	—	the message to append in RFC822 format
string	`$mailbox`	—	mailbox name to append to
	`$flags_list`	—

[ Top ]

connect [line 66]

true connect(
string
$host, string
$port)

Attempt to connect to the IMAP server located at $host $port

Return: on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string $host — The IMAP server

string

$port

—

The IMAP port

It is only useful in a very few circunstances because the contructor already makes this job

[ Top ]

copyMessages [line 1007]

mixed copyMessages(
string
$dest_mailbox, [mixed
$msg_id = null], [string
$source_mailbox = null], [bool
$uidCopy = false])

Copies mail from one folder to another

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$dest_mailbox`	—	mailbox name to copy sessages to
mixed	`$msg_id`	—	the messages that I want to copy (all by default) it also can be an array
string	`$source_mailbox`	—	mailbox name from where the messages are copied
bool	`$uidCopy`	—	msg_id contains UID's instead of Message Sequence Number if set to true

[ Top ]

createMailbox [line 1283]

mixed createMailbox(
string
$mailbox, [array
$options = null])

Creates the mailbox $mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$mailbox`	—	mailbox name to create
array	`$options`	—	options to pass to create

[ Top ]

deleteACL [line 2159]

mixed deleteACL(
string
$mailbox_name, string
$user)

deletes the ACL on a mailbox

Return: True on success, or PEAR_Error on false
Since: 1.0
Access: public

Parameters:

string	`$mailbox_name`	—	the mailbox
string	`$user`	—	user to set the ACL

[ Top ]

deleteAnnotation [line 2289]

void deleteAnnotation(

$entry, 
$values, [
$mailbox_name = null])

Parameters:

	`$entry`	—
	`$values`	—
	`$mailbox_name`	—

[ Top ]

deleteMailbox [line 1302]

mixed deleteMailbox(
string
$mailbox)

Deletes the mailbox $mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string $mailbox — mailbox name to delete

[ Top ]

deleteMessages [line 952]

void deleteMessages(
[
$msg_id = null], [
$uidStore = false])

Parameters:

	`$msg_id`	—
	`$uidStore`	—

[ Top ]

deleteMsg [line 2425]

void deleteMsg(

$msg_id)

Parameters:

$msg_id —

[ Top ]

disconnect [line 180]

void disconnect(
[
$expungeOnExit = false])

Parameters:

$expungeOnExit —

[ Top ]

examineMailbox [line 230]

void examineMailbox(

$mailbox)

Parameters:

$mailbox —

[ Top ]

expunge [line 1872]

void expunge(
)

****************************************************************

* ** * MISC METHODS ** * ** ****************************************************************

[ Top ]

getACL [line 2099]

string getACL(
[string
$mailbox_name = null])

get the Access Control List details

Return: on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string $mailbox_name — Mailbox to get ACL info.

[ Top ]

getACLRights [line 2223]

mixed getACLRights(

$user, [string
$mailbox_name = null])

returns an array containing the rights that a user logged on has on the mailbox this method can be used by any user, not only the administrator

Return: string contailing the list of rights on success, or PEAR_Error on failure
Since: 1.0
Access: public

Parameters:

string	`$mailbox_name`	—	the mailbox to query rights
	`$user`	—

[ Top ]

getAnnotation [line 2309]

void getAnnotation(

$entries, 
$values, [
$mailbox_name = null])

Parameters:

	`$entries`	—
	`$values`	—
	`$mailbox_name`	—

[ Top ]

getBody [line 413]

void getBody(

$msg_id, [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$uidFetch`	—

[ Top ]

getBodyPart [line 437]

void getBodyPart(

$msg_id, 
$partId, [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$partId`	—
	`$uidFetch`	—

[ Top ]

getEnvelope [line 829]

void getEnvelope(
[
$mailbox = ''], [
$msg_id = null], [
$uidFetch = false])

Parameters:

	`$mailbox`	—
	`$msg_id`	—
	`$uidFetch`	—

[ Top ]

getFlags [line 1500]

mixed getFlags(
[mixes
$msg_id = null])

Lists the flags of the selected messages

Return: array on Success/PearError on Failure
Since: 1.0

Parameters:

mixes $msg_id — the message list

[ Top ]

getHierarchyDelimiter [line 1138]

string getHierarchyDelimiter(
[
$mailbox = ''])

Gets the HierachyDelimiter character used to create subfolders cyrus users "." and wu-imapd uses "/"

$param string the mailbox to get the hierarchy from

Return: the hierarchy delimiter
Since: 1.0
Access: public

Parameters:

$mailbox —

[ Top ]

getListing [line 2419]

void getListing(
[
$msg_id = null])

Parameters:

$msg_id —

[ Top ]

getMailboxes [line 1182]

mixed getMailboxes(
[
$reference = ''], [string
$restriction_search = 0], [string
$returnAttributes = false], string
$mailbox_base)

Returns an array containing the names of the selected mailboxes

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$mailbox_base`	—	base mailbox to start the search $mailbox_base if $mailbox_base == '' then $mailbox_base is the curent selected mailbox
string	`$restriction_search`	—	false or 0 means return all mailboxes true or 1 return only the mailbox that contains that exact name
string	`$returnAttributes`	—	true means return an assoc array containing mailbox names and mailbox attributes
	`$reference`	—

[ Top ]

getMailboxSize [line 884]

void getMailboxSize(
[
$mailbox = ''])

Parameters:

$mailbox —

[ Top ]

getMessages [line 670]

void getMessages(
[
$msg_id = null], [
$indexIsMessageNumber = true])

Parameters:

	`$msg_id`	—
	`$indexIsMessageNumber`	—

[ Top ]

getMessagesList [line 330]

void getMessagesList(
[
$msg_id = null])

Parameters:

$msg_id —

[ Top ]

getMessagesQuota [line 2003]

assoc getMessagesQuota(
[string
$mailbox_name = null])

Returns MESSAGES quota details

Return: array contaning the quota info on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string $mailbox_name — Mailbox to get quota info.

[ Top ]

getMsg [line 2406]

void getMsg(

$msg_id)

Parameters:

$msg_id —

[ Top ]

getMyRights [line 2182]

mixed getMyRights(
[string
$mailbox_name = null])

returns the rights that the user logged on has on the mailbox this method can be used by any user, not only the administrator

Return: string contailing the list of rights on success, or PEAR_Error on failure
Since: 1.0
Access: public

Parameters:

string $mailbox_name — the mailbox to query rights

[ Top ]

getNamespace [line 1083]

mixed getNamespace(
string
$rfc_message, string
$mailbox)

Appends a mail to a mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$rfc_message`	—	the message to append in RFC822 format
string	`$mailbox`	—	mailbox name to append to

[ Top ]

getNumberOfMessages [line 718]

void getNumberOfMessages(
[
$mailbox = ''])

Parameters:

$mailbox —

[ Top ]

getNumberOfRecentMessages [line 773]

void getNumberOfRecentMessages(
[
$mailbox = ''])

Parameters:

$mailbox —

[ Top ]

getNumberOfUnSeenMessages [line 746]

void getNumberOfUnSeenMessages(
[
$mailbox = ''])

Parameters:

$mailbox —

[ Top ]

getParsedHeaders [line 293]

void getParsedHeaders(

$msg_id, [
$keysToUpper = false], [
$part_id = ''], [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$keysToUpper`	—
	`$part_id`	—
	`$uidFetch`	—

[ Top ]

getRawHeaders [line 257]

void getRawHeaders(

$msg_id, [
$part_id = ''], [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$part_id`	—
	`$uidFetch`	—

[ Top ]

getSize [line 2389]

void getSize(
)

***************************************************

*******************************************************

[ Top ]

getStatus [line 800]

void getStatus(
[
$mailbox = ''])

Parameters:

$mailbox —

[ Top ]

getStorageQuota [line 1967]

assoc getStorageQuota(
[string
$mailbox_name = null])

Returns STORAGE quota details

Return: array contaning the quota info on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string $mailbox_name — Mailbox to get quota info.

[ Top ]

getStorageQuotaRoot [line 1933]

assoc getStorageQuotaRoot(
[string
$mailbox_name = null])

Returns STORAGE quota details

Return: array contaning the quota info on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string $mailbox_name — Mailbox to get quota info.

[ Top ]

getStructure [line 460]

void getStructure(

$msg_id, [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$uidFetch`	—

[ Top ]

getSummary [line 357]

void getSummary(
[
$msg_id = null], [
$uidFetch = false])

Parameters:

	`$msg_id`	—
	`$uidFetch`	—

[ Top ]

hasFlag [line 1837]

void hasFlag(

$message_nro, 
$flag)

Parameters:

	`$message_nro`	—
	`$flag`	—

[ Top ]

isAnswered [line 1773]

mixed isAnswered(
mixes
$message_nro)

check the Answered flag

Return: true or false if the flag is sert PearError on Failure
Since: 1.0

Parameters:

mixes $message_nro — the message to check

[ Top ]

isDeleted [line 1827]

mixed isDeleted(
mixes
$message_nro)

check the Deleted flag

Return: true or false if the flag is sert PearError on Failure
Since: 1.0

Parameters:

mixes $message_nro — the message to check

[ Top ]

isDraft [line 1808]

mixed isDraft(
mixes
$message_nro)

check the Draft flag

Return: true or false if the flag is sert PearError on Failure
Since: 1.0

Parameters:

mixes $message_nro — the message to check

[ Top ]

isFlagged [line 1790]

mixed isFlagged(
mixes
$message_nro)

check the flagged flag

Return: true or false if the flag is sert PearError on Failure
Since: 1.0

Parameters:

mixes $message_nro — the message to check

[ Top ]

isSeen [line 1757]

mixed isSeen(
mixes
$message_nro)

check the Seen flag

Return: true or false if the flag is sert PearError on Failure
Since: 1.0

Parameters:

mixes $message_nro — the message to check

[ Top ]

listsubscribedMailboxes [line 1415]

mixed listsubscribedMailboxes(
[
$reference = ''], [
$restriction_search = 0], [
$returnAttributes = false], string
$mailbox_base, string
$mailbox_name)

Lists the subscription to mailboxes

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$mailbox_base`	—	mailbox name start the search (see to getMailboxes() )
string	`$mailbox_name`	—	mailbox name filter the search (see to getMailboxes() )
	`$reference`	—
	`$restriction_search`	—
	`$returnAttributes`	—

[ Top ]

login [line 121]

true login(
string
$user, string
$pass, [string
$useauthenticate = true], [boolean
$selectMailbox = true])

Attempt to authenticate to the IMAP server.

Return: on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string	`$user`	—	The userid to authenticate as.
string	`$pass`	—	The password to authenticate with.
string	`$useauthenticate`	—	true: authenticate using the IMAP AUTHENTICATE command. false: authenticate using the IMAP AUTHENTICATE command. 'string': authenticate using the IMAP AUTHENTICATE command but using the authMethod in 'string'
boolean	`$selectMailbox`	—	automaticaly select inbox on login (false does not)

[ Top ]

mailboxExist [line 1252]

boolean mailboxExist(
string
$mailbox)

check if the mailbox name exists

Return: true on Success/false on Failure
Since: 1.0

Parameters:

string $mailbox — mailbox name to check existance

[ Top ]

numMsg [line 2394]

void numMsg(
[
$mailbox = null])

Parameters:

$mailbox —

[ Top ]

removeAnswered [line 1705]

mixed removeAnswered(
mixed
$msg_id)

remove the Answered flag (\Answered) from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

removeDeleted [line 1718]

mixed removeDeleted(
mixed
$msg_id)

remove the Deleted flag (\Deleted) from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

removeDraft [line 1744]

mixed removeDraft(
mixed
$msg_id)

remove the Draft flag (\Draft) from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

removeFlagged [line 1731]

mixed removeFlagged(
mixed
$msg_id)

remove the Flagged flag (\Flagged) from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

removeFlags [line 1679]

mixed removeFlags(
mixed
$msg_id, mixed
$flags)

remove flags from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed	`$flags`	—	flags to remove (space separated string or array)
mixed	`$msg_id`	—	the message list or string "all" for all

[ Top ]

removeSeen [line 1692]

mixed removeSeen(
mixed
$msg_id)

remove the Seen flag (\Seen) from the selected messages

Return: true on success/PearError on failure

Parameters:

mixed $msg_id — the message list or string "all" for all

[ Top ]

renameMailbox [line 1332]

mixed renameMailbox(

$oldmailbox, 
$newmailbox, [array
$options = null], string
$mailbox)

Renames the mailbox $mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string	`$mailbox`	—	mailbox name to rename
array	`$options`	—	options to pass to rename
	`$oldmailbox`	—
	`$newmailbox`	—

[ Top ]

search [line 1893]

void search(

$search_list, [
$uidSearch = false])

Parameters:

	`$search_list`	—
	`$uidSearch`	—

[ Top ]

selectMailbox [line 209]

void selectMailbox(

$mailbox)

Parameters:

$mailbox —

[ Top ]

setACL [line 2137]

mixed setACL(
string
$mailbox_name, string
$user, string
$acl)

Set ACL on a mailbox

Return: True on success, or PEAR_Error on false
Since: 1.0
Access: public

Parameters:

string	`$mailbox_name`	—	the mailbox
string	`$user`	—	user to set the ACL
string	`$acl`	—	ACL list

[ Top ]

setAnnotation [line 2269]

void setAnnotation(

$entry, 
$values, [
$mailbox_name = null])

****************************************************************

* ** * ANNOTATEMORE METHODS ** * ** ****************************************************************

Parameters:

	`$entry`	—
	`$values`	—
	`$mailbox_name`	—

[ Top ]

setFlags [line 1542]

mixed setFlags(
mixed
$msg_id, mixed
$flags, [string
$mod = 'set'], [$uidStore
$uidStore = false])

Sets the flags of the selected messages

Return: true on success/PearError on failure

Parameters:

mixed	`$msg_id`	—	the message list or string "all" for all
mixed	`$flags`	—	flags to set (space separated String or array)
string	`$mod`	—	"set" to set flags (default) "add" to add flags "remove" to remove flags
$uidStore	`$uidStore`	—	bool msg_id contains UID's instead of Message Sequence Number if set to true

[ Top ]

setMessagesQuota [line 2061]

true setMessagesQuota(
string
$mailbox_name, 
$quota)

sets MESSAGES quota details

Return: on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string	`$mailbox_name`	—	Mailbox to get quota info.
	`$quota`	—

[ Top ]

setStorageQuota [line 2039]

true setStorageQuota(
string
$mailbox_name, 
$quota)

sets STORAGE quota details

Return: on success or PEAR_Error
Since: 1.0
Access: public

Parameters:

string	`$mailbox_name`	—	Mailbox to get quota info.
	`$quota`	—

[ Top ]

subscribeMailbox [line 1367]

mixed subscribeMailbox(
[string
$mailbox = null])

Subscribes to the selected mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string $mailbox — mailbox name to subscribe

[ Top ]

unsubscribeMailbox [line 1391]

mixed unsubscribeMailbox(
[string
$mailbox = null])

Removes the subscription to a mailbox

Return: true on Success/PearError on Failure
Since: 1.0

Parameters:

string $mailbox — mailbox name to unsubscribe

[ Top ]

Class: Net_IMAP

Class Overview

Author(s):

Methods

Inherited Variables

Class: Net_IMAPProtocol

Inherited Methods

Class: Net_IMAPProtocol

Class Details

Method Detail

Net_IMAP (Constructor) [line 43]

Parameters:

addAnswered [line 1626]

Parameters:

addDeleted [line 1639]

Parameters:

addDraft [line 1665]

Parameters:

addFlagged [line 1652]

Parameters:

addFlags [line 1600]

Parameters:

addSeen [line 1613]

Parameters:

appendMessage [line 1061]

Parameters:

connect [line 66]

Parameters:

copyMessages [line 1007]

Parameters:

createMailbox [line 1283]

Parameters:

deleteACL [line 2159]

Parameters:

deleteAnnotation [line 2289]

Parameters:

deleteMailbox [line 1302]

Parameters:

deleteMessages [line 952]

Parameters:

deleteMsg [line 2425]

Parameters:

disconnect [line 180]

Parameters:

examineMailbox [line 230]

Parameters:

expunge [line 1872]

getACL [line 2099]

Parameters:

getACLRights [line 2223]

Parameters:

getAnnotation [line 2309]

Parameters:

getBody [line 413]

Parameters:

getBodyPart [line 437]

Parameters:

getEnvelope [line 829]

Parameters:

getFlags [line 1500]

Parameters:

getHierarchyDelimiter [line 1138]

Parameters:

getListing [line 2419]

Parameters:

getMailboxes [line 1182]

Parameters:

getMailboxSize [line 884]

Parameters:

getMessages [line 670]

Parameters:

getMessagesList [line 330]

Parameters:

getMessagesQuota [line 2003]

Parameters:

getMsg [line 2406]

Parameters:

getMyRights [line 2182]

Parameters:

getNamespace [line 1083]