Class: Net_IMAP
Source Location: /Net_IMAP-1.1.3/Net/IMAP.php
Net_IMAPProtocol
|
--Net_IMAP
Provides an implementation of the IMAP protocol using PEAR's Net_Socket:: class.
Author(s):
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Method Detail
Net_IMAP (Constructor) [line 46]
Net_IMAP Net_IMAP(
[string
$host = 'localhost'], [int
$port = 143], [bool
$enableSTARTTLS = true], [string
$encoding = 'ISO-8859-1'])
|
|
Constructor Instantiates a new Net_SMTP object, overriding any defaults with parameters that are passed in.
Parameters:
addAnswered [line 2020]
mixed addAnswered(
mixed
$msg_id)
|
|
adds the Answered flag (\Answered) to the selected messages
Parameters:
addDeleted [line 2037]
mixed addDeleted(
mixed
$msg_id)
|
|
adds the Deleted flag (\Deleted) to the selected messages
Parameters:
addDraft [line 2071]
mixed addDraft(
mixed
$msg_id)
|
|
adds the Draft flag (\Draft) to the selected messages
Parameters:
addFlagged [line 2054]
mixed addFlagged(
mixed
$msg_id)
|
|
adds the Flagged flag (\Flagged) to the selected messages
Parameters:
addFlags [line 1986]
mixed addFlags(
mixed
$msg_id, mixed
$flags)
|
|
adds flags to the selected messages
Parameters:
addSeen [line 2003]
mixed addSeen(
mixed
$msg_id)
|
|
adds the Seen flag (\Seen) to the selected messages
Parameters:
appendMessage [line 1400]
mixed appendMessage(
string
$rfc_message, [string
$mailbox = null], [string
$flags_list = ''])
|
|
Appends a mail to a mailbox
Parameters:
connect [line 73]
true connect(
string
$host, string
$port, [bool
$enableSTARTTLS = true])
|
|
Attempt to connect to the IMAP server located at $host $port
Parameters:
copyMessages [line 1343]
mixed copyMessages(
string
$dest_mailbox, [mixed
$msg_id = null], [string
$source_mailbox = null], [boolean
$uidCopy = false])
|
|
Copies mail from one folder to another
Parameters:
createMailbox [line 1628]
mixed createMailbox(
string
$mailbox, [array
$options = null])
|
|
Creates the mailbox $mailbox
Parameters:
deleteACL [line 2679]
mixed deleteACL(
string
$mailbox_name, string
$user)
|
|
deletes the ACL on a mailbox
Parameters:
deleteAnnotation [line 2827]
mixed deleteAnnotation(
string
$entry, array
$values, [string
$mailbox_name = null])
|
|
delete annotation
Parameters:
deleteMailbox [line 1654]
mixed deleteMailbox(
string
$mailbox)
|
|
Deletes the mailbox $mailbox
Parameters:
deleteMessages [line 1285]
mixed deleteMessages(
[int
$msg_id = null], [boolean
$uidStore = false])
|
|
Marks a message for deletion. Only will be deleted if the disconnect() method is called with auto-expunge on true or expunge() method is called.
Parameters:
deleteMsg [line 3022]
same deleteMsg(
int
$msg_id)
|
|
same as deleteMessages($msg_id) Net_POP3 Compatibility function
Parameters:
disconnect [line 206]
mixed disconnect(
[boolean
$expungeOnExit = false])
|
|
Disconnect function. Sends the QUIT command and closes the socket.
Parameters:
examineMailbox [line 270]
mixed examineMailbox(
string
$mailbox)
|
|
Checks the mailbox $mailbox
Parameters:
expunge [line 2310]
expunge function. Sends the EXPUNGE command
getACL [line 2615]
mixed getACL(
[string
$mailbox_name = null])
|
|
get the Access Control List details
Parameters:
getACLRights [line 2747]
mixed getACLRights(
string
$user, [string
$mailbox_name = null])
|
|
returns an array containing the rights for given user on the mailbox this method can be used by any user, not only the administrator
Parameters:
getAnnotation [line 2861]
mixed getAnnotation(
string
$entries, array
$values, [string
$mailbox_name = null])
|
|
get annotation
Parameters:
getBody [line 530]
mixed getBody(
string
$msg_id, [boolean
$uidFetch = false], [string
$partId = ''])
|
|
Returns the body of the message with given message number.
Parameters:
getBodyPart [line 566]
mixed getBodyPart(
int
$msg_id, string
$partId, [boolean
$uidFetch = false])
|
|
Returns the body of the message with given message number.
Parameters:
getEnvelope [line 1162]
mixed getEnvelope(
[string
$mailbox = ''], [mixed
$msg_id = null], [boolean
$uidFetch = false])
|
|
Returns an array containing the message envelope
Parameters:
getFlags [line 1865]
mixed getFlags(
[mixed
$msg_id = null], [boolean
$includeUid = false])
|
|
Lists the flags of the selected messages
Parameters:
getHierarchyDelimiter [line 1475]
string getHierarchyDelimiter(
[string
$mailbox = ''])
|
|
Gets the HierachyDelimiter character used to create subfolders cyrus users "." and wu-imapd uses "/"
Parameters:
getListing [line 3005]
same getListing(
[int
$msg_id = null])
|
|
same as getMessagesList($msg_id) Net_POP3 Compatibility function
Parameters:
getMailboxes [line 1520]
mixed getMailboxes(
[string
$reference = ''], [string
$restriction_search = 0], [string
$returnAttributes = false])
|
|
Returns an array containing the names of the selected mailboxes
Parameters:
getMailboxSize [line 1219]
mixed getMailboxSize(
[string
$mailbox = ''])
|
|
Returns the sum of all the sizes of messages in $mailbox WARNING!!! The method's performance is not good if you have a lot of messages in the mailbox Use with care!
Parameters:
getMessages [line 962]
mixed getMessages(
[int
$msg_id = null], [boolean
$indexIsMessageNumber = true])
|
|
Returns the entire message with given message number.
Parameters:
getMessagesList [line 394]
mixed getMessagesList(
[string
$msg_id = null])
|
|
Returns an array containing the message ID, the size and the UID of each message selected. message selection can be a valid IMAP command, a number or an array of messages
Parameters:
getMessagesQuota [line 2508]
assoc getMessagesQuota(
[string
$mailbox_name = null])
|
|
Returns MESSAGES quota details
Parameters:
getMsg [line 2979]
mixed getMsg(
int
$msg_id)
|
|
Returns the entire message with given message number. Net_POP3 Compatibility function
Parameters:
getMyRights [line 2708]
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
Parameters:
getNamespace [line 1427]
getNumberOfMessages [line 1014]
mixed getNumberOfMessages(
[string
$mailbox = ''])
|
|
Returns number of messages in this mailbox
Parameters:
getNumberOfRecentMessages [line 1090]
mixed getNumberOfRecentMessages(
[string
$mailbox = ''])
|
|
Returns number of UnSeen messages in this mailbox
Parameters:
getNumberOfUnSeenMessages [line 1052]
mixed getNumberOfUnSeenMessages(
[string
$mailbox = ''])
|
|
Returns number of UnSeen messages in this mailbox
Parameters:
getParsedHeaders [line 346]
mixed getParsedHeaders(
int
$msg_id, [boolean
$keysToUpper = false], [string
$part_id = ''], [boolean
$uidFetch = false])
|
|
Returns the headers of the specified message in an associative array. Array keys are the header names, array values are the header values. In the case of multiple headers having the same names, eg Received:, the array value will be an indexed array of all the header values.
Parameters:
getRawHeaders [line 302]
mixed getRawHeaders(
int
$msg_id, [string
$part_id = ''], [boolean
$uidFetch = false])
|
|
Returns the raw headers of the specified message.
Parameters:
getSize [line 2948]
same as getMailboxSize() Net_POP3 Compatibility function
getStatus [line 1127]
mixed getStatus(
[string
$mailbox = ''])
|
|
Returns number of UnSeen messages in this mailbox
Parameters:
getStorageQuota [line 2464]
assoc getStorageQuota(
[string
$mailbox_name = null])
|
|
Returns STORAGE quota details
Parameters:
getStorageQuotaRoot [line 2420]
assoc getStorageQuotaRoot(
[string
$mailbox_name = null])
|
|
Returns STORAGE quota details
Parameters:
getStructure [line 599]
mixed getStructure(
int
$msg_id, [boolean
$uidFetch = false])
|
|
Returns the body of the message with given message number.
Parameters:
getSummary [line 440]
mixed getSummary(
[mixed
$msg_id = null], [boolean
$uidFetch = false])
|
|
Message summary
Parameters:
hasFlag [line 2277]
mixed hasFlag(
mixed
$message_nro, string
$flag)
|
|
checks if a flag is set
Parameters:
isAnswered [line 2208]
mixed isAnswered(
mixed
$message_nro)
|
|
check the Answered flag
Parameters:
isDeleted [line 2259]
mixed isDeleted(
mixed
$message_nro)
|
|
check the Deleted flag
Parameters:
isDraft [line 2242]
mixed isDraft(
mixed
$message_nro)
|
|
check the Draft flag
Parameters:
isFlagged [line 2225]
mixed isFlagged(
mixed
$message_nro)
|
|
check the flagged flag
Parameters:
isSeen [line 2191]
mixed isSeen(
mixed
$message_nro)
|
|
check the Seen flag
Parameters:
listsubscribedMailboxes [line 1785]
mixed listsubscribedMailboxes(
[string
$reference = ''], [string
$restriction_search = 0], [boolean
$returnAttributes = false])
|
|
Lists the subscription to mailboxes
Parameters:
login [line 127]
true login(
string
$user, string
$pass, [string
$useauthenticate = true], [boolean
$selectMailbox = true])
|
|
Attempt to authenticate to the IMAP server.
Parameters:
mailboxExist [line 1598]
mixed mailboxExist(
string
$mailbox)
|
|
Check if the mailbox name exists
Parameters:
numMsg [line 2963]
same numMsg(
[string
$mailbox = null])
|
|
same as getNumberOfMessages($mailbox) Net_POP3 Compatibility function
Parameters:
removeAnswered [line 2123]
mixed removeAnswered(
mixed
$msg_id)
|
|
remove the Answered flag (\Answered) from the selected messages
Parameters:
removeDeleted [line 2140]
mixed removeDeleted(
mixed
$msg_id)
|
|
remove the Deleted flag (\Deleted) from the selected messages
Parameters:
removeDraft [line 2174]
mixed removeDraft(
mixed
$msg_id)
|
|
remove the Draft flag (\Draft) from the selected messages
Parameters:
removeFlagged [line 2157]
mixed removeFlagged(
mixed
$msg_id)
|
|
remove the Flagged flag (\Flagged) from the selected messages
Parameters:
removeFlags [line 2089]
mixed removeFlags(
mixed
$msg_id, mixed
$flags)
|
|
remove flags from the selected messages
Parameters:
removeSeen [line 2106]
mixed removeSeen(
mixed
$msg_id)
|
|
remove the Seen flag (\Seen) from the selected messages
Parameters:
renameMailbox [line 1686]
mixed renameMailbox(
string
$oldmailbox, string
$newmailbox, [array
$options = null])
|
|
Renames the mailbox $mailbox
Parameters:
search [line 2338]
mixed search(
string
$search_list, [boolean
$uidSearch = false])
|
|
Search function. Sends the SEARCH command
Parameters:
selectMailbox [line 245]
mixed selectMailbox(
string
$mailbox)
|
|
Changes the default/current mailbox to $mailbox
Parameters:
setACL [line 2652]
mixed setACL(
string
$mailbox_name, string
$user, string
$acl)
|
|
Set ACL on a mailbox
Parameters:
setAnnotation [line 2794]
mixed setAnnotation(
string
$entry, array
$values, [string
$mailbox_name = null])
|
|
set annotation
Parameters:
setFlags [line 1920]
mixed setFlags(
mixed
$msg_id, mixed
$flags, [string
$mod = 'set'], [boolean
$uidStore = false])
|
|
Sets the flags of the selected messages
Parameters:
setMessagesQuota [line 2578]
true setMessagesQuota(
string
$mailbox_name, int
$quota)
|
|
sets MESSAGES quota
Parameters:
setStorageQuota [line 2551]
true setStorageQuota(
string
$mailbox_name, int
$quota)
|
|
sets STORAGE quota
Parameters:
sort [line 2372]
mixed sort(
string
$sort_list, [string
$charset = 'US-ASCII'], [string
$search_list = ''], [boolean
$uidSort = false])
|
|
sort function. Sends the SORT command
Parameters:
subscribeMailbox [line 1722]
mixed subscribeMailbox(
[string
$mailbox = null])
|
|
Subscribes to the selected mailbox
Parameters:
unsubscribeMailbox [line 1752]
mixed unsubscribeMailbox(
[string
$mailbox = null])
|
|
Removes the subscription to a mailbox
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:56:40 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|