ERMailSender (Project Wonder Reference Documentation)

java.lang.Object
- er.javamail.ERMailSender

All Implemented Interfaces:

Runnable
```
public class ERMailSender
extends Object
implements Runnable
```
This class is used to send mails in a threaded way. This is needed in WebObjects because if sending 20 mails takes 40 seconds, then the user must wait 40 seconds before attempting to use the application.

このクラスはメール送信をスレッド系で送信します。 WebObjects には必要な方法です。なぜなら、メール 20通が約 40秒かかるとユーザが 40秒もアプリケーションが使えるようになるまでに待つ必要が発生します。

Author:

Camille Troillard <tuscland@mac.com>, Tatsuya Kawano <tatsuyak@mac.com>, Max Muller <maxmuller@mac.com>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ERMailSender.SizeOverflowException` Exception class for alerting about a stack overflow オーバフローの例外発生クラス
`class`	`ERMailSender.Stats` This class is about logging mail event for stats purposes.

Field Summary

Fields
Modifier and Type Field and Description

static String InvalidEmailNotification

Fields
Modifier and Type	Field and Description
`static String`	`InvalidEmailNotification`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected javax.mail.Transport`	`_connectedTransportForSession(javax.mail.Session session, String smtpProtocol, boolean _throwExceptionIfConnectionFails)` Utility method that gets the SMTP Transport method for a session and connects the Transport before returning it.
`protected void`	`_sendMessageNow(ERMessage message, javax.mail.Transport transport)` Common method used by 'sendMessageNow' and 'sendMessageDeffered' (actually the 'run' method when the thread is running) to send a message.
`ERQueue<ERMessage>`	`messages()`
`protected void`	`notifyInvalidEmails(NSArray<String> invalidEmails)` Executes the callback method to notify the calling application of any invalid emails.
`void`	`run()` Don't call this method, this is the thread run loop and is automatically called.
`void`	`sendMessageDeffered(ERMessage message)` Sends a message in a non-blocking way.
`void`	`sendMessageNow(ERMessage message)` Sends a message immediately.
`static ERMailSender`	`sharedMailSender()`
`ERMailSender.Stats`	`stats()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - InvalidEmailNotification
```
public static final String InvalidEmailNotification
```
    See Also:
    
    Constant Field Values
- Method Detail
  - sharedMailSender
```
public static ERMailSender sharedMailSender()
```
    Returns:
    
    the shared instance of the singleton ERMailSender object
    
    ERMailSender シングルトン・オブジェクトを戻します。
  - stats
```
public ERMailSender.Stats stats()
```
    Returns:
    
    the stats associated with this ERMailSender object
    
    ERMailSender オブジェクトと関連されている統計を戻します
  - sendMessageDeffered
```
public void sendMessageDeffered(ERMessage message)
                         throws ERMailSender.SizeOverflowException
```
    Sends a message in a non-blocking way. This means that the thread won't be blocked, but the message will be queued before being delivered.
    
    メッセージをブロックされない形で送信します。
    スレッドはブロックされませんが、メッセージは送信する前にキューに入れられます。
    
    Throws:
    
    ERMailSender.SizeOverflowException
  - sendMessageNow
```
public void sendMessageNow(ERMessage message)
```
    Sends a message immediately. This means that the thread could be blocked if the message takes time to be delivered.
    
    メッセージを直ちに送信する
    メッセージが送信に時間がかかりすぎるとスレッドがブロックされる可能性があります。
  - _sendMessageNow
```
protected void _sendMessageNow(ERMessage message,
                               javax.mail.Transport transport)
                        throws javax.mail.MessagingException
```
    Common method used by 'sendMessageNow' and 'sendMessageDeffered' (actually the 'run' method when the thread is running) to send a message. This method sends the message and increments the processed mail count. If an exception occurs while sending the mail, and if a callback object has been given, the notifyInvalidEmails method is called.
    If a MessagingException is thrown, then the exception is catched and rethrown immediately, thus letting us to process another callbacks or not. For example, This is used when sendMessageNow is used, the MessagingException is encapsulated in a ERMailSender.ForwardException, and thrown to the user.
    
    'sendMessageNow' と 'sendMessageDeffered' (実際は 'run' メソッド) のメール送信共通メソッドです。
    このメソッドはメッセージを送信し、メール送信カウンターを進みます。メール送信中に例外が発生するとコールバック指定があれば、 notifyInvalidEmails メソッドがコールされます。
    MessagingException が発生すると例外がキャチュされ、再度発生させます。他のコールバックを対応できるようになります。例えば、sendMessageNow が使用されている時 MessagingException は ERMailSender.ForwardException 内にカプセル化されます。
    
    Throws:
    
    javax.mail.MessagingException
  - _connectedTransportForSession
```
protected javax.mail.Transport _connectedTransportForSession(javax.mail.Session session,
                                                             String smtpProtocol,
                                                             boolean _throwExceptionIfConnectionFails)
                                                      throws javax.mail.MessagingException
```
    Utility method that gets the SMTP Transport method for a session and connects the Transport before returning it.
    
    セッションの SMTP トランスポート方法を取得するユーティリティー・メソッド。戻す前にトランスポートへの接続を開始します。
    
    Throws:
    
    javax.mail.MessagingException
  - run
```
public void run()
```
    Don't call this method, this is the thread run loop and is automatically called.
    
    このメソッドをコールしないでください。これはスレッド実行ループで自動的に処理されます。
    
    Specified by:
    
    run in interface Runnable
  - messages
```
public ERQueue<ERMessage> messages()
```
  - notifyInvalidEmails
```
protected void notifyInvalidEmails(NSArray<String> invalidEmails)
```
    Executes the callback method to notify the calling application of any invalid emails.
    
    メール送信失敗のアプリケーションのコールバックを実行します。

Class ERMailSender

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

InvalidEmailNotification

Method Detail

sharedMailSender

stats

sendMessageDeffered

sendMessageNow

_sendMessageNow

_connectedTransportForSession

run

messages

notifyInvalidEmails