Php imap search uid

PHP — imap_search() Function

PHP−IMAP functions helps you to access email accounts, IMAP stands for Internet Mail Access Protocol using these functions you can also work with NNTP, POP3 protocols and local mailbox access methods.

The imap_search() accepts a resource value representing an IMAP stream, and a string value representing the search criteria as parameters, searches the mailbox and returns the matched messages in the form of an array.

Syntax

imap_search($imap_stream, $criteria, [$options, $charset]);

Parameters

imap_stream (Mandatory)s

This is a string value representing an IMAP stream, return value of the imap_open() function.

This is a string value representing the search criteria.

This is a string value representing the optional value SE_UID. On setting the array retuned contains UID’s instead of message sequences.

This is a string value representing the MIME character set to use during the search.

Return Values

This function returns an array which contains the message numbers/UID’s representing the matched messages in case of success and a Boolean value FALSE in case of failure.

PHP Version

This function was first introduced in PHP Version 4 and works in all the later versions.

Example

Following is another example of this function −

  INBOX"; $id = "tutorialspoint.test@gmail.com"; $pwd = "cohondob_123"; $imap = imap_open($url, $id, $pwd); print("Connection established. "."
"); print("Results of the search: "."
"); $emailData = imap_search($imap, ''); print_r($emailData); //Closing the connection imap_close($imap); ?>  

This generates the following output −

Connection established. Results of the search: Array ( [0] => 1 [1] => 2 [2] => 3 [3] => 4 [4] => 5 [5] => 6 )

Example

Following is another example of this function; this reads the unseen messages in the current inbox −

  INBOX"; $id = "tutorialspoint.test@gmail.com"; $pwd = "cohondob_123"; $imap = imap_open($url, $id, $pwd); print("Connection established. "."
"); print("Contents of the matched messages: "."
"); $emailData = imap_search($imap, "UNSEEN"); foreach ($emailData as $msg) < $msg = imap_fetchbody($imap, $msg, "1"); print(quoted_printable_decode($msg)."
"); > //Closing the connection imap_close($imap); ?>  

Output

This will generate the following output −

Connection established. Contents of the matched messages: Array ( [0] => 4 [1] => 5 [2] => 6 ) #sample_mail4 #sample_mail5 #sample_mail6

Example

Following is an example of this function with optional parameters −

  INBOX"; $id = "tutorialspoint.test@gmail.com"; $pwd = "cohondob_123"; $imap = imap_open($url, $id, $pwd); print("Connection established. "."
"); print("Contents of the matched messages: "."
"); $data = imap_search($imap, "ALL", SE_UID); print_r($data); //Closing the connection imap_close($imap); ?>  

Output

This will generate the following output −

Connection established. Contents of the matched messages: Array ( [0] => 19 [1] => 20 [2] => 42 [3] => 49 [4] => 50 [5] => 51 )

Источник

imap_search

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 » RFC1176, section «tag SEARCH search_criteria»).

Parameters

• ALL — return all messages matching the rest of the criteria
• ANSWERED — match messages with the \\ANSWERED flag set
• BCC «string» — match messages with «string» in the Bcc: field
• BEFORE «date» — match messages with Date: before «date»
• BODY «string» — match messages with «string» in the body of the message
• CC «string» — match messages with «string» in the Cc: field
• DELETED — match deleted messages
• FLAGGED — match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set
• FROM «string» — match messages with «string» in the From: field
• KEYWORD «string» — match messages with «string» as a keyword
• NEW — match new messages
• OLD — match old messages
• ON «date» — match messages with Date: matching «date»
• RECENT — match messages with the \\RECENT flag set
• SEEN — match messages that have been read (the \\SEEN flag is set)
• SINCE «date» — match messages with Date: after «date»
• SUBJECT «string» — match messages with «string» in the Subject:
• TEXT «string» — match messages with text «string»
• TO «string» — match messages with «string» in the To:
• UNANSWERED — match messages that have not been answered
• UNDELETED — match messages that are not deleted
• UNFLAGGED — match messages that are not flagged
• UNKEYWORD «string» — match messages that do not have the keyword «string»
• UNSEEN — match messages which have not been read yet

Valid values for flags are SE_UID , which causes the returned array to contain UIDs instead of messages sequence numbers.

MIME character set to use when searching strings.

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.

Changelog

Version	Description
8.1.0	The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

Examples

Example #1 imap_search() example

