-開発版

--[[anonsvn]]よりチェックアウトできます

-0.2x

--${smdncms:distfilelink,TundereBird-0.23.tar.bz2}

---下記ライブラリのソースを同梱しています

----[[works/libs/Smdn.Net.Imap4]] 0.23

不具合の報告、ライブラリに対する要望や提案、使い方の質問などは[[掲示板>misc/forum/libs]]へどうぞ。

*変更履歴

**0.23

-機能追加

--IMAP

${smdncms:title,ドキュメント・サンプル}

${smdncms:keywords,}

*使用例

個々のサンプルの詳細については、後述するSmdn.Net.Imap4.WebClients名前空間の説明を参照してください。

    using {

      client.Credentials = new NetworkCredential("user", "pass");

    }

  }

}

    ImapSessionManager.RegisterWebRequestPrefix();

    ImapSessionManager.CertificateValidationCallback = delegate { return true; };

    request.Credentials = new NetworkCredential("user", "pass");

|*リクエストURLの形式とリクエストの対象

|リクエストURLの形式|リクエストの対象|h

|imap://imap.example.net/|URLで指定されたサーバ・アカウント|

|imap://imap.example.net/mailbox/;UID=1|URLで指定されたメールボックスにあるメッセージのうち、UIDに該当する特定のメッセージ|

WebRequest.Createメソッドが返すWebRequestインスタンスのMethodプロパティにデフォルトで設定される値は、リクエストURLの形式によって決まります。

|Methodプロパティ|リクエスト|解説|レスポンス|f

***メールボックスに対するリクエスト

|Methodプロパティ|リクエスト|解説|レスポンス|h

|ImapWebRequestMethods.Fetch, "FETCH"&br;(デフォルト)|FETCHコマンドを送信してメールボックスにあるメッセージの一覧を取得します。|取得するのはメッセージの属性のみ(ALLマクロで取得されるフラグ、サイズ、internal date、エンベロープ)です。　メッセージ本文は取得しません。|取得したメッセージの一覧は、ImapWebResponse.Messagesプロパティに設定されます。|

|ImapWebRequestMethods.Append, "APPEND"|APPENDコマンドを送信してメールボックスにメッセージをアップロードします。|アップロードするメッセージはWebRequest.GetRequestStreamメソッドが返すStreamに書き込みます。　現在の実装では、リクエスト開始時にContentLengthの値が指定されているか、GetRequestStreamメソッドが返すStreamを閉じるまでアップロードは保留されます。　メッセージはMIME形式であるべきですが、ライブラリ側ではアップロードする内容をチェックしません。|サーバがアップロードしたメッセージのUIDを返す場合は、アップロードしたメッセージのURLがWebResponse.ResponseUriに設定されます。|

|ImapWebRequestMethods.Expunge, "EXPUNGE"|EXPUNGEコマンドを送信してメールボックスから\Deletedフラグの付いたメッセージを削除します。|-|-|

|ImapWebRequestMethods.Check, "CHECK"|CHECKコマンドを送信します。|このコマンドは何もしません。　CHECKコマンドの動作、レスポンスの内容はサーバの実装によります。|-|

|ImapWebRequestMethods.Select, "SELECT"|SELECTコマンドを送信してメールボックスを選択します。|このコマンドは選択するだけで何もしません。　メールボックスの状態を取得する場合などに使います。|選択したメールボックスは、ImapWebResponse.Mailboxesプロパティに設定されます。　また、選択したメールボックスのURLがWebResponse.ResponseUriに設定されます。|

|ImapWebRequestMethods.Examine, "EXAMINE"|EXAMINEコマンドを送信して読み取り専用でメールボックスを選択します。|このコマンドは選択するだけで何もしません。　メールボックスの状態を取得する場合などに使います。|選択したメールボックスは、ImapWebResponse.Mailboxesプロパティに設定されます。　また、選択したメールボックスのURLがWebResponse.ResponseUriに設定されます。|

|ImapWebRequestMethods.Subscribe, "SUBSCRIBE"|SUBSCRIBEコマンドを送信してメールボックスの購読を開始します。|-|-|

|ImapWebRequestMethods.Unsubscribe, "UNSUBSCRIBE"|UNSUBSCRIBEコマンドを送信してメールボックスの購読を解除します。|-|-|

|Methodプロパティ|リクエスト|解説|レスポンス|f

***メールボックスに対する検索クエリを含むリクエスト

|Methodプロパティ|リクエスト|解説|レスポンス|h

