インターフェース JavaMailSender

すべてのスーパーインターフェース:
MailSender
すべての既知の実装クラス:
JavaMailSenderImpl
public interface JavaMailSender extends MailSender
JavaMail 用の拡張 MailSender インターフェース。MIME メッセージを直接引数として、または準備コールバック経由でサポートします。通常は MimeMessageHelper クラスと組み合わせて使用し、添付ファイルなどを含む JavaMail MimeMessages を簡単に作成します。

クライアントは、SimpleMailMessage を超えるメール機能が必要な場合、このインターフェースを介してメール送信者と通信する必要があります。実動実装は JavaMailSenderImpl です。テスト用に、このインターフェースに基づいてモックを作成できます。クライアントは通常、依存性注入を通じて JavaMailSender 参照を受け取ります。

このインターフェースの推奨される使用方法は MimeMessagePreparator メカニズムであり、おそらくメッセージの取り込みに MimeMessageHelper を使用します。例については、MimeMessageHelper's javadoc を参照してください。

JavaMail の Session 管理全体は JavaMailSender によって抽象化されています。クライアントコードはセッションを一切処理せず、JavaMail の設定とリソース処理全体を JavaMailSender の実装に委ねるべきです。これによりテスト容易性も向上します。

JavaMailSender クライアントは、単純な MailSender クライアントほどテストが簡単ではありませんが、従来の JavaMail コードと比較すると依然として簡単です。createMimeMessage() が Session.getInstance(new Properties()) 呼び出しで作成された単純な MimeMessage を返すようにし、さまざまな send メソッドのモック実装で渡されたメッセージを確認するだけです。

導入:
07.10.2003
作成者:
Juergen Hoeller
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    jakarta.mail.internet.MimeMessage
    createMimeMessage()
    この送信者の基になる JavaMail セッション用の新しい JavaMail MimeMessage を作成します。
    jakarta.mail.internet.MimeMessage
    createMimeMessage(InputStreamSE contentStream)
    指定された入力ストリームをメッセージソースとして使用して、この送信者の基になる JavaMail セッションの新しい JavaMail MimeMessage を作成します。
    default void
    send(jakarta.mail.internet.MimeMessage mimeMessage)
    指定された JavaMail MIME メッセージを送信します。
    void
    send(jakarta.mail.internet.MimeMessage... mimeMessages)
    JavaMail MIME メッセージの指定された配列をバッチで送信します。
    default void
    send(MimeMessagePreparator mimeMessagePreparator)
    指定された MimeMessagePreparator によって準備された JavaMail MIME メッセージを送信します。
    default void
    send(MimeMessagePreparator... mimeMessagePreparators)
    指定された MimeMessagePreparators によって準備された JavaMail MIME メッセージを送信します。

    インターフェース MailSender から継承されたメソッド

    send, send

  • メソッドの詳細

    • createMimeMessage

      jakarta.mail.internet.MimeMessage createMimeMessage()
      この送信者の基になる JavaMail セッション用の新しい JavaMail MimeMessage を作成します。クライアントが準備して send（MimeMessage）に渡すことができる MimeMessage インスタンスを作成するために呼び出す必要があります。
      戻り値:
      新しい MimeMessage インスタンス
      関連事項:

    • createMimeMessage

      jakarta.mail.internet.MimeMessage createMimeMessage(InputStreamSE contentStream) throws MailException
      指定された入力ストリームをメッセージソースとして使用して、この送信者の基になる JavaMail セッションの新しい JavaMail MimeMessage を作成します。
      パラメーター:
      contentStream - メッセージの生の MIME 入力ストリーム
      戻り値:
      新しい MimeMessage インスタンス
      例外:
      MailParseException - メッセージ作成の失敗の場合
      MailException

    • send

      default void send(jakarta.mail.internet.MimeMessage mimeMessage) throws MailException
      指定された JavaMail MIME メッセージを送信します。メッセージは createMimeMessage() で作成されている必要があります。
      パラメーター:
      mimeMessage - 送信するメッセージ
      例外:
      MailAuthenticationException - 認証に失敗した場合
      MailSendException - メッセージ送信時に失敗した場合
      MailException
      関連事項:

    • send

      void send(jakarta.mail.internet.MimeMessage... mimeMessages) throws MailException
      JavaMail MIME メッセージの指定された配列をバッチで送信します。メッセージは createMimeMessage() で作成されている必要があります。
      パラメーター:
      mimeMessages - 送信するメッセージ
      例外:
      MailAuthenticationException - 認証に失敗した場合
      MailSendException - メッセージ送信時に失敗した場合
      MailException
      関連事項:

    • send

      default void send(MimeMessagePreparator mimeMessagePreparator) throws MailException
      指定された MimeMessagePreparator によって準備された JavaMail MIME メッセージを送信します。

      createMimeMessage() および send(MimeMessage) 呼び出しの代わりに、MimeMessage インスタンスを準備する代替方法。適切な例外変換を処理します。

      パラメーター:
      mimeMessagePreparator - 使用する準備
      例外:
      MailPreparationException - メッセージの準備中に障害が発生した場合
      MailParseException - メッセージの解析中に障害が発生した場合
      MailAuthenticationException - 認証に失敗した場合
      MailSendException - メッセージ送信時に失敗した場合
      MailException

    • send

      default void send(MimeMessagePreparator... mimeMessagePreparators) throws MailException
      指定された MimeMessagePreparators によって準備された JavaMail MIME メッセージを送信します。

      createMimeMessage() および send(MimeMessage[]) 呼び出しの代わりに、MimeMessage インスタンスを準備する代替方法。適切な例外変換を処理します。

      パラメーター:
      mimeMessagePreparators - 使用する準備
      例外:
      MailPreparationException - メッセージの準備中にエラーが発生した場合
      MailParseException - メッセージの解析中にエラーが発生した場合
      MailAuthenticationException - 認証に失敗した場合
      MailSendException - メッセージ送信時に失敗した場合
      MailException