IMAP_CLEARFLAG_FULL(3) 1 IMAP_CLEARFLAG_FULL(3)imap_clearflag_full - Clears flags on messagesSYNOPSIS
bool imap_clearflag_full (resource $imap_stream, string $sequence, string $flag, [int $options])
DESCRIPTION
This function causes a store to delete the specified $flag to the flags set for the messages in the specified $sequence.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $sequence
- A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an inter-
val with the X:Y syntax
o $flag
- The flags which you can unset are "\Seen", "\Answered", "\Flagged", "\Deleted", and "\Draft" (as defined by RFC2060)
o $options
-$options are a bit mask and may contain the single option:
o ST_UID - The sequence argument contains UIDs instead of sequence numbers
RETURN VALUES
Returns TRUE on success or FALSE on failure.
SEE ALSO imap_setflag_full(3).
PHP Documentation Group IMAP_CLEARFLAG_FULL(3)
Check Out this Related Man Page
IMAP_SEARCH(3) 1 IMAP_SEARCH(3)imap_search - This function returns an array of messages matching the given search criteriaSYNOPSIS
array imap_search (resource $imap_stream, string $criteria, [int $options = SE_FREE], [string $charset = NIL])
DESCRIPTION
This function performs a search on the mailbox currently opened in the given IMAP stream.
For example, to match all unanswered messages sent by Mom, you'd use: "UNANSWERED FROM mom". Searches appear to be case insensitive. This
list of criteria is from a reading of the UW c-client source code and may be incomplete or inaccurate (see also RFC2060, section 6.4.4).
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $criteria
- A string, delimited by spaces, in which the following keywords are allowed. Any multi-word arguments (e.g. FROM "joey smith")
must be quoted. Results will match all $criteria entries.
o ALL - return all messages matching the rest of the criteria
o ANSWERED - match messages with the \ANSWERED flag set
o BCC "string" - match messages with "string" in the Bcc: field
o BEFORE "date" - match messages with Date: before "date"
o BODY "string" - match messages with "string" in the body of the message
o CC "string" - match messages with "string" in the Cc: field
o DELETED - match deleted messages
o FLAGGED - match messages with the \FLAGGED (sometimes referred to as Important or Urgent) flag set
o FROM "string" - match messages with "string" in the From: field
o KEYWORD "string" - match messages with "string" as a keyword
o NEW - match new messages
o OLD - match old messages
o ON "date" - match messages with Date: matching "date"
o RECENT - match messages with the \RECENT flag set
o SEEN - match messages that have been read (the \SEEN flag is set)
o SINCE "date" - match messages with Date: after "date"
o SUBJECT "string" - match messages with "string" in the Subject:
o TEXT "string" - match messages with text "string"
o TO "string" - match messages with "string" in the To:
o UNANSWERED - match messages that have not been answered
o UNDELETED - match messages that are not deleted
o UNFLAGGED - match messages that are not flagged
o UNKEYWORD "string" - match messages that do not have the keyword "string"
o UNSEEN - match messages which have not been read yet
o $options
- Valid values for $options are SE_UID, which causes the returned array to contain UIDs instead of messages sequence numbers.
o $charset
-
RETURN VALUES
Returns an array of message numbers or UIDs.
Return FALSE if it does not understand the search $criteria or no messages have been found.
EXAMPLES
Example #1
imap_search(3) example
<?php
$conn = imap_open('{imap.example.com:993/imap/ssl}INBOX', 'foo@example.com', 'pass123', OP_READONLY);
$some = imap_search($conn, 'SUBJECT "HOWTO be Awesome" SINCE "8 August 2008"', SE_UID);
$msgnos = imap_search($conn, 'ALL');
$uids = imap_search($conn, 'ALL', SE_UID);
print_r($some);
print_r($msgnos);
print_r($uids);
?>
The above example will output something similar to:
Array
(
[0] => 4
[1] => 6
[2] => 11
)
Array
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
[4] => 5
[5] => 6
)
Array
(
[0] => 1
[1] => 4
[2] => 6
[3] => 8
[4] => 11
[5] => 12
)
SEE ALSO imap_listscan(3).
PHP Documentation Group IMAP_SEARCH(3)