PHP - imap_renamemailbox() 函式

PHP 的 IMAP 函式 giúp bạn truy cập vào các tài khoản email. IMAP là viết tắt của **I**nternet **M**ail **A**ccess **P**rotocol. Sử dụng các hàm này, bạn cũng có thể làm việc với các giao thức NNTP, POP3 và các phương pháp truy cập hộp thư địa phương.

函式 **imap_renamemailbox()** 接受一個表示 IMAP 流的資源值、兩個表示郵箱舊名稱和新名稱的字串值作為引數，並重命名給定的郵箱。

語法

imap_renamemailbox($imap_stream, $old_mail , $new_mail);

引數

序號	引數及說明
1	imap_stream (必填) 這是一個字串值，表示 IMAP 流，是 imap_open() 函式的返回值。
2	old_mail (必填) 這是一個字串值，表示郵箱的舊名稱。
3	new_mail (必填) 這是一個字串值，表示郵箱的新名稱。

序號

引數及說明

imap_stream (必填)

這是一個字串值，表示 IMAP 流，是 **imap_open()** 函式的返回值。

old_mail (必填)

這是一個字串值，表示郵箱的舊名稱。

new_mail (必填)

這是一個字串值，表示郵箱的新名稱。

返回值

此函式返回一個布林值，成功時為 TRUE，失敗時為 FALSE。

PHP 版本

此函式首次引入於 PHP 4 版本，並在所有後續版本中均有效。

示例

以下示例演示了 **imap_renamemailbox()** 函式的使用：

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");    
		 
         //Renaming the existing mailbox
         $old_name = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1";
         $new_name = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail1";

         $res = imap_renamemailbox($mailbox, $old_name, $new_name);		 
         if($res){
            print("Name changed");
         } else {
            print("Error occurred");
         }
      ?>
   </body>
</html>

輸出

這將生成以下輸出：

Connection established....
Name changed

示例

以下是此函式的另一個示例：

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating mailboxes
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.my_mail1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.my_mail2";
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox1));
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox2));

         //Retrieving the contents of mail boxes
         print("List of mailboxes: ");
         print("<br>");
         $list = imap_getmailboxes($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val->name);
            print("<br>");
         }	 
         //Renaming the existing mailbox
         $new_name = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail";
         imap_renamemailbox($mailbox, $newmailbox2, $new_name);
         
         //Retrieving the contents of mail boxes
         print("<br>");
         print("List of mailboxes after deletion: ");
         print("<br>");
         $list = imap_getmailboxes($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val->name);
            print("<br>");
         }	 
      ?>
   </body>
</html>

輸出

這將生成以下輸出：

Connection established....
List of mailboxes:
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.my_mail1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.my_mail2

List of mailboxes after deletion:
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.my_mail1

php_function_reference.htm

列印頁面