当前位置: 首页>>代码示例 >>用法及示例精选 >>正文

PHP imap_renamemailbox()用法及代码示例



PHP-IMAP 函数可帮助您访问电子邮件帐户，IMAP 代表I互联网M艾尔A访问权限Protocol 使用这些函数您还可以使用 NNTP、POP3 协议和本地邮箱访问方法。

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

用法

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

参数

Sr.No 参数及说明
1

imap_stream (Mandatory)

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

old_mail (Mandatory)

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

new_mail(Mandatory)

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

返回值

此函数返回一个布尔值，成功时为 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 - imap_renamemailbox() Function。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。