Remove メソッド (MailboxCollection)

コレクションからメールボックスを削除します。

シンタックス

Visual Basic (宣言)
C#

Public Shadows Sub Remove( _
   ByVal value As Mailbox _
)

public new void Remove( 
   Mailbox value
)

パラメータ

value: 削除するMailboxオブジェクト。

例外

例外	解説
ProtocolException	サーバーから受信したIMAPプロトコル応答が不良です。
System.Net.Sockets.SocketException	通信エラーが発生しました。
System.InvalidOperationException	サーバー側コレクションを不正に変更しようとしました。

解説

このメソッドは、IMAP DELETEコマンドを送信することによって、指定されたメールボックスをサーバーから削除します。

コレクションの新しい状態を反映してリストが自動的に更新されます。

使用例

以下のサンプルコードは、メールボックスを作成、名前変更、および削除する方法を示します。また、メールボックスの購読を開始および停止する方法も示します。

private void doMailboxFunctions(object sender)
{
    // サーバーとアカウントの情報を設定します。
    imap1.Session.RemoteEndPoint = new Dart.Mail.IPEndPoint(myServer, Imap.GetDefaultPort(imap1.Session));
    imap1.Session.Username = myUsername;
    imap1.Session.Password = myPassword;

    // 接続してアカウントにログインします。
    imap1.Connect();
    imap1.Authenticate();

    // メールボックスを作成します。
    Mailbox newBox = imap1.Mailboxes.Add("My_New_Box");

    // メールボックスの購読を開始し、購読リストをチェックします。
    newBox.Subscribe();
    // 購読しているすべてのメールボックスを取得します。
    List<Mailbox> list = imap1.List("", "%", true).ToList<Mailbox>();
    if (!list.Contains(newBox)) throw new Exception("Server did not subscribe the mailbox.");

    // メールボックスの購読を停止し、購読リストをチェックします。
    newBox.Unsubscribe();
    list = imap1.List("", "%", true).ToList<Mailbox>();
    if (list.Contains(newBox)) throw new Exception("Server did not unsubscribe the mailbox.");

    // メールボックスの名前を変更してから、メールボックスを削除します。
    newBox.Name = newBox.Name + "_Renamed";
    imap1.Mailboxes.Remove(newBox);

    // セッションから適切にログアウトします。
    imap1.Close();
}

Visual Basic

Private Sub doMailboxFunctions(ByVal sender As Object)
    ' サーバーとアカウントの情報を設定します。
    imap1.Session.RemoteEndPoint = New Dart.Mail.IPEndPoint(myServer, Imap.GetDefaultPort(imap1.Session))
    imap1.Session.Username = myUsername
    imap1.Session.Password = myPassword

    ' 接続してアカウントにログインします。
    imap1.Connect()
    imap1.Authenticate()

    ' メールボックスを作成します。
    Dim newBox As Mailbox = imap1.Mailboxes.Add("My_New_Box")

    ' メールボックスの購読を開始し、購読リストをチェックします。
    newBox.Subscribe()
    ' 購読しているすべてのメールボックスを取得します。
    Dim list As List(Of Mailbox) = imap1.List("", "%", True).ToList()
    If Not list.Contains(newBox) Then
        Throw New Exception("Server did not subscribe the mailbox.")
    End If

    ' メールボックスの購読を停止し、購読リストをチェックします。
    newBox.Unsubscribe()
    list = imap1.List("", "%", True).ToList()
    If list.Contains(newBox) Then
        Throw New Exception("Server did not unsubscribe the mailbox.")
    End If

    ' メールボックスの名前を変更してから、メールボックスを削除します。
    newBox.Name = newBox.Name & "_Renamed"
    imap1.Mailboxes.Remove(newBox)

    ' セッションから適切にログアウトします。
    imap1.Close()
End Sub

参照

MailboxCollection クラス
 MailboxCollection メンバ