er.javamail

Class ERMailUtils

java.lang.Object

er.javamail.ERMailUtils

public class ERMailUtils
extends Object

ERMailUtils contains various utility method related to mail sending.

ERMailUtils はメール送信の為のユーティリティー・メソッド集

Version:

$Id$

Author:

Camille Troillard

Constructor Summary

Constructors

Constructor and Description
ERMailUtils()

Method Summary

Modifier and Type	Method and Description
static NSArray<String>	convertInternetAddressesToNSArray(javax.mail.Address[] addressesArray) Method that converts Address [] loaded with either Address or InternetAddress objects to NSArray of String emails.
static javax.mail.internet.InternetAddress[]	convertNSArrayToInternetAddresses(NSArray<String> addrs) Method that converts NSArray of String emails to InternetAddress [].
static javax.mail.internet.InternetAddress[]	convertNSDictionaryToInternetAddresses(NSDictionary<String,String> addrs, String charset) Method that converts NSDictionary consisting of String emails as keys and String personal names to InternetAddress [].
static NSArray<String>	emailsFromBulkList(String str) This method will parse a large string of email address that could be separated by commas, semicolon, tabs, spaces, carriage returns, (even mixed) and will return an NSArray of addresses(strings)
static String	encodeString(String string, String charset) エンコーディング処理
static WOComponent	instantiatePage(String pageName, NSDictionary<String,Object> sessionDict) Augmented version of the method found in ERXApplication.
static void	sendHTMLMail(ERMailDeliveryHTML delivery, String pageName, String alternatePageName, String emailFrom, String emailTo, String emailReplyTo, String subject) Use this method to send an HTML mail.
static void	sendHTMLMail(String pageName, String alternatePageName, String emailFrom, String emailTo, String emailReplyTo, String subject) Use this method to send an HTML mail, but default mail delivery.
static void	setDictionaryValuesInSession(NSDictionary<String,Object> dict, WOSession session) This method sets the values found in a dictionary into the session's state dictionary.
static ERMailDeliveryHTML	sharedDeliverer() Accessor to the shared instance of a ERMailDeliveryHTML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ERMailUtils

public ERMailUtils()

Method Detail

sharedDeliverer

public static ERMailDeliveryHTML sharedDeliverer()

Accessor to the shared instance of a ERMailDeliveryHTML.

共有インスタンス ERMailDeliveryHTML へのアクセス

Returns:

the ERMailDeliveryHTML singleton

ERMailDeliveryHTML シングルトン

instantiatePage

public static WOComponent instantiatePage(String pageName,
                                          NSDictionary<String,Object> sessionDict)

Augmented version of the method found in ERXApplication. Used to instantiate a WOComponent, typically outside of a session.

ERXApplication 内にある同名メソッドの拡張版。 セッションの外側のインスタンス化に使用します。

Parameters:

pageName -

The name of the WOComponent that must be instantiated.

インスタンス化する WOComponent 名

sessionDict -

can be provided in order to set objects/keys in the newly created session of the component. This is useful when one want to preserve state when sending a mail.

コンポーネントのために、新規作成されるセッションにセットする「オブジェクト/キー」メール送信にセッション情報が必要な場合に有効です。

Returns:

a newly instantiated WOComponent.

新規のインスタンス済み WOComponent

sendHTMLMail

public static void sendHTMLMail(ERMailDeliveryHTML delivery,
                                String pageName,
                                String alternatePageName,
                                String emailFrom,
                                String emailTo,
                                String emailReplyTo,
                                String subject)

Use this method to send an HTML mail.

HTML メール送信に使用します。

Parameters:

delivery -

the ERMailDeliveryHTML used to send the mail.

メール配信に使用される ERMailDeliveryHTML

pageName -

The name of the WOComponent that must be instantiated.

HTMLメッセージを持つインスタンス化する WOComponent 名

alternatePageName -

The name of the WOComponent that represents for the text that must be displayed when an alternate plain text version of the mail needs to be provided.

テキスト・メッセージを持つインスタンス化する WOComponent 名

emailFrom -

the email address the mail is sent from

送信元のメール・アドレス

emailTo -

the email address the mail is sent to

インスタンス化する WOComponent 名

emailReplyTo -

the email address where the mail must be replied-to.

返信先のメール・アドレス

subject -

the subject of the mail

メールのサブジェクト

sendHTMLMail

public static void sendHTMLMail(String pageName,
                                String alternatePageName,
                                String emailFrom,
                                String emailTo,
                                String emailReplyTo,
                                String subject)

Use this method to send an HTML mail, but default mail delivery.

デフォルト配信インスタンスを使用し、 HTML メール送信を行います。

Parameters:

pageName -

The name of the WOComponent that must be instantiated.

HTMLメッセージを持つインスタンス化する WOComponent 名

alternatePageName -

The name of the WOComponent that represents for the text that must be displayed when an alternate plain text version of the mail needs to be provided.

テキスト・メッセージを持つインスタンス化する WOComponent 名

emailFrom -

the email address the mail is sent from

送信元のメール・アドレス

emailTo -

the email address the mail is sent to

インスタンス化する WOComponent 名

emailReplyTo -

the email address where the mail must be replied-to.

返信先のメール・アドレス

subject -

the subject of the mail

メールのサブジェクト

setDictionaryValuesInSession

public static void setDictionaryValuesInSession(NSDictionary<String,Object> dict,
                                                WOSession session)

This method sets the values found in a dictionary into the session's state dictionary. This method is useful when one want to transfer current session's state into a newly created session (for example when sending a mail whose page has been instantiated with instantiatePage(String, NSDictionary) or ERXApplication.instantiatePage(String).)

このメソッドはディクショナリー内で見つかる値をセッション状態ディクショナリーにセットします。 このメソッドはカレント・セッションを新セッションに移行する時に有効です。 （たとえば、instantiatePage(String, NSDictionary) や ERXApplication.instantiatePage(String) でインスタンス化されているページを送信する場合に有効です。）

Parameters:

dict -

a NSDictionary value containing the values we want to set in the session parameter.

セッションに設定する情報を持つ NSDictionary

session -

a WOSession value that will receive the values contained in the dict parameter.

ディクショナリー内に設定されている値をセットする WOSession

encodeString

public static String encodeString(String string,
                                  String charset)

エンコーディング処理

convertNSArrayToInternetAddresses

public static javax.mail.internet.InternetAddress[] convertNSArrayToInternetAddresses(NSArray<String> addrs)
                                                                               throws javax.mail.internet.AddressException

Method that converts NSArray of String emails to InternetAddress [].

String メールの NSArray を InternetAddress [] へ変換します。

Parameters:

addrs -

a NSArray value

NSArray

Returns:

an InternetAddress[] value

InternetAddress[]

Throws:

javax.mail.internet.AddressException -

if an error occurs

エラー発生した場合

convertInternetAddressesToNSArray

public static NSArray<String> convertInternetAddressesToNSArray(javax.mail.Address[] addressesArray)

Method that converts Address [] loaded with either Address or InternetAddress objects to NSArray of String emails.

Note that this method will not only accept Address [] but also InternetAddress [].

Address [] 又は InternetAddress [] を String メールの NSArray へ変換します。

注意： Address [] 又は InternetAddress [] が有効です

Parameters:

addressesArray -

an Address[] value

Address[]

Returns:

a NSArray value

NSArray

convertNSDictionaryToInternetAddresses

public static javax.mail.internet.InternetAddress[] convertNSDictionaryToInternetAddresses(NSDictionary<String,String> addrs,
                                                                                           String charset)
                                                                                    throws javax.mail.internet.AddressException

Method that converts NSDictionary consisting of String emails as keys and String personal names to InternetAddress [].

String メールの NSDictionary を InternetAddress [] へ変換します。 キーが String メール・アドレスでオブジェクトが String の個人名

Parameters:

addrs -

a NSDictionary with email, personal name as key value pair

NSDictionary メール 個人名の KV

charset -

a String of the charset to use for personal string

個人名文字列に使用する文字セット

Returns:

an InternetAddress[] value

InternetAddress[]

Throws:

javax.mail.internet.AddressException -

if an error occurs

エラー発生した場合

emailsFromBulkList

public static NSArray<String> emailsFromBulkList(String str)

This method will parse a large string of email address that could be separated by commas, semicolon, tabs, spaces, carriage returns, (even mixed) and will return an NSArray of addresses(strings)

Parameters:

str -

Returns:

NSArray<String> of email address