$some = imap_search ( $imap , ‘SUBJECT «HOWTO be Awesome» SINCE «8 August 2008″‘ , SE_UID );
$msgnos = imap_search ( $imap , ‘ALL’ );
$uids = imap_search ( $imap , ‘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

User Contributed Notes 18 notes

The date format for e.g. SINCE is, according to rfc3501:

date = date-text / DQUOTE date-text DQUOTE

date-day = 1*2DIGIT
; Day of month

date-day-fixed = (SP DIGIT) / 2DIGIT
; Fixed-format version of date-day

date-month = «Jan» / «Feb» / «Mar» / «Apr» / «May» / «Jun» /
«Jul» / «Aug» / «Sep» / «Oct» / «Nov» / «Dec»

date-text = date-day «-» date-month «-» date-year

So a valid date is e.g. «22-Jul-2012» with or without the double quotes.

Hi,
be aware, that imap_search() does NOT (as you may exspect) return an empty array, if nothing was found!
As the manual says, it returns FALSE.

Do not test the result like «count($array)» as I did.
This gives you 1 for an empty result. Took me an hour to found out why 🙁 RTFM

imap_search function is not fully compatible with IMAP4. the c-client used as of now supports only IMAP2 and some search criterion will not be available for use such as «OR»

So a php code similar to:
$inbox = imap_open(‘INBOX’, ‘foo@example.com’, ‘pass123’, OP_READONLY);
$search_string = ‘SUBJECT «FedEx» OR SUBJECT «USPS»‘;
$emails = imap_search($inbox, $search_string);

will throw an error saying «Unknown search criterion»

observations and reference:

PHP source trace:(ref: https://github.com/php/php-src/blob/master/ext/imap/php_imap.c)
/ext/imap/php_imap.c -> line no : 4126
imap_search => line no : 4148

c-client library source trace:
src/c-client/mail.c -> line no : 3973

internal.txt -> line no : 1919 => mail_criteria()
criteria IMAP2-format search criteria string
WARNING: This function does not accept IMAP4 search criteria.

Note:
The core search functionality in a core module(IMAP) is still not available in PHP. Hope this will be brought to the developer community’s attention.

To set your own CHARSET, which is useful if you are dealing with Chinese Japanese and Korean queries.

It has been noted that imap_search breaks with imap4 syntax. To do an imap 4 search use curl and send a custom command, then grab the results. Its best to do a UID search to get the unique IDs to work with later. Here’s an example with a working curl function.

$host = ‘your-server.tld’ ;
$user = ‘username’ ;
$pass = ‘password’ ;
$folder = ‘INBOX’ ;

function send_imap_command ( $server , $user , $pass , $command , $folder = «INBOX» )
< //Send an imap command directly to the imap server

$result =[ «response» => «» , «error» => «» ];
$url = «imaps:// $server /» . rawurlencode ( $folder );
$options =[ CURLOPT_URL => $url , CURLOPT_PORT => 993 , CURLOPT_USERNAME => $user ,
CURLOPT_PASSWORD => $pass , CURLOPT_RETURNTRANSFER => true , CURLOPT_HEADER => true ,
CURLOPT_CUSTOMREQUEST => $command ];
$ch = curl_init ();
curl_setopt_array ( $ch , $options );

$result [ «response» ] = curl_exec ( $ch );
if( curl_errno ( $ch )) $response [ «error» ]= «Error (» . curl_errno ( $ch ) . «): » . curl_error ( $ch );

//Pull out all the emails returned as undeliverable by the remote mail server in the inbox using curl
$response = send_imap_command ( $host , $user , $pass ,
‘UID SEARCH SINCE «01-Jan-2022» (OR FROM «mailer-daemon» FROM «postmaster») (OR SUBJECT «fail» (OR SUBJECT «undeliver» SUBJECT «returned»))’ ,
$folder );

if( $response [ «error» ]!= «» )
echo $response [ «error» ]. «\n» ;
> elseif ( strlen ( $response [ «response» ])> 5 ) //Server returns a string in the form * SEARCH uid1 uid2 uid3 . Clean up and create array of UIDs.
$response [ «response» ]= str_replace ( «* SEARCH » , «» , $response [ «response» ]);
$messages = explode ( » » , $response [ «response» ]);
>

Please be aware about UID of the message.
It is NOT an ID that never change!

If you move your message to another folder in your IMAP account, this UID WILL CHANGE.

So if your message has UID = 100 (in INBOX folder) and you move it to some subfolder and then back to INBOX, it’s new UID in INBOX will be 101.

This is the correct way to use the imap_search with ON «date»

$emails = imap_search($inbox,’ON «‘.$date.'»‘ );

Источник

imap_search

Эта функция производит поиск в текущем почтовом ящике открытом в потоке IMAP .

К примеру, чтобы найти все неотвеченные сообщения посланные от мамы (Mom), нужно будет использовать «UNANSWERED FROM mom». Поиск регистронезависимый. Приведенный список критериев извлечен из исходных кодов UW c-client и может быть неполным или не совсем точным (дополнительно смотрите » RFC1176, секция «tag SEARCH search_criteria»).

Список параметров

• ALL — возвращать все сообщения, соответствующие остальным критериям
• ANSWERED — сообщения с выставленным флагом \\ANSWERED
• BCC «string» — сообщения в поле Bcc: которых присутствует «string»
• BEFORE «date» — сообщения с Date: до «date»
• BODY «string» — сообщения содержащие «string» в теле
• CC «string» — сообщения в поле Cc: которых присутствует «string»
• DELETED — удаленные сообщения
• FLAGGED — сообщения с установленным флагом \\FLAGGED (иногда называют «Срочное» или «Важное»)
• FROM «string» — сообщения в поле From: которых присутствует «string»
• KEYWORD «string» — сообщения с ключевым словом «string»
• NEW — новые сообщения
• OLD — старые сообщения
• ON «date» — сообщения с Date: равным «date»
• RECENT — означает сообщения с выставленным флагом \\RECENT
• SEEN — прочтенные сообщения (установлен флаг \\SEEN)
• SINCE «date» — сообщения с Date: после «date»
• SUBJECT «string» — сообщения в поле Subject: которых присутствует «string»
• TEXT «string» — сообщения с текстом «string»
• TO «string» — сообщения в поле To: которых присутствует «string»
• UNANSWERED — неотвеченные сообщения
• UNDELETED — не удаленные сообщения
• UNFLAGGED — сообщения без установленных флагов
• UNKEYWORD «string» — сообщения, не имеющие ключевого слова «string»
• UNSEEN — непрочтенные сообщения

Корректные значения options — это SE_UID , что приведет к тому, что в возвращенном массиве вместо номеров сообщений будут содержаться их UID.

Кодировка MIME, в которой будет происходить поиск.

Возвращаемые значения

Возвращает номера сообщений или их UID.

Возвращает false , если сообщения не найдены, либо критерии указанные в criteria некорректны.

Примеры

Пример #1 Пример использования imap_search()

$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 );
?>

Результатом выполнения данного примера будет что-то подобное:

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 )

Смотрите также

Источник