List(String,String,Boolean) メソッド

IMAPサーバーで見つかったメールボックスのサブセットのリストを返します。

シンタックス

Visual Basic (宣言)
C#

Public Overloads Function List( _
   ByVal directory As String, _
   ByVal searchTerm As String, _
   ByVal subscribedOnly As Boolean _
) As Mailbox()

public Mailbox[] List( 
   string directory,
   string searchTerm,
   bool subscribedOnly
)

パラメータ

directory: コマンドを実行するディレクトリー。
searchTerm: すべてのメールボックスに対して一致を検索します。ワイルドカードを含めることもできます。
subscribedOnly: trueの場合は、ユーザーが購読しているMailboxだけが結果リストに含まれます（IMAP LSUBコマンドを使用）。falseの場合は、購読しているかどうかを問わず、条件に一致するすべてのメールボックスを返します。

戻り値の型

Mailboxの配列。

解説

このメソッドはMailboxesを更新しません。このコレクションの内容を更新するには、Imap.Mailboxes.Refresh()を使用します。

Imap.Session.AutoUtf8が trueに設定され、サーバーが「UTF8=ACCEPT」を返す場合、UNICODE文字列のエンコードとデコードにUTF8が使用されます。

使用例

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

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

参照

Imap クラス
 Imap メンバ
 オーバーロード一覧