|ImapWebRequestMethods.Search, "SEARCH"&br;(デフォルト)|SEARCHコマンドを送信して検索クエリに該当するメッセージの一覧を取得します。|取得するのはメッセージの属性のみ(ALLマクロで取得されるフラグ、サイズ、internal date、エンベロープ)です。　メッセージ本文は取得しません。|取得したメッセージの一覧は、ImapWebResponse.Messagesプロパティに設定されます。|

|ImapWebRequestMethods.Expunge, "EXPUNGE"|STOREコマンドを送信して検索クエリに該当するメッセージに\Deletedフラグを追加した後、EXPUNGEコマンドを送信してメッセージを削除します。|サーバが&urn2url(urn:ietf:rfc:4315,#2.1){UID EXPUNGE};に対応していない場合、検索クエリに該当したメッセージだけでなく''既に\Deletedフラグが設定されている他のメッセージも同時に削除されます''。|-|

|ImapWebRequestMethods.Store, "STORE"|STOREコマンドを送信して検索クエリに該当するメッセージにフラグを追加・削除・設定します。|追加・削除・設定するフラグはImapWebRequest.StoreDataItemプロパティで指定します。|-|

|Methodプロパティ|リクエスト|解説|レスポンス|f

***メールボックス内の特定のメッセージに対するリクエスト

|Methodプロパティ|リクエスト|解説|レスポンス|h

|ImapWebRequestMethods.Fetch, "FETCH"&br;(デフォルト)|FETCHコマンドを送信してメッセージの本文を取得します。|該当するUIDのメッセージがない場合、WebExceptionStatus.SuccessのWebExceptionをスローします。|メッセージ本文はWebResponse.GetResponseStreamメソッドが返すStreamから読み込めます。　取得するメッセージのサイズはWebResponse.ContentLength、Content-TypeはWebResponse.ContentTypeプロパティに設定されます。|

|ImapWebRequestMethods.Expunge, "EXPUNGE"|STOREコマンドを送信して\Deletedフラグを追加した後、EXPUNGEコマンドを送信してメッセージを削除します。|サーバが&urn2url(urn:ietf:rfc:4315,#2.1){UID EXPUNGE};に対応していない場合、URLで指定されたメッセージだけでなく''既に\Deletedフラグが設定されている他のメッセージも同時に削除されます''。|-|

|ImapWebRequestMethods.Store, "STORE"|STOREコマンドを送信してメッセージにフラグを追加・削除・設定します。|追加・削除・設定するフラグはImapWebRequest.StoreDataItemプロパティで指定します。|-|

|Methodプロパティ|リクエスト|解説|レスポンス|f

|ReadOnly|false|FETCH, SEARCH等|メールボックスを選択する際に、SELECTコマンドの代わりにEXAMINEコマンドを送信するかどうかを指定します。　メッセージに対する操作を行うコマンドを送信する場合に有効になります。　EXAMINEコマンドで選択したメールボックスのメッセージに対する操作の結果はサーバの実装によります。　ReadOnlyがtrueでもDELETEなどのコマンドには影響しません。|

|AllowCreateMailbox|true|COPY|COPYコマンドを送信した際にサーバがレスポンスコードTRYCREATEを返した場合、自動的にメールボックスを作成するかどうかを指定します。　現在の実装では、APPENDコマンドでTRYCREATEが返された場合でもメールボックスは作成せず、常にエラーとなります。|

|DestinationUri|null|COPY, RENAME|COPYの場合はメッセージのコピー先メールボックス名、RENAMEの場合は変更後のメールボックス名を含むURLを指定します。　URLはコピー元・変更前(WebRequest.RequestUri)と同一サーバ、同一ユーザである必要があります。　それ以外の場合、ArgumentExceptionをスローします。|

|StoreDataItem|null|STORE|STOREコマンドでメッセージに追加・削除・設定するフラグを指定します。|

|FetchBlockSize|10240|FETCH|FETCHコマンドでメッセージ本文を取得する際に、1回のFETCHコマンドで取得するブロックのサイズをバイト単位で指定します。|

WebRequestクラスから継承されるプロパティのうち、以下のプロパティは使用することができます。

|プロパティ|デフォルト|対象となるコマンド|リクエスト内容と動作|h

|UseDeflateIfAvailable|false|全て|サーバがサポートしている場合、DEFLATE圧縮アルゴリズムを使用した接続に変更します。　(この機能は現在動作しません。　trueにした場合、NotImplementedExceptionがスローされます)|

|AllowLoginRedirect|true|全て(認証時)|認証時にサーバがレスポンスコードREFERRALを返した場合、レスポンスコードで指定されたURLで再度ログインを試みるかどうかを指定します。(この機能は未テストです。　期待する動作となるかどうかは分かりません)

***リクエストとIMAP URLに関するその他の留意事項

-UIDVALIDITYを含むIMAP URLも扱えますが、無視します。　現時点ではUIDVALIDITYが指定されていない場合と同様に扱います。

**サンプル

using Smdn.Net.Imap4.WebClients;

  :

request.Credentials = new NetworkCredential("user", "pass");

request.Method = ImapWebRequestMethods.Copy;

request.AllowCreateMailbox = true;

using {

  :

using Smdn.Net.Imap4.WebClients;

  :

request.Credentials = new NetworkCredential("user", "pass");

request.Method = ImapWebRequestMethods.Delete;

using Smdn.Net.Imap4.WebClients;

  :

request.Credentials = new NetworkCredential("user", "pass");

request.Method = ImapWebRequestMethods.Create;

}

}}

***メッセージへのフラグの設定

fromにspammer.example.comを含むメッセージをすべて既読にし、Thunderbirdの迷惑メールのマーク(Junk)を設定する例。　ImapStoreDataItem.ReplaceFlagsメソッドを使って新しく置き換える(設定する)フラグを作成し、StoreDataItemプロパティにしています。

using Smdn.Net.Imap4.WebClients;

  :

request.Credentials = new NetworkCredential("user", "pass");

request.Method = ImapWebRequestMethods.Store;

  public static void Main()

  {

    using {

        Console.WriteLine("authentication failed");

        return;

      }

    };

    using {

        Console.WriteLine("authentication failed");

        return;

      }

--[[works/libs/Smdn.Security.Authentication.Sasl]]

--[[works/libs/Smdn.Formats.Mime]]

使用可能なコマンド

:認証系コマンド|LOGIN, AUTHENTICATE, LOGOUT, STARTTLS

::SASL認証方式|DIGEST-MD5, CRAM-MD5, NTLM, PLAIN, LOGIN, ANONYMOUS

#googleadunit

0.20以降はMIT X11ライセンスでのリリースとなります。　0.20より前のバージョンについては特に使用条件を定めていません。

-開発版

--[[anonsvn]]よりチェックアウトできます

-0.2x

--${smdncms:distfilelink,Smdn.Net.Imap4.Client-0.23.tar.bz2}

--${smdncms:distfilelink,Smdn.Net.Imap4.Client-0.22.tar.bz2}

--${smdncms:distfilelink,Smdn.Net.Imap4.Client-0.21.tar.bz2}

--IDLEして5分程度経過すると、Mono.Security.Protocol.Tls.SslStreamBase.EndReadでMono.Security.Protocol.Tls.TlsExceptionがスローされる

*変更履歴

**0.23

主に未サポートだった拡張の実装、メールボックス操作系コマンドの実装不備の修正。

-.NET Framework 3.5

-Mono 2.7

-MIMEメッセージのデコード機能は含んでいません。　デコード機能が必要な場合は他のライブラリか、[[works/libs/Smdn.Formats.Mime]]を使ってください。

*参考文献

#amazon(4873110289,left,content)

|CLOSE|&urn2url(urn:ietf:rfc:3501,#6.4.2,short);|&color(green){implemented};||

|EXPUNGE|&urn2url(urn:ietf:rfc:3501,#6.4.3,short);|&color(green){implemented};||

|SEARCH, UID SEARCH|&urn2url(urn:ietf:rfc:3501,#6.4.4,short); &urn2url(urn:ietf:rfc:3501,#6.4.11,short); &urn2url(urn:ietf:rfc:4466,#2.6,short);|&color(green){implemented};|非ASCII文字での検索に対応&sub{*2};|

|STORE, UID STORE|&urn2url(urn:ietf:rfc:3501,#6.4.6,short); &urn2url(urn:ietf:rfc:3501,#6.4.11,short); &urn2url(urn:ietf:rfc:4466,#2.5,short);|&color(green){implemented};||

|COPY, UID COPY|&urn2url(urn:ietf:rfc:3501,#6.4.7,short); &urn2url(urn:ietf:rfc:3501,#6.4.11,short);|&color(green){implemented};|Modified UTF-7対応&sub{*1};|

|~Extensions|-|-|-|

:Modified UTF-7対応&sub{*1};|メールボックス名に非ASCII文字を含む場合、自動的にModified UTF-7に変換します。

:非ASCII文字での検索に対応&sub{*2};|文字コードには任意のSystem.Text.Encodingを指定できます。　明示的に指定しない場合はUTF-8を使用します。

**response codes

サポートするレスポンスコードの一覧です。

${smdncms:title,ドキュメント・サンプル}

${smdncms:keywords,}

*使用例

個々のサンプルの詳細については、後述するSmdn.Net.Pop3.WebClients名前空間の説明を参照してください。

|KeepAlive|true|全て|リクエストが終了した後もセッションを維持するかどうかを指定します。　trueの場合はリクエストが終了してもセッションは維持し、falseの場合はリクエストの度にセッションを開きリクエスト終了と同時にセッションを閉じます|

|UseTlsIfAvailable|true|全て(認証時)|サーバがサポートしている場合、認証を行う前にTLSを使用した接続にアップグレードします。|

|UsingSaslMechanisms|{"DIGEST-MD5", "CRAM-MD5", "NTLM"}|全て(認証時)|認証メカニズムが指定されていない場合に、試行する認証メカニズムとその順番を配列で指定します。　サーバ・クライアントの両方がサポートするメカニズム以外が指定されている場合は無視します。|

|ExpectedErrorResponseCodes|null|全て|サーバから返されることが予期されるエラーレスポンスコードの配列を指定します。　サーバからこれらのレスポンスコードが返された場合は、エラーレスポンスでもWebExceptionがスローされません。|

WebRequestクラスから継承されるプロパティのうち、以下のプロパティは使用することができます。

--[[works/libs/Smdn.Formats.Mime]]

*機能

:認証系コマンド|USER, PASS, QUIT, APOP, AUTH(&urn2url(urn:ietf:rfc:5034,short);)

::SASL認証方式|DIGEST-MD5, CRAM-MD5, NTLM, PLAIN, LOGIN, ANONYMOUS

SASLの実装は[[works/libs/Smdn.Security.Authentication.Sasl]]に含まれています

#googleadunit

0.20以降はMIT X11ライセンスでのリリースとなります。　0.20より前のバージョンについては特に使用条件を定めていません。

-開発版

--[[anonsvn]]よりチェックアウトできます

-0.2x

--${smdncms:distfilelink,Smdn.Net.Pop3.Client-0.23.tar.bz2}

--${smdncms:distfilelink,Smdn.Net.Pop3.Client-0.22.tar.bz2}

-0.1x

--[[POP3 Extension Mechanism:http://www.iana.org/assignments/pop3-extension-mechanism]]

*変更履歴

**0.23

-機能追加

--&urn2url(urn:ietf:rfc:2449,#8){Extended POP3 Response Codes};に対応

-.NET Framework 3.5

-Mono 2.7

-MIMEメッセージのデコード機能は含んでいません。　デコード機能が必要な場合は他のライブラリか、[[works/libs/Smdn.Formats.Mime]]を使ってください。

*参考文献

#amazon(4873110289,left,content)

|&urn2url(urn:ietf:rfc:4422,anchor-text);|EXTERNAL|&color(gray){not implemented};||

|&urn2url(urn:ietf:rfc:4505,anchor-text);|ANONYMOUS|&color(green){implemented};||

|&urn2url(urn:ietf:rfc:4752,anchor-text);|GSSAPI|&color(gray){not implemented};||

|&urn2url(urn:ietf:id:ietf-sasl-scram-10,anchor-text);|SCRAM-*|&color(gray){not implemented};||

|&urn2url(urn:ietf:id:ietf-sasl-scram-10,anchor-text);|SCRAM-SHA-1|&color(gray){not implemented};||

|&urn2url(urn:ietf:id:ietf-sasl-scram-10,anchor-text);|SCRAM-SHA-1-PLUS|&color(gray){not implemented};||

-開発版

--[[anonsvn]]よりチェックアウトできます

-0.2x

--${smdncms:distfilelink,Smdn.Security.Authentication.Sasl-0.23.tar.bz2}

--${smdncms:distfilelink,Smdn.Security.Authentication.Sasl-0.22.tar.bz2}

不具合の報告、ライブラリに対する要望や提案、使い方の質問などは[[掲示板>misc/forum/libs]]へどうぞ。

*変更履歴

**0.23

-initial client responseを取得するメソッドを追加

**0.21

-[[works/libs/Smdn.Net.Imap4]]より分離

*関連するページ

-[[programming/mono/Mono.Security.Protocol.Ntlm]]

-[[programming/tips/cram_md5]]