ERMailDelivery (Project Wonder Reference Documentation)

java.lang.Object
- er.javamail.ERMailDelivery

Direct Known Subclasses:

ERMailDeliveryComponentBased, ERMailDeliveryPlainText
```
public abstract class ERMailDelivery
extends Object
```
This is the main class for sending mail with the JavaMail API. You should create instances of its subclasses that match with specific use cases.
Here is an example of its usage:

JavaMail API でメールを送信するメインクラスです。このクラスは抽選クラスなので、のインスタンスを作成しません。替わりに特集なサブクラスを作る場合にインスタンス化する必要はあるでしょう！
使用方法：
```
    ERMailDeliveryHTML mail = new ERMailDeliveryHTML();
    mail.setWOComponentContent(mailPage);
 
    try {
        mail.newMail();
        mail.setFromAddress(emailFrom);
        mail.setReplyToAddress(emailReplyTo);
        mail.setSubject(emailSubject);
        mail.setToAddresses(new NSArray(toEmailAddresses));

        // Send the mail
        mail.sendMail();
    } catch (Exception e) {
        // do something ...
    }
```
Author:

Camille Troillard <tuscland@mac.com>, ak fixes

Properties
Name Description
er.javamail.defaultEncoding er.javamail.defaultEncoding

Properties
Name	Description
`er.javamail.defaultEncoding`	er.javamail.defaultEncoding

Field Summary

Fields
Modifier and Type	Field and Description
`protected NSMutableArray<ERMailAttachment>`	`_attachments` NSArray of ERMailAttachment that must be binded to the message as ATTACHEMENT.
`String`	`_charset`
`protected NSMutableArray<ERMailAttachment>`	`_inlineAttachments` NSArray of ERMailAttachment that must be binded to the message as INLINE.
`protected javax.mail.internet.MimeMessage`	`_mimeMessage` Content of sent mail.
`static String`	`DefaultCharset`

Constructor Summary

Constructors
Constructor and Description

ERMailDelivery()
Default constructor

ERMailDelivery(javax.mail.Session session)
Designated constructor

Constructors
Constructor and Description
`ERMailDelivery()` Default constructor
`ERMailDelivery(javax.mail.Session session)` Designated constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected NSMutableArray<ERMailAttachment>`	`_attachments()`
`protected NSMutableArray<ERMailAttachment>`	`_inlineAttachments()`
`void`	`addAttachment(ERMailAttachment attachment)`
`void`	`addInlineAttachment(ERMailAttachment attachment)`
`NSArray<ERMailAttachment>`	`attachments()`
`protected ERMessage`	`buildMessage()` Builds an ERMessage for the current MimeMessage.
`String`	`charset()`
`String`	`contextString()`
`protected void`	`finishMessagePreparation()`
`NSArray<ERMailAttachment>`	`inlineAttachments()`
`protected javax.mail.internet.InternetAddress`	`internetAddressWithEmailAndPersonal(String email, String personal)` メール・アドレスと名前を InternetAddress としてインスタンス化と戻します
`protected javax.mail.internet.MimeMessage`	`mimeMessage()`
`void`	`newMail()` Creates a new mail instance within ERMailDelivery ERMailDelivery インスタンス内で新しいメールを作成します。
`protected abstract DataHandler`	`prepareMail()` Abstract method called by subclasses for doing pre-processing before sending the mail.
`void`	`removeAttachment(ERMailAttachment attachment)`
`void`	`sendMail()` Sends the mail immediately.
`void`	`sendMail(boolean shouldBlock)` Method used to construct a MimeMessage and then send it.
`protected javax.mail.Session`	`session()`
`void`	`setAdditionalHeader(String headerKey, String value)` Sets an additional custom header element for the message.
`void`	`setBCCAddresses(NSArray<String> bccAddresses)` Sets the bcc-addresses array for the current message instance カレント・メッセージ・インスタンスの BCCアドレス NSArray をセットします
`void`	`setBCCAddresses(NSDictionary<String,String> bccAddresses)` Sets the bcc-addresses array for the current message instance カレント・メッセージ・インスタンスの BCCアドレス NSDictionary をセットします
`void`	`setCCAddresses(NSArray<String> ccAddresses)` Sets the cc-addresses array for the current message instance カレント・メッセージ・インスタンスの CCアドレス NSArray をセットします
`void`	`setCCAddresses(NSDictionary<String,String> ccAddresses)` Sets the cc-addresses array for the current message instance カレント・メッセージ・インスタンスの CCアドレス NSDictionary をセットします
`void`	`setCharset(String charset)`
`void`	`setContextString(String contextString)`
`void`	`setDelegate(ERMessage.Delegate delegate)` Sets the given delegate to listen to any messages that are created from this ERMailDelivery.
`void`	`setFromAddress(String fromAddress)` Sets the from address for the current message instance カレント・メッセージ・インスタンスの送信元アドレスをセットします
`void`	`setFromAddress(String fromAddress, String personalName)` Sets the from address for the current message instance using an email and the personal name.
`void`	`setInternetAddresses(NSArray<javax.mail.internet.InternetAddress> addresses, javax.mail.Message.RecipientType type)` Sets addresses using an NSArray of InternetAddress objects.
`protected void`	`setMimeMessage(javax.mail.internet.MimeMessage message)`
`void`	`setReplyToAddress(String toAddress)` Sets the reply-to address for the current message instance カレント・メッセージ・インスタンスの Reply To アドレスをセットします
`void`	`setReplyToAddress(String toAddress, String personalName)` Sets the reply-to address for the current message instance カレント・メッセージ・インスタンスの Reply To アドレスと名前をセットします
`protected void`	`setSession(javax.mail.Session aSession)`
`void`	`setSubject(String subject)` Sets the subject for the current message instance カレント・メッセージ・インスタンスの題名をセットします
`void`	`setToAddress(String toAddress)` カレント・メッセージ・インスタンスの送信先アドレスをセットします
`void`	`setToAddress(String toAddress, String personalName)` Sets the to address for the current message instance using an email and the personal name.
`void`	`setToAddresses(NSArray<String> toAddresses)` Sets the to-addresses array for the current message instance カレント・メッセージ・インスタンスの送信先 NSArray アドレスをセットします
`void`	`setToAddresses(NSDictionary<String,String> toAddresses)` Sets the to-addresses array for the current message instance カレント・メッセージ・インスタンスの送信先 NSDictionary アドレスをセットします
`void`	`setUserInfo(NSDictionary<String,Object> userInfo)` Sets the userInfo dictionary for this ERMailDelivery.
`void`	`setXMailerHeader(String xMailer)` Sets the X-Mailer header for the message.
`NSDictionary<String,Object>`	`userInfo()` Returns the userInfo dictionary for this ERMailDelivery.
`String`	`xMailerHeader()` Gets the X-Mailer header set on the MimeMessage.

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

- Field Detail
  - _mimeMessage
```
protected javax.mail.internet.MimeMessage _mimeMessage
```
    Content of sent mail. In one instance of ERMailDelivery, when creating multiple mails, you must be sure to call newMail () method before send a new mail in order to have a cleared fresh mail
    
    メールのコンテントです。 ERMailDelivery のインスタンスで複数メールを送信する時には newMail() コマンドで初期化を行ってください。
  - _attachments
```
protected NSMutableArray<ERMailAttachment> _attachments
```
    NSArray of ERMailAttachment that must be binded to the message as ATTACHEMENT.
    
    ERMailAttachment の NSArray でメッセージの ATTACHEMENT としてバインディングされる
  - _inlineAttachments
```
protected NSMutableArray<ERMailAttachment> _inlineAttachments
```
    NSArray of ERMailAttachment that must be binded to the message as INLINE.
    
    ERMailAttachment の NSArray でメッセージの INLINE としてバインディングされる
  - DefaultCharset
```
public static final String DefaultCharset
```
  - _charset
```
public String _charset
```
- Constructor Detail
  - ERMailDelivery
```
public ERMailDelivery(javax.mail.Session session)
```
    Designated constructor
  - ERMailDelivery
```
public ERMailDelivery()
```
    Default constructor
- Method Detail
  - setDelegate
```
public void setDelegate(ERMessage.Delegate delegate)
```
    Sets the given delegate to listen to any messages that are created from this ERMailDelivery. This will automatically call ERMessage.setDelegate(delegate) for any ERMessage that is generated.
    
    Parameters:
    
    delegate - the delegate to use for notifications
    
    この ERMailDelivery で作成されるすべてのメッセージをリスンするデリゲートを指定します。作成される全メッセージの ERMessage.setDelegate(delegate) が確実に呼ばれます。
    delegate - - 通知のためのデリゲート
  - setUserInfo
```
public void setUserInfo(NSDictionary<String,Object> userInfo)
```
    Sets the userInfo dictionary for this ERMailDelivery. This userInfo is passed through to any ERMessage that is created by this ERMailDelivery, which can be used by delegates to get additional information about the message.
    
    Parameters:
    
    userInfo - the userInfo dictionary
    
    ERMailDelivery のユーザ情報ディクショナリーをセットします。このユーザ情報は ERMailDelivery で作成される全メッセージに行き渡ります。デリゲートと合わせてメッセージの追加情報で使用できます。
    userInfo - - ユーザ情報ディクショナリー
  - userInfo
```
public NSDictionary<String,Object> userInfo()
```
    Returns the userInfo dictionary for this ERMailDelivery.
    
    Returns:
    
    the userInfo dictionary
    
    ERMailDelivery のユーザ情報ディクショナリーを戻します。
  - setContextString
```
public void setContextString(String contextString)
```
  - contextString
```
public String contextString()
```
  - charset
```
public String charset()
```
  - setCharset
```
public void setCharset(String charset)
```
  - session
```
protected javax.mail.Session session()
```
  - setSession
```
protected void setSession(javax.mail.Session aSession)
```
  - newMail
```
public void newMail()
```
    Creates a new mail instance within ERMailDelivery
    
    ERMailDelivery インスタンス内で新しいメールを作成します。
  - mimeMessage
```
protected javax.mail.internet.MimeMessage mimeMessage()
```
  - setMimeMessage
```
protected void setMimeMessage(javax.mail.internet.MimeMessage message)
```
  - addAttachment
```
public void addAttachment(ERMailAttachment attachment)
```
  - addInlineAttachment
```
public void addInlineAttachment(ERMailAttachment attachment)
```
  - _inlineAttachments
```
protected NSMutableArray<ERMailAttachment> _inlineAttachments()
```
  - inlineAttachments
```
public NSArray<ERMailAttachment> inlineAttachments()
```
  - _attachments
```
protected NSMutableArray<ERMailAttachment> _attachments()
```
  - attachments
```
public NSArray<ERMailAttachment> attachments()
```
  - removeAttachment
```
public void removeAttachment(ERMailAttachment attachment)
```
  - internetAddressWithEmailAndPersonal
```
protected javax.mail.internet.InternetAddress internetAddressWithEmailAndPersonal(String email,
                                                                                  String personal)
                                                                           throws javax.mail.internet.AddressException
```
    メール・アドレスと名前を InternetAddress としてインスタンス化と戻します
    
    Returns:
    
    address object
    
    Throws:
    
    javax.mail.internet.AddressException - if parsing of email failed
  - setFromAddress
```
public void setFromAddress(String fromAddress)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the from address for the current message instance
    
    カレント・メッセージ・インスタンスの送信元アドレスをセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setFromAddress
```
public void setFromAddress(String fromAddress,
                           String personalName)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the from address for the current message instance using an email and the personal name.
    
    カレント・メッセージ・インスタンスの送信元アドレスと名前をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setToAddress
```
public void setToAddress(String toAddress)
                  throws javax.mail.MessagingException,
                         javax.mail.internet.AddressException
```
    カレント・メッセージ・インスタンスの送信先アドレスをセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setToAddress
```
public void setToAddress(String toAddress,
                         String personalName)
                  throws javax.mail.MessagingException,
                         javax.mail.internet.AddressException
```
    Sets the to address for the current message instance using an email and the personal name.
    
    カレント・メッセージ・インスタンスの送信先アドレスと名前をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setToAddresses
```
public void setToAddresses(NSArray<String> toAddresses)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the to-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの送信先 NSArray アドレスをセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setToAddresses
```
public void setToAddresses(NSDictionary<String,String> toAddresses)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the to-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの送信先 NSDictionary アドレスをセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setReplyToAddress
```
public void setReplyToAddress(String toAddress)
                       throws javax.mail.MessagingException,
                              javax.mail.internet.AddressException
```
    Sets the reply-to address for the current message instance
    
    カレント・メッセージ・インスタンスの Reply To アドレスをセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setReplyToAddress
```
public void setReplyToAddress(String toAddress,
                              String personalName)
                       throws javax.mail.MessagingException,
                              javax.mail.internet.AddressException
```
    Sets the reply-to address for the current message instance
    
    カレント・メッセージ・インスタンスの Reply To アドレスと名前をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setCCAddresses
```
public void setCCAddresses(NSArray<String> ccAddresses)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the cc-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの CCアドレス NSArray をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setCCAddresses
```
public void setCCAddresses(NSDictionary<String,String> ccAddresses)
                    throws javax.mail.MessagingException,
                           javax.mail.internet.AddressException
```
    Sets the cc-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの CCアドレス NSDictionary をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setBCCAddresses
```
public void setBCCAddresses(NSArray<String> bccAddresses)
                     throws javax.mail.MessagingException,
                            javax.mail.internet.AddressException
```
    Sets the bcc-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの BCCアドレス NSArray をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setBCCAddresses
```
public void setBCCAddresses(NSDictionary<String,String> bccAddresses)
                     throws javax.mail.MessagingException,
                            javax.mail.internet.AddressException
```
    Sets the bcc-addresses array for the current message instance
    
    カレント・メッセージ・インスタンスの BCCアドレス NSDictionary をセットします
    
    Throws:
    
    javax.mail.MessagingException
    
    javax.mail.internet.AddressException
  - setSubject
```
public void setSubject(String subject)
                throws javax.mail.MessagingException
```
    Sets the subject for the current message instance
    
    カレント・メッセージ・インスタンスの題名をセットします
    
    Parameters:
    
    subject - subject string
    
    Throws:
    
    javax.mail.MessagingException - if the charset conversion of the subject fails
  - setXMailerHeader
```
public void setXMailerHeader(String xMailer)
                      throws javax.mail.MessagingException
```
    Sets the X-Mailer header for the message. Useful for tracking which mailers are sending messages.
    
    Parameters:
    
    xMailer - value to set
    
    メッセージの X-Mailer ヘッダーをセットします。どのメールソフトが送信しているかどうかの調査使用します。
    xMailer - - セットする値
    
    Throws:
    
    javax.mail.MessagingException
  - xMailerHeader
```
public String xMailerHeader()
                     throws javax.mail.MessagingException
```
    Gets the X-Mailer header set on the MimeMessage.
    
    Returns:
    
    X-Mailer header if it is set
    
    メッセージの X-Mailer ヘッダーを取得します。
    Throws:
    
    javax.mail.MessagingException
  - setAdditionalHeader
```
public void setAdditionalHeader(String headerKey,
                                String value)
                         throws javax.mail.MessagingException
```
    Sets an additional custom header element for the message.
    
    Parameters:
    
    headerKey -
    
    value - value to set
    
    Throws:
    
    javax.mail.MessagingException
  - buildMessage
```
protected ERMessage buildMessage()
```
    Builds an ERMessage for the current MimeMessage.
    
    Returns:
    
    ERMessage for the current MimeMessage.
    
    カレント MimeMessage のために ERMessage を生成します。
  - sendMail
```
public void sendMail()
```
    Sends the mail immediately. The message is put in a FIFO queue managed by a static threaded inner class
    
    メールを直ちに送信します。メッセージは内部スレッド・クラスによる FIFO キューに保存されます。
  - sendMail
```
public void sendMail(boolean shouldBlock)
```
    Method used to construct a MimeMessage and then send it. This method can be specified to block until the message is sent or to add the message to a queue and have a callback object handle any exceptions that happen. If sending is blocking then any exception thrown will be wrapped in a general NSForwardException.
    
    Parameters:
    
    shouldBlock - boolean to indicate if the message should be added to a queue or sent directly.
    
    MimeMessage を生成し、送信を試します。このメソッドは送信完了までにブロックするかキューに登録し例外が発生する場合はコールバック・オブジェクトで処理されるかを指定できます。送信でブロックを使用するとすべての例外は NSForwardException にラップされます。
    shouldBlock - - ブロックするかキューを使うかの boolean
  - finishMessagePreparation
```
protected void finishMessagePreparation()
                                 throws javax.mail.MessagingException
```
    Throws:
    
    javax.mail.MessagingException
  - setInternetAddresses
```
public void setInternetAddresses(NSArray<javax.mail.internet.InternetAddress> addresses,
                                 javax.mail.Message.RecipientType type)
                          throws javax.mail.MessagingException
```
    Sets addresses using an NSArray of InternetAddress objects.
    
    InternetAddress オブジェクトの NSArray をセットします
    
    Throws:
    
    javax.mail.MessagingException
  - prepareMail
```
protected abstract DataHandler prepareMail()
                                    throws javax.mail.MessagingException
```
    Abstract method called by subclasses for doing pre-processing before sending the mail.
    
    Returns:
    
    the multipart used to put in the mail.
    
    メールを送信前の処理のサブクラスの抽選メソッド
    Throws:
    
    javax.mail.MessagingException

Class ERMailDelivery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_mimeMessage

_attachments

_inlineAttachments

DefaultCharset

_charset

Constructor Detail

ERMailDelivery

ERMailDelivery

Method Detail

setDelegate

setUserInfo

userInfo

setContextString

contextString

charset

setCharset

session

setSession

newMail

mimeMessage

setMimeMessage

addAttachment

addInlineAttachment

_inlineAttachments

inlineAttachments

_attachments

attachments

removeAttachment

internetAddressWithEmailAndPersonal

setFromAddress

setFromAddress

setToAddress

setToAddress

setToAddresses

setToAddresses

setReplyToAddress

setReplyToAddress

setCCAddresses

setCCAddresses

setBCCAddresses

setBCCAddresses

setSubject

setXMailerHeader

xMailerHeader

setAdditionalHeader

buildMessage

sendMail

sendMail

finishMessagePreparation

setInternetAddresses

prepareMail