PHP - imap_rename() 函数

上一个
下一个

PHP−IMAP 函数帮助您访问电子邮件帐户，IMAP 代表 **I**nternet **M**ail **A**ccess **P**rotocol，使用这些函数您还可以使用 NNTP、POP3 协议和本地邮箱访问方法。

imap_rename() 函数是 imap_renamemailbox() 的别名。它接受一个表示 IMAP 流的资源值，两个表示邮箱旧名称和新名称的字符串值作为参数，并重命名给定的邮箱。

语法

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

参数

序号 参数及描述
1

imap_stream (必填)

这是一个表示 IMAP 流的字符串值，是 imap_open() 函数的返回值。
2

old_mail (必填)

这是一个表示邮箱旧名称的字符串值。
3

new_mail(必填)

这是一个表示邮箱新名称的字符串值。

返回值

此函数返回一个布尔值，成功时为 TRUE，失败时为 FALSE。

PHP 版本

此函数首次引入 PHP 4 版本，并在所有后续版本中可用。

示例

以下示例演示了 imap_rename() 函数的使用 −

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $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_mail2";
         $new_name = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.changed_mail2";

         $res = imap_rename($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 = "[email protected]";
         $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_create($mailbox, imap_utf7_encode($newmailbox1));
         $res = imap_create($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_rename($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
打印页面
上一个
下一个
广告