パッケージ jakarta.mail.event

クラス MessageCountEvent

java.lang.ObjectSE
java.util.EventObjectSE
jakarta.mail.event.MailEvent
jakarta.mail.event.MessageCountEvent
実装されているすべてのインターフェース:
SerializableSE
public class MessageCountEvent extends MailEvent
このクラスは、フォルダー内のメッセージ数の変化を通知します。

一部のフォルダー型は、特定の時間または特定の操作後にのみ MessageCountEvents を配信する場合があることに注意してください。特に IMAP は、クライアントが新しいコマンドを発行したときにのみ MessageCountEvents をクライアントに通知します。詳細については、RFC 3501 を参照してください。クライアントは、getMessageCount または isOpen メソッドをときどき呼び出してそのような通知を要求することにより、フォルダーを「ポーリング」したい場合があります。

作成者:
John Mani
関連事項:

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final int
    ADDED
    メッセージはフォルダーに追加されました
    protected Message[]
    msgs
    メッセージ。
    protected boolean
    removed
    true の場合、このイベントはこのクライアントによる明示的な消去の結果であり、このフォルダー内のメッセージはこれを説明するために番号が付け直されています。
    static final int
    REMOVED
    メッセージはフォルダーから削除されました
    protected int
    type
    イベント型。

    クラス java.util.EventObjectSE から継承されたフィールド

    sourceSE

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)
    コンストラクター。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    dispatch(ObjectSE listener)
    適切な MessageCountListener メソッドを呼び出します。
    Message[]
    getMessages()
    追加または削除されたメッセージの配列を返します。
    int
    getType()
    このイベントの型を返します。
    boolean
    isRemoved()
    このイベントがこのクライアントによる明示的な消去の結果であるか、外部ソースからの消去によるものであるかを示します。

    クラス java.util.EventObjectSE から継承されたメソッド

    getSource, toString

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

  • フィールドの詳細

    • ADDED

      public static final int ADDED
      メッセージはフォルダーに追加されました
      関連事項:

    • REMOVED

      public static final int REMOVED
      メッセージはフォルダーから削除されました
      関連事項:

    • type

      protected int type
      イベント型。

    • removed

      protected boolean removed
      true の場合、このイベントはこのクライアントによる明示的な消去の結果であり、このフォルダー内のメッセージは、これを考慮して番号が付け直されています。false の場合、このイベントは外部ソースによる消去の結果です。

    • msgs

      protected transient Message[] msgs
      メッセージ。

  • コンストラクターの詳細

    • MessageCountEvent

      public MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)
      コンストラクター。
      パラメーター:
      folder - 含まれているフォルダー
      type - イベント型
      removed - true の場合、このイベントはこのクライアントによる明示的な消去の結果であり、このフォルダー内のメッセージは、これを考慮して番号が付け直されています。false の場合、このイベントは外部ソースによる消去の結果です。
      msgs - 追加 / 削除されたメッセージ

  • メソッドの詳細

    • getType

      public int getType()
      このイベントの型を返します。
      戻り値:
      型

    • isRemoved

      public boolean isRemoved()
      このイベントがこのクライアントによる明示的な消去の結果であるか、外部ソースからの消去によるものであるかを示します。true の場合、このイベントは明示的な消去が原因であるため、このフォルダーに残っているすべてのメッセージの番号が付け直されています。false の場合、このイベントは外部消去が原因です。

      このメソッドは、このイベントの型が REMOVED の場合にのみ有効であることに注意してください。

      戻り値:
      メッセージが削除された場合は true

    • getMessages

      public Message[] getMessages()
      追加または削除されたメッセージの配列を返します。
      戻り値:
      メッセージの配列

    • dispatch

      public void dispatch(ObjectSE listener)
      適切な MessageCountListener メソッドを呼び出します。
      次で指定:
      クラス MailEvent の dispatch 
      パラメーター:
      listener - 呼び出すリスナー