クラス AbstractMailReceiver

メソッドの詳細

• setSelectorExpression

  public void setSelectorExpression(Expression selectorExpression)

• setProtocol

  public void setProtocol(StringSE protocol)

• setSession

  public void setSession(SessionEE session)

  SessionEE を設定します。それ以外の場合、セッションは Session.getInstance(Properties)EE または Session.getInstance(Properties, Authenticator)EE の呼び出しによって作成されます。

  パラメーター:

  session - セッション。

  関連事項:

  • setJavaMailProperties(Properties)
  • setJavaMailAuthenticator(Authenticator)

• setJavaMailProperties

  public void setJavaMailProperties(PropertiesSE javaMailProperties)

  これらのプロパティ（および JavaMailAuthenticator が提供されている場合）を使用して、新しい SessionEE が作成されます。このメソッドまたは setSession(jakarta.mail.Session) のいずれかを使用しますが、両方は使用しません。

  パラメーター:

  javaMailProperties - javamail プロパティ。

  関連事項:

  • setJavaMailAuthenticator(Authenticator)
  • setSession(Session)

• getJavaMailProperties

  protected PropertiesSE getJavaMailProperties()

• setJavaMailAuthenticator

  public void setJavaMailAuthenticator(AuthenticatorEE javaMailAuthenticator)

  オプションで、セッションの取得に使用する認証システムを設定します。setSession(jakarta.mail.Session) を使用して SessionEE を直接構成している場合、これは使用されません。

  パラメーター:

  javaMailAuthenticator - javamail 認証システム。

  関連事項:

  • setSession(Session)

• setMaxFetchSize

  public void setMaxFetchSize(int maxFetchSize)

  receive() の呼び出しごとにフェッチするメッセージの最大数を指定します。

  パラメーター:

  maxFetchSize - 最大フェッチサイズ。

• setShouldDeleteMessages

  public void setShouldDeleteMessages(boolean shouldDeleteMessages)

  メールメッセージを取得後に削除するかどうかを指定します。

  パラメーター:

  shouldDeleteMessages - メッセージを削除する場合は true。

• shouldDeleteMessages

  protected boolean shouldDeleteMessages()

  メールメッセージを受信後に削除するかどうかを示します。

  戻り値:

  メッセージが削除される場合は true。

• getUserFlag

  protected StringSE getUserFlag()

• setUserFlag

  public void setUserFlag(StringSE userFlag)

  サーバーが \ Recent をサポートしないがユーザーフラグをサポートする場合にメッセージにフラグを付けるために使用するフラグの名前を設定します。デフォルト "spring-integration-mail-adapter"

  パラメーター:

  userFlag - フラグ。

  導入:

  4.2.2

• setHeaderMapper

  public void setHeaderMapper(HeaderMapper<MimeMessageEE> headerMapper)

  ヘッダーマッパーを設定します。ヘッダーマッパーが提供されない場合、メッセージペイロードは MimeMessageEE になり、提供されるとヘッダーがマッピングされ、ペイロードが MimeMessageEE コンテンツになります。

  パラメーター:

  headerMapper - ヘッダーマッパー。

  導入:

  4.3

  関連事項:

  • setEmbeddedPartsAsBytes(boolean)

• setEmbeddedPartsAsBytes

  public void setEmbeddedPartsAsBytes(boolean embeddedPartsAsBytes)

  ヘッダーマッパーが提供されている場合、埋め込み PartEE（たとえば、MessageEE または MultipartEE コンテンツがペイロードで byte[] としてレンダリングされるかどうかを決定します。そうでない場合は、PartEE のままにします。

  ヘッダーマッパーがない場合、これは効果がありません。その場合、ペイロードは MimeMessageEE です。

  パラメーター:

  embeddedPartsAsBytes - 設定する embeddedPartsAsBytes。

  導入:

  4.3

  関連事項:

  • setHeaderMapper(HeaderMapper)

• setSimpleContent

  public void setSimpleContent(boolean simpleContent)

  MimeMessage.getContent() はメール本文のみを返します。

   foo
   

  IMAPMessage などの一部のサブクラスは、本文とともにヘッダーを返します。

   To: foo@bar
   From: bar@baz
   Subject: Test Email
  
    foo
   

  バージョン 5.0 から、メール受信者が発行するメッセージは、javamail が返す MimeMessageEE 実装と同じ方法でコンテンツをレンダリングします。バージョン 2.2 から 4.3 では、コンテンツは、基になるメッセージ型に関係なく、常に本文のみでした（ヘッダーマッパーが提供されていない限り、ペイロードは基になる MimeMessageEE によってレンダリングされました）。

  前の動作に戻すには、このフラグを true に設定します。さらに、ヘッダーマッパーが提供されている場合でも、ペイロードはメールの本文になります。

  パラメーター:

  simpleContent - 単純なコンテンツをレンダリングする場合は true。

  導入:

  5.0

• setAutoCloseFolder

  public void setAutoCloseFolder(boolean autoCloseFolder)

  boolean フラグを設定して、取得後にフォルダーを自動的に閉じる（デフォルト）か、代わりに追加の IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE メッセージヘッダーを入力します。このヘッダーを取得し、必要に応じて close() を呼び出すのは、ダウンストリームフローの責任です。

  添付ファイル付きのメールのマルチパートコンテンツを解析するときにサーバーとの通信が必要な場合は、フォルダーを開いたままにしておくと便利です。

  setSimpleContent(boolean) および setHeaderMapper(HeaderMapper) オプションは、このフラグの影響を受けません。

  パラメーター:

  autoCloseFolder - false は、フェッチ後にフォルダーを自動的に閉じません。

  導入:

  5.2

• getFolder

  protected FolderEE getFolder()

• getFolderOpenMode

  protected int getFolderOpenMode()

• searchForNewMessages

  protected abstract MessageEE[] searchForNewMessages() throws MessagingExceptionEE

  サブクラスは、このメソッドを実装して新しいメールメッセージを返す必要があります。

  戻り値:

  メッセージの配列。

  例外:

  MessagingExceptionEE - MessagingException。

• openFolder

  protected void openFolder() throws MessagingExceptionEE

  例外:

  MessagingExceptionEE

• receive

  public ObjectSE[] receive() throws MessagingExceptionEE

  次で指定:

  インターフェース MailReceiver の receive 

  例外:

  MessagingExceptionEE

• closeFolder

  protected void closeFolder()

• fetchMessages

  protected void fetchMessages(MessageEE[] messages) throws MessagingExceptionEE

  この受信者のフォルダーから指定されたメッセージを取得します。FetchProfile.ItemEE ごとのデフォルト実装 fetchesEE

  パラメーター:

  messages - 取得するメッセージ

  例外:

  MessagingExceptionEE - JavaMail エラーの場合

• deleteMessages

  protected void deleteMessages(MessageEE[] messages) throws MessagingExceptionEE

  この受信者のフォルダーから指定されたメッセージを削除します。

  パラメーター:

  messages - 削除するメッセージ

  例外:

  MessagingExceptionEE - JavaMail エラーの場合

• setAdditionalFlags

  protected void setAdditionalFlags(MessageEE message) throws MessagingExceptionEE

  追加のフラグを設定できるオプションのメソッド。現在、IMapMailReceiver でのみ実装されています。

  パラメーター:

  message - メッセージ。

  例外:

  MessagingExceptionEE - MessagingException。

• destroy

  public void destroy()

  次で指定:

  インターフェース DisposableBean の destroy 

• onInit

  protected void onInit()

  クラスからコピーされた説明: IntegrationObjectSupport

  サブクラスは、初期化ロジック用にこれを実装できます。

  オーバーライド:

  クラス IntegrationObjectSupport の onInit 

• toString

  public StringSE toString()

  オーバーライド:

  クラス IntegrationObjectSupport の toString