ERIMAP is a utilities class that let you obtain connections and messages from an IMAP server.
- *
- * @author Pascal Robert
- */
-
-package er.javamail;
-
-import javax.mail.AuthenticationFailedException;
-import javax.mail.FolderNotFoundException;
-import javax.mail.MessagingException;
-import javax.mail.internet.MimeMessage;
-
-import com.sun.mail.imap.IMAPFolder;
-import com.sun.mail.imap.IMAPStore;
-import com.webobjects.foundation.NSArray;
-import com.webobjects.foundation.NSMutableArray;
-
-public class ERIMAP {
-
- private IMAPStore imapStore;
-
- public ERIMAP() {
- super();
- }
-
- /*
- * Simply return an IMAP (non-SSL) connection, obtained with a user and password.
- * The IMAP server host name is obtained from the er.javamail.imapHost property.
- *
- * @param The user and password for the user to connect with.
- *
- */
- public void openConnection(String imapUser, String imapPassword) throws AuthenticationFailedException, MessagingException, IllegalStateException {
- imapStore = (IMAPStore)ERJavaMail.sharedInstance().defaultSession().getStore("imap");
- imapStore.connect(imapHost(), imapUser, imapPassword);
- }
-
- /*
- * Close the IMAP store and connection.
- */
- public void closeConnection() throws MessagingException {
- imapStore.close();
- }
-
- /*
- * This method will open a IMAP folder. Check com.sun.mail.imap.IMAPFolder constants for the mode parameter.
- *
- * @param The folder name to open, and how to open it (read only or read write)
- * @return An IMAP folder that you can manipulate.
- */
- // mode = Folder.READ_WRITE
- public IMAPFolder openFolder(String folderName, int mode) throws MessagingException, FolderNotFoundException {
- IMAPFolder folder = (IMAPFolder)imapStore.getFolder(folderName);
- folder.open(mode);
- return folder;
- }
-
- /*
- * Close a IMAP folder and optionally expunge messages with the DELETE flag.
- *
- * @param An IMAP folder, obtained with openFolder, and a boolean to tell if you want to expunge deleted messages.
- */
- public void closeFolder(IMAPFolder folder, boolean expunge) throws MessagingException {
- folder.close(expunge);
- }
-
- /*
- * Get all messages from an IMAP folder. Simply call getMessages with 1 as the first message index, and folder.getMessageCount as the last message index.
- *
- * @param An IMAP folder, obtained with openFolder.
- * @return A array of ERMessage.
- */
- public NSArrayERJavaMail instance
- *
- * ERJavaMail シングルトン・アクセス・メソッド
- *
- * @return ERJavaMail インスタンス
- */
- public static synchronized ERJavaMail sharedInstance() {
- if (sharedInstance == null) {
- sharedInstance = ERXFrameworkPrincipal.sharedInstance(ERJavaMail.class);
- }
- return sharedInstance;
- }
-
- /**
- * EMAIL_VALIDATION_PATTERN is a regexp pattern that is used to validate emails.
- *
- *
- * EMAIL_VALIDATION_PATTERN はメールアドレスの検証のための Regex パタン
- */
- // RFC 2822 token definitions for valid email - only used together to form a java Pattern object:
- private static final String sp = "!#$%&'*+\\-/=?^_`{|}~";
- private static final String atext = "[a-zA-Z0-9" + sp + "]";
- private static final String atom = atext + "+"; // one or more atext chars
- private static final String dotAtom = "\\." + atom;
- private static final String localPart = atom + "(" + dotAtom + ")*"; // one atom followed by 0 or more dotAtoms.
- // RFC 1035 tokens for domain names:
- private static final String letter = "[a-zA-Z]";
- private static final String letDig = "[a-zA-Z0-9]";
- private static final String letDigHyp = "[a-zA-Z0-9\\-]";
- private static final String rfcLabel = letDig + "(" + letDigHyp + "{0,61}" + letDig + "){0,1}";
- private static final String domain = rfcLabel + "((\\." + rfcLabel + ")*\\." + letter + "{2,6}){0,1}";
- // Combined together, these form the allowed email regexp allowed by RFC 2822:
- private static final String EMAIL_VALIDATION_PATTERN = "^" + localPart + "@" + domain + "$";
-
- /**
- * The compiled form of the EMAIL_VALIDATION_PATTERN pattern.
- */
- protected Pattern _pattern = null;
-
- private Delegate _delegate;
-
- public void setDelegate(Delegate delegate) {
- _delegate = delegate;
- }
-
- /**
- * Specialized implementation of the method from ERXPrincipalClass.
- */
- @Override
- public void finishInitialization() {
- initializeFrameworkFromSystemProperties();
- log.debug("ERJavaMail loaded");
- }
-
- /**
- * This method is used to initialize ERJavaMail from System properties. Later, we will implement a
- * way to initialize those properties everytime the propertis are changed. The observer will call this method
- * whenever appropriate.
- *
- * このメソッドは ERJavaMail をシステム・プロパティより初期化するためにあります。 後でプロパティが変更される度にこのメソッドが実行される処理を追加実装します。
- */
- public void initializeFrameworkFromSystemProperties() {
- // Centralize mails ?
- boolean centralize = ERXProperties.booleanForKey("er.javamail.centralize");
- setCentralize(centralize);
- log.debug("er.javamail.centralize: " + centralize);
-
- String adminEmail = System.getProperty("er.javamail.adminEmail");
- if (isValidEmail(adminEmail)) {
- setAdminEmail(adminEmail);
- log.debug("er.javamail.adminEmail: " + _adminEmail);
- }
- else if (centralize) {
- throw new IllegalArgumentException("When 'er.javamail.centralize' is true (default)," + " all outgoing mails will get sent to 'er.javamail.adminEmail'" + " instead of the normal TO addresses, but you did not provide a valid email for that property.");
- }
-
- // JavaMail Debug Enabled ?
- boolean debug = ERXProperties.booleanForKey("er.javamail.debugEnabled");
- setDebugEnabled(debug);
- log.debug("er.javamail.debugEnabled: " + debug);
-
- // Number of messages that the sender queue can hold at a time
- int queueSize = ERXProperties.intForKey("er.javamail.senderQueue.size");
- if (queueSize >= 1)
- setSenderQueueSize(queueSize);
- log.debug("er.javamail.senderQueue.size: " + queueSize);
-
- // Time to wait when sender if overflowed
- int milliswait = ERXProperties.intForKey("er.javamail.milliSecondsWaitIfSenderOverflowed");
- if (milliswait > 1000)
- setMilliSecondsWaitIfSenderOverflowed(milliswait);
- log.debug("er.javamail.milliSecondsWaitIfSenderOverflowed: " + milliswait);
-
- // Smtp host
- setupSmtpHostSafely();
-
- setDefaultSession(newSession());
-
- if (defaultSession() == null)
- log.warn("Unable to create default mail session!");
-
- // Default X-Mailer header
- setDefaultXMailerHeader(System.getProperty("er.javamail.XMailerHeader"));
- log.debug("er.javamail.XMailHeader: " + defaultXMailerHeader());
- }
-
- /**
- * Helper method to init the smtpHost property. This method first check is
- * er.javamail.smtpHost is set. If it is not set, then it looks for mail.smtp.host
- * (standard JavaMail property) and finally the WOSMTPHost property. When a correct property is found,
- * then it sets both properties to the found value. If no properties are found, a RuntimeException is thrown.
- *
- * @throws RuntimeException
- * if neither one of er.javamail.smtpHost, mail.smtp.host or
- * WOSMTPHost is set.
- *
- * smtpHost プロパティを初期化するヘルプ・メソッドです。 最初には er.javamail.smtpHost
- * がセットされているかどうかをチェックします。 セットされていなければ、mail.smtp.host (標準 JavaMail プロパティ) をチェックし、最終的には
- * WOSMTPHost プロパティ。 正しいプロパティが見つかると結果値を両方のプロパティにセットします。見つからない場合には RuntimeException が発生します。
- *
- * @throws RuntimeException
- * - er.javamail.smtpHost, mail.smtp.host 又は WOSMTPHost
- * がセットされていなければ
- */
- protected void setupSmtpHostSafely() {
- setupSmtpProperties(System.getProperties(), null);
- }
-
- protected void setupSmtpProperties(Properties properties, String contextString) {
- String contextSuffix = contextString == null ? "" : ("." + contextString);
-
- // Smtp host
- String smtpProtocol = smtpProtocolForContext(contextString);
-
- String smtpHost = ERXProperties.stringForKeyWithDefault("er.javamail.smtpHost" + contextSuffix, ERXProperties.stringForKey("er.javamail.smtpHost"));
- if ((smtpHost == null) || (smtpHost.length() == 0)) {
- // Try to fail back to default java config
- smtpHost = ERXProperties.stringForKey("mail." + smtpProtocol + ".host");
-
- if ((smtpHost == null) || (smtpHost.length() == 0)) {
- // use the standard WO host
- smtpHost = ERXProperties.stringForKey("WOSMTPHost");
- if ((smtpHost == null) || (smtpHost.length() == 0)) {
- throw new RuntimeException("ERJavaMail: You must specify a SMTP host for outgoing mail with the property 'er.javamail.smtpHost'");
- }
- // ... and then maybe actually do what the docs say this method is supposed to do
- properties.setProperty("mail." + smtpProtocol + ".host", smtpHost);
- properties.setProperty("er.javamail.smtpHost", smtpHost);
- }
- else {
- properties.setProperty("er.javamail.smtpHost", smtpHost);
- }
- }
- else {
- properties.setProperty("mail." + smtpProtocol + ".host", smtpHost);
- }
- log.debug("er.javamail.smtpHost: " + smtpHost);
-
- String port = ERXProperties.stringForKeyWithDefault("er.javamail.smtpPort" + contextSuffix, ERXProperties.stringForKey("er.javamail.smtpPort"));
- if (port != null && port.length() > 0) {
- properties.setProperty("mail." + smtpProtocol + ".port", port);
- log.debug("ERJavaMail will use smtp port: " + port);
- }
-
- boolean smtpAuth = ERXProperties.booleanForKeyWithDefault("er.javamail.smtpAuth" + contextSuffix, ERXProperties.booleanForKey("er.javamail.smtpAuth"));
- log.debug("ERJavaMail will use authenticated SMTP connections.");
- if (smtpAuth) {
- properties.setProperty("mail." + smtpProtocol + ".auth", String.valueOf(smtpAuth));
- String user = ERXProperties.stringForKeyWithDefault("er.javamail.smtpUser" + contextSuffix, ERXProperties.stringForKey("er.javamail.smtpUser"));
- if (user == null || user.length() == 0) {
- throw new RuntimeException("You specified er.javamail.smtpAuth=true, but you didn't specify an er.javamail.smtpUser to use as the login name.");
- }
- properties.setProperty("mail." + smtpProtocol + ".user", user);
- String password = ERXProperties.stringForKeyWithDefault("er.javamail.smtpPassword" + contextSuffix, ERXProperties.stringForKey("er.javamail.smtpPassword"));
- if (password == null || password.length() == 0) {
- log.warn("You specified er.javamail.smtpAuth=true, but you didn't set er.javamail.smtpPassword for the " + user + " mail user.");
- }
- if (password != null) {
- properties.setProperty("mail." + smtpProtocol + ".password", password);
- }
- }
- if ("smtps".equals(smtpProtocol)) {
- properties.setProperty("mail.smtps.socketFactory.fallback", "false");
- }
- }
-
- /**
- * This is the default JavaMail Session. It is shared among all deliverers for immediate
- * deliveries. Deferred deliverers, use their own JavaMail session.
- *
- * JavaMail のデフォルト・セッションです。 即時配信処理より共有されています。 延期配信は独自の JavaMail セッションを使用しています。
- */
- protected javax.mail.Session _defaultSession;
- private final Mapjavax.mail.Session
- *
- * JavaMail のデフォルト・セッションをセットします。 フレームワークの初期化時に設定されのですが、独自で設定する時には ここを実行するといいのです。
- *
- * @param session
- * - デフォルト javax.mail.Session
- */
- public void setDefaultSession(javax.mail.Session session) {
- session.setDebug(debugEnabled());
- _defaultSession = session;
- }
-
- /**
- * This is the deafult JavaMail Session accessor. It is shared among all deliverers for immediate
- * deliveries. Deferred deliverers, use their own JavaMail session.
- *
- * @return the default javax.mail.Session instance
- *
- * JavaMail のデフォルト・セッション・アクセス方法です。 即時配信処理のために共有されています。 延期配信は独自の JavaMail セッションを使用しています。
- *
- * @return デフォルト javax.mail.Session インスタンス
- */
- public javax.mail.Session defaultSession() {
- return _defaultSession;
- }
-
- /**
- * Returns a newly allocated Session object from the given Properties
- *
- * @param props
- * a Properties value
- * @return a javax.mail.Session value initialized from the given properties
- *
- * 指定プロパティを使った新規セッションを戻します。
- *
- * @param props
- * - Properties 値
- *
- * @return 指定プロパティで初期化されている javax.mail.Session 値
- */
- public javax.mail.Session newSession(Properties props) {
- return newSessionForContext(props, null);
- }
-
- /**
- * Returns a newly allocated Session object from the System Properties
- *
- * @return a javax.mail.Session value
- *
- * システム・プロパティを使った新規セッションを戻します。
- *
- * @return javax.mail.Session 値
- */
- public javax.mail.Session newSession() {
- return newSession(System.getProperties());
- }
-
- /**
- * Returns a newly allocated Session object for the given message.
- *
- * @param message
- * the message
- * @return a new javax.mail.Session value
- */
- public javax.mail.Session newSessionForMessage(ERMessage message) {
- return newSessionForContext(message.contextString());
- }
-
- /**
- * Returns the Session object that is appropriate for the given message.
- *
- * @return a javax.mail.Session value
- */
- public javax.mail.Session sessionForMessage(ERMessage message) {
- return sessionForContext(message.contextString());
- }
-
- /**
- * Returns a new Session object that is appropriate for the given context.
- *
- * @param contextString
- * the message context
- * @return a new javax.mail.Session value
- */
- protected javax.mail.Session newSessionForContext(String contextString) {
- javax.mail.Session session;
- if (contextString == null || contextString.length() == 0) {
- session = newSessionForContext(System.getProperties(), contextString);
- }
- else {
- Properties sessionProperties = new Properties();
- sessionProperties.putAll(System.getProperties());
- setupSmtpProperties(sessionProperties, contextString);
- session = newSessionForContext(sessionProperties, contextString);
- }
- return session;
- }
-
- /**
- * Returns a newly allocated Session object from the given Properties
- *
- * @param properties
- * a Properties value
- * @return a javax.mail.Session value initialized from the given properties
- */
- public javax.mail.Session newSessionForContext(Properties properties, String contextString) {
- if (_delegate != null) {
- _delegate.willCreateSessionWithPropertiesForContext(properties, contextString);
- }
- javax.mail.Session session = javax.mail.Session.getInstance(properties);
- if (_delegate != null) {
- _delegate.didCreateSession(session);
- }
- session.setDebug(debugEnabled());
- return session;
- }
-
- /**
- * Returns the Session object that is appropriate for the given context.
- *
- * @param contextString
- * the message context
- * @return a javax.mail.Session value
- */
- protected javax.mail.Session sessionForContext(String contextString) {
- javax.mail.Session session;
- if (contextString == null || contextString.length() == 0) {
- session = defaultSession();
- }
- else {
- session = _sessions.get(contextString);
- if (session == null) {
- session = newSessionForContext(contextString);
- _sessions.put(contextString, session);
- }
- }
- return session;
- }
-
- /**
- * email address used when centralizeMails == true String value
- *
- * centralizeMails == true の場合で使用されるメール・アドレスer.javamail.adminEmail Property.
- *
- * @param adminEmail
- * a String value
- *
- * この値は初期化中で er.javamail.adminEmail プロパティより設定されますが、 このコマンドでオーバライドが可能です。
- *
- * @param adminEmail
- * - メール・アドレス
- */
- public void setAdminEmail(String adminEmail) {
- if (!(isValidEmail(adminEmail) || (adminEmail != null && adminEmail.trim().length() > 0))) {
- throw new IllegalArgumentException("You specified an invalid admin email address '" + adminEmail + "'.");
- }
- _adminEmail = adminEmail;
- }
-
- /** This property specify wether JavaMail is debug enabled or not. */
- protected boolean _debugEnabled = true;
-
- /**
- * Returns true if JavaMail is debug enabled.
- *
- * @return a boolean value
- *
- * JavaMail がデバッグ中の場合には true が戻ります。
- *
- * @return boolean 値
- */
- public boolean debugEnabled() {
- return _debugEnabled;
- }
-
- /**
- * Sets the debug mode of JavaMail.
- *
- * @param debug
- * a boolean value sets JavaMail in debug mode
- *
- * JavaMail のデバッグ・モードをセットします。
- *
- * @param debug
- * - boolean でデバッグ・モードを On / Off できます
- */
- public void setDebugEnabled(boolean debug) {
- _debugEnabled = debug;
- }
-
- /** This property sets the default header for the X-Mailer property */
- protected String _defaultXMailerHeader = null;
-
- /**
- * Gets the default X-Mailer header to use for sending mails. Pulls the value out of the property:
- * er.javamail.XMailerHeader
- *
- * @return default X-Mailer header
- *
- * 送信時の XMailer ヘッダーのデフォルト値を取得します。 プロパティの er.javamail.XMailerHeader を参照！
- *
- * @return デフォルト X-Mailer ヘッダー
- */
- public String defaultXMailerHeader() {
- return _defaultXMailerHeader;
- }
-
- /**
- * Sets the default value of the XMailer header used when sending mails.
- *
- * @param header
- * a String value
- *
- * 送信時の XMailer ヘッダーのデフォルト値をセットします。
- *
- * @param header
- * - String 値
- */
- public void setDefaultXMailerHeader(String header) {
- _defaultXMailerHeader = header;
- }
-
- /** Used to send mail to adminEmail only. Useful for debugging issues */
- protected boolean _centralize = true;
-
- /**
- * Centralize is used to send all the outbound email to a single address which is useful when
- * debugging.
- *
- * @return a boolean value
- *
- * すべてのメールを er.javamail.adminEmail ユーザに送信します。(デバッグ中に便利)
- *
- * @return boolean 値
- */
- public boolean centralize() {
- return _centralize;
- }
-
- /**
- * Sets the value of the er.javamail.centralize Property.
- *
- * @param centralize
- * if the boolean value is true, then all the outbound mails will be sent to adminEmail
- * email address.
- *
- * er.javamail.centralize プロパティの値をセットします。
- *
- * @param centralize
- * - true の場合にはすべてのメールが adminEmail へ送信されます。
- */
- public void setCentralize(boolean centralize) {
- _centralize = centralize;
- }
-
- /**
- * Returns the SMTP protocol to use for connections.
- *
- * 接続の為の SMTP プロトコールを設定します。 (smtp or smtps)
- *
- * @param contextString
- * - SMTP プロトコール名
- */
- public String smtpProtocolForContext(String contextString) {
- String contextSuffix = (contextString == null) ? "" : ("." + contextString);
- return ERXProperties.stringForKeyWithDefault("er.javamail.smtpProtocol" + contextSuffix, ERXProperties.stringForKeyWithDefault("er.javamail.smtpProtocol", ERXProperties.stringForKeyWithDefault("mail.smtp.protocol", "smtp")));
- }
-
- /**
- * Number of messages that the sender queue can hold at a time; default to 50 messages and can be configured by
- * er.javamail.senderQueue.size system property.
- */
- protected int _senderQueueSize = 50;
-
- public int senderQueueSize() {
- return _senderQueueSize;
- }
-
- /**
- * 送信キューが一回で保持できるメッセージ数です。 デフォルトでは 50 メッセージで、システム・プロパティの er.javamail.senderQueue.size
- * で変更可能です。
- */
- public void setSenderQueueSize(int value) {
- _senderQueueSize = value;
- }
-
- /**
- * Wait n milliseconds (by default this value is 6000) if the mail sender is overflowed
- *
- * メール・キューがオーバフローされている時に待つ時間。 (デフォルトでは 6000)
- */
- protected int _milliSecondsWaitIfSenderOverflowed = 6000;
-
- /**
- * This method return the time spent waiting if the mail queue if overflowed. During that time,
- * mails are sent and the queue lowers. When the duration is spent, and the queue is under the overflow limit, the
- * mails are being sent again.
- *
- * @return an int value
- *
- * メール・キューがオーバフローされている時に待つ時間を設定します。この時間内ではメールが送信され、キューが減ります。
- * 期間が過ぎるとキューがオーバフロー制限より以下であれば、メールが再度に送信されます。
- *
- * @return int 値
- */
- public int milliSecondsWaitIfSenderOverflowed() {
- return _milliSecondsWaitIfSenderOverflowed;
- }
-
- /**
- * Sets the value of the er.javamail.milliSecondsWaitIfSenderOverflowed Property.
- *
- * @param value
- * an int value in milli-seconds.
- *
- * er.javamail.milliSecondsWaitIfSenderOverflowed プロパティをセットします。
- *
- * @param value
- * - int ミリ秒
- */
- public void setMilliSecondsWaitIfSenderOverflowed(int value) {
- _milliSecondsWaitIfSenderOverflowed = value;
- }
-
- /**
- * Validates an enterprise object's email attribute (accessed via key).
- *
- * @param object
- * the object to be validated
- * @param key
- * the attribute's name
- * @param email
- * the email value
- * @return the email if the validation didn't failed
- *
- * エンタプライス・オブジェクトのメール・アトリビュートを検証します。（キーよりのアクセス）
- *
- * @param object
- * - 検証するオブジェクト
- * @param key
- * - アトリビュート名
- * @param email
- * - メール値
- *
- * @return 検証が失敗しない場合のメールアドレス
- */
- public String validateEmail(EOEnterpriseObject object, String key, String email) {
- if (email != null) {
- if (!isValidEmail(email))
- throw ERXValidationFactory.defaultFactory().createException(object, key, email, "malformedEmail");
- }
-
- return email;
- }
-
- /**
- * Predicate used to validate email well-formness.
- *
- * @return true if the email is valid
- * @param email
- * the email String value to validate
- * @return a boolean value
- *
- * メールが正しいかどうかを検証します。
- *
- * @param email
- * - 検証するメール値
- *
- * @return メールが有効であれば true が戻ります。
- */
- public synchronized boolean isValidEmail(String email) {
- if (_pattern == null) {
- String patternString = ERXProperties.stringForKey("er.javamail.emailPattern");
- if (patternString == null || patternString.trim().length() == 0) {
- patternString = EMAIL_VALIDATION_PATTERN;
- }
-
- try {
- _pattern = Pattern.compile(patternString);
- }
- catch (PatternSyntaxException e) {
- throw new RuntimeException("The compilation of the email pattern '" + patternString + "' failed.", e);
- }
- }
- if (email != null) {
- return _pattern.matcher(email).matches();
- }
- return false;
- }
-
- // ===========================================================================
- // Black and White list email address filtering support
- // メール・フィルター： ホワイト＆ブラック・リスト
- // ---------------------------------------------------------------------------
-
- /**
- * holds the array of white list email addresses
- *
- * ホワイト・リスト・メールアドレス配列を保持
- */
- protected NSArrayHere 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 ...
- }
- *
- * @property er.javamail.defaultEncoding
- *
- * @author Camille Troillard ERMailUtils contains various utility method related to mail sending.
- *
- *
- *
- * ERMailUtils はメール送信の為のユーティリティー・メソッド集
- *
- *
- * @author Camille Troillard
- * @version $Id$
- */
-public class ERMailUtils {
-
- /** The class logger. */
- private static Logger log = Logger.getLogger(ERMailUtils.class);
-
- /**
- *
- * The shared mail deliverer
- *
- *
- *
- * メール配信の共有インスタンス
- *
- */
- private static ERMailDeliveryHTML sharedDeliverer;
-
- /**
- *
- * Accessor to the shared instance of a ERMailDeliveryHTML.
- *
- * @return the ERMailDeliveryHTML singleton
- *
- *
- *
- * 共有インスタンス ERMailDeliveryHTML へのアクセス
- *
- * @return ERMailDeliveryHTML シングルトン
- *
- */
- public static ERMailDeliveryHTML sharedDeliverer() {
- if (sharedDeliverer == null) {
- sharedDeliverer = ERMailDeliveryHTML.newMailDelivery();
- }
-
- return sharedDeliverer;
- }
-
- /**
- *
- * Augmented version of the method found in {@link ERXApplication}. Used to instantiate a WOComponent, typically
- * outside of a session.
- *
- * @param pageName
- * The name of the WOComponent that must be instantiated.
- * @param 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.
- * @return a newly instantiated WOComponent.
- *
- *
- *
- * {@link ERXApplication} 内にある同名メソッドの拡張版。
- * セッションの外側のインスタンス化に使用します。
- *
- * @param pageName - インスタンス化する WOComponent 名
- * @param sessionDict - コンポーネントのために、新規作成されるセッションにセットする「オブジェクト/キー」
- * メール送信にセッション情報が必要な場合に有効です。
- *
- * @return 新規のインスタンス済み WOComponent
- *
- */
- public static WOComponent instantiatePage(String pageName, NSDictionary sessionDict) {
- WOComponent component = ERXApplication.instantiatePage(pageName);
- if (sessionDict != null) {
- setDictionaryValuesInSession(sessionDict, component.session());
- }
-
- return component;
- }
-
- /**
- *
- * Use this method to send an HTML mail.
- *
- * @param delivery
- * the ERMailDeliveryHTML used to send the mail.
- * @param pageName
- * The name of the WOComponent that must be instantiated.
- * @param 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.
- * @param emailFrom
- * the email address the mail is sent from
- * @param emailTo
- * the email address the mail is sent to
- * @param emailReplyTo
- * the email address where the mail must be replied-to.
- * @param subject
- * the subject of the mail
- *
- *
- *
- * HTML メール送信に使用します。
- *
- * @param delivery - メール配信に使用される ERMailDeliveryHTML
- * @param pageName - HTMLメッセージを持つインスタンス化する WOComponent 名
- * @param alternatePageName - テキスト・メッセージを持つインスタンス化する WOComponent 名
- * @param emailFrom - 送信元のメール・アドレス
- * @param emailTo - 送信先のメール・アドレス
- * @param emailReplyTo - 返信先のメール・アドレス
- * @param subject - メールのサブジェクト
- *
- */
- public static void sendHTMLMail(ERMailDeliveryHTML delivery, String pageName, String alternatePageName, String emailFrom, String emailTo, String emailReplyTo, String subject) {
- WOComponent mailPage = ERMailUtils.instantiatePage(pageName, delivery.sessionDictionary());
-
- delivery.newMail();
- delivery.setComponent(mailPage);
-
- if (alternatePageName != null) {
- String alternateString = null;
- WOComponent alternateMailTemplate = ERMailUtils.instantiatePage(alternatePageName, delivery.sessionDictionary());
-
- alternateString = alternateMailTemplate.generateResponse().contentString();
-
- if (alternateString != null) {
- delivery.setHiddenPlainTextContent(alternateString);
- alternateMailTemplate.session().terminate();
- }
- }
-
- try {
- delivery.setFromAddress(emailFrom);
- delivery.setToAddress(emailTo);
- delivery.setReplyToAddress(emailReplyTo);
- delivery.setSubject((subject == null) ? "" : subject);
- delivery.sendMail();
- }
- catch (javax.mail.MessagingException e) {
- // we must handle this exception correctly because the
- // mail cannot be sent
- log.warn("While trying to sendMail: ", e);
- }
- finally {
- // We need to force the termination of the sessions
- // because there is some sort of circular reference
- // between the context and the session when it is
- // instantiated from a newly created WOContext.
- mailPage.session().terminate();
- }
- }
-
- /**
- *
- * Use this method to send an HTML mail, but default mail delivery.
- *
- * @param pageName
- * The name of the WOComponent that must be instantiated.
- * @param 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.
- * @param emailFrom
- * the email address the mail is sent from
- * @param emailTo
- * the email address the mail is sent to
- * @param emailReplyTo
- * the email address where the mail must be replied-to.
- * @param subject
- * the subject of the mail
- *
- *
- *
- * デフォルト配信インスタンスを使用し、 HTML メール送信を行います。
- *
- * @param pageName - HTMLメッセージを持つインスタンス化する WOComponent 名
- * @param alternatePageName - テキスト・メッセージを持つインスタンス化する WOComponent 名
- * @param emailFrom - 送信元のメール・アドレス
- * @param emailTo - 送信先のメール・アドレス
- * @param emailReplyTo - 返信先のメール・アドレス
- * @param subject - メールのサブジェクト
- *
- */
- public static void sendHTMLMail(String pageName, String alternatePageName, String emailFrom, String emailTo, String emailReplyTo, String subject) {
- sendHTMLMail(sharedDeliverer(), pageName, alternatePageName, emailFrom, emailTo, emailReplyTo, subject);
- }
-
- /**
- *
- * 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 {@link #instantiatePage(String, NSDictionary)} or
- * {@link er.extensions.appserver.ERXApplication#instantiatePage(String)}.)
- *
- * @param dict
- * a NSDictionary value containing the values we want to set in the session parameter.
- * @param session
- * a WOSession value that will receive the values contained in the dict parameter.
- *
- *
- *
- * このメソッドはディクショナリー内で見つかる値をセッション状態ディクショナリーにセットします。
- * このメソッドはカレント・セッションを新セッションに移行する時に有効です。
- * （たとえば、{@link #instantiatePage(String, NSDictionary)} や {@link er.extensions.appserver.ERXApplication#instantiatePage(String)}
- * でインスタンス化されているページを送信する場合に有効です。）
- *
- * @param dict - セッションに設定する情報を持つ NSDictionary
- * @param session - ディクショナリー内に設定されている値をセットする WOSession
- *
- */
- public static void setDictionaryValuesInSession(NSDictionary dict, WOSession session) {
- if ((dict == null) || (session == null)) {
- return;
- }
-
- Enumeration en = dict.keyEnumerator();
- while (en.hasMoreElements()) {
- String key = (String) en.nextElement();
- Object object = dict.objectForKey(key);
- if (object != null) {
- if (log.isDebugEnabled()) {
- log.debug("Setting in session dict value '" + object.toString() + "' for key '" + key + "'");
- }
-
- session.setObjectForKey(object, key);
- }
- }
- }
-
- /** エンコーディング処理 */
- public static String encodeString(String string, String charset) {
- String encodedString = null;
-
- try {
- encodedString = MimeUtility.encodeText(string, charset, !charset.equals(ERMailDelivery.DefaultCharset) ? "B" : null);
- }
- catch (Exception e) {
- encodedString = string;
- }
-
- return encodedString;
- }
-
- /**
- *
- * Method that converts NSArray of String emails to InternetAddress [].
- *
- * @param addrs
- * a NSArray value
- * @return an InternetAddress[] value
- * @exception AddressException
- * if an error occurs
- *
- *
- *
- * String メールの NSArray を InternetAddress [] へ変換します。
- *
- * @param addrs - NSArray
- *
- * @return InternetAddress[]
- *
- * @exception AddressException - エラー発生した場合
- *
- */
- public static InternetAddress[] convertNSArrayToInternetAddresses(NSArray addrs) throws AddressException {
- if (addrs == null)
- return new InternetAddress[0];
- InternetAddress[] addrArray = new InternetAddress[addrs.count()];
-
- Enumeration en = addrs.objectEnumerator();
- for (int i = 0; en.hasMoreElements(); i++) {
- String anAddress = (String) en.nextElement();
- addrArray[i] = new InternetAddress(anAddress);
- }
-
- return addrArray;
- }
-
- /**
- *
- * 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 [].
- *
- * @param addressesArray
- * an Address[] value
- * @return a NSArray value
- * @exception AddressException
- * if an error occurs
- *
- * 注意： Address [] 又は InternetAddress [] が有効です
- *
- * @param addressesArray - Address[]
- *
- * @return NSArray
- *
- * @exception AddressException - エラー発生した場合
- *
NSDictionary with email, personal name as key value pair
- * @param charset
- * a String of the charset to use for personal string
- * @return an InternetAddress[] value
- * @exception AddressException
- * if an error occurs
- *
- *
- *
- * String メールの NSDictionary を InternetAddress [] へ変換します。
- * キーが String メール・アドレスでオブジェクトが String の個人名
- *
- * @param addrs - NSDictionary メール 個人名の KV
- * @param charset - 個人名文字列に使用する文字セット
- *
- * @return InternetAddress[]
- *
- * @exception AddressException - エラー発生した場合
- *
- */
- public static InternetAddress[] convertNSDictionaryToInternetAddresses(NSDictionaryMessage.RecipientType.To, Message.RecipientType.CC, or
- * Message.RecipientType.BCC
- *
- *
- *
- * @param recipientType
- * Message.RecipientType.To、 Message.RecipientType.CC 又は
- * Message.RecipientType.BCC の中の一つ
- *
- */
- public Address[] recipients(Message.RecipientType recipientType) throws MessagingException {
- return _message == null ? null : _message.getRecipients(recipientType);
- }
-
- public String recipientsAsString(Message.RecipientType recipientType) throws MessagingException, AddressException {
- return recipientsAsString(recipientType, -1);
- }
-
- public String recipientsAsString(Message.RecipientType recipientType, int maxAddresses) throws MessagingException, AddressException {
- Address[] allAddresses = recipients(recipientType);
- Address[] limitteredAddresses = null;
-
- if (allAddresses == null || allAddresses.length == 0)
- return null;
-
- if (maxAddresses > 0) {
- limitteredAddresses = new Address[maxAddresses];
- System.arraycopy(allAddresses, 0, limitteredAddresses, 0, Math.min(allAddresses.length, maxAddresses));
- }
- else {
- limitteredAddresses = allAddresses;
- }
-
- StringBuilder result = new StringBuilder();
- result.append(ERMailUtils.convertInternetAddressesToNSArray(limitteredAddresses).componentsJoinedByString(", "));
- if (0 < maxAddresses && maxAddresses < allAddresses.length) {
- result.append(", and ");
- result.append(allAddresses.length - maxAddresses);
- result.append(" other recipients");
- }
- return result.toString();
- }
-
- public String allRecipientsAsString() throws MessagingException {
- return allRecipientsAsString(true, -1);
- }
-
- public String allRecipientsAsString(boolean includeBcc) throws MessagingException {
- return allRecipientsAsString(includeBcc, -1);
- }
-
- public String allRecipientsAsString(boolean includeBcc, int maxAddresses) throws MessagingException {
- StringBuilder recipients = new StringBuilder();
- String addresses = recipientsAsString(Message.RecipientType.TO, maxAddresses);
- if (addresses != null && addresses.length() > 0)
- recipients.append("To: ").append(addresses);
-
- addresses = recipientsAsString(Message.RecipientType.CC, maxAddresses);
- if (addresses != null && addresses.length() > 0)
- recipients.append("CC: ").append(addresses);
-
- if (includeBcc) {
- addresses = recipientsAsString(Message.RecipientType.BCC, maxAddresses);
- if (addresses != null && addresses.length() > 0)
- recipients.append("BCC: ").append(addresses);
- }
- return recipients.toString();
- }
-
- @Override
- public String toString() {
- StringBuilder sbuf = new StringBuilder();
- sbuf.append('<').append(getClass().getName()).append(' ');
- if (_message == null) {
- sbuf.append("No mime message is set.");
- }
- else {
- try {
- sbuf.append(allRecipientsAsString());
- }
- catch (MessagingException ex) {
- // do nothing
- }
- }
- sbuf.append('>');
- return sbuf.toString();
- }
-
- /**
- * Called by ERMailSender
- */
- public void _deliverySucceeded() {
- if (_delegate != null) {
- _delegate.deliverySucceeded(this);
- }
- }
-
- /**
- * Called by ERMailSender
- */
- public void _invalidRecipients(NSArray- * ERWOMailDelivery operates just the same as WOMailDelivery, and has all of the same limitations and weird API. - * However, instead of using the Sun's broken* and unsupported sun.net.smtp.SmtpClient, it uses JavaMail. - *
- * - *- * *sun.net.smtp.SmtpClient doesn't put addresses in angle brackets when sending the SMTP MAIL FROM command. Many - * SMTP servers won't work with it. - *
- * - * - * - * WOMailDelivery の替わりに使用します。 - * - *- * ERWOMailDelivery は WOMailDelivery と同じように動作します。全く同じ制限と不思議な API を持っています。 - * 正しい、Sun 社の壊れているサポートしない sun.net.smtp.SmtpClient と違って JavaMail を使用しています。 - *
- * - *- * *sun.net.smtp.SmtpClient は SMTP MAIL FROM で送信するアドレスを括弧で囲まないので、大抵の SMTP サーバは動作しないのです。 - *
- * - * - * @author Jonathan 'Wolf' Rentzsch (jon at redshed dot net) - * @see com.webobjects.appserver.WOMailDelivery - */ - -public class ERWOMailDelivery { - /** - * - * @return The shared instance. - * - * - * - * @return 共有インスタンス - * - */ - public static ERWOMailDelivery sharedInstance() { - if (_sharedInstance == null) - _sharedInstance = new ERWOMailDelivery(); - return _sharedInstance; - } - - /** - * Default constructor (don't use). Use {@link #sharedInstance()} instead. - * 未使用のコンストラクタ： {@link #sharedInstance()} を使用します。 - */ - protected ERWOMailDelivery() { - // Just here & protected so folks don't try to construct directly. - } - - /** - * - * Creates and optionally sends a plain text email. - * - * @param fromEmailAddress - * Originating email address. Required. - * @param toEmailAddresses - * Destination email address. Required. - * @param bccEmailAddresses - * Array of Strings containing additional addressed to BCC. Can be null. - * @param subject - * Subject the message. Can be null. - * @param message - * Body the the message. Required. - * @param sendNow - * Whether to send the message right away. If you're going to send the message right away, it's faster to - * set sendNow to true than set it to false and calling {@link #sendEmail(String)} later. - * - * - * - * 標準テキスト・メールを作成と送信します。 - * - * @param fromEmailAddress - 送信元メール・アドレス（必須） - * @param toEmailAddresses - 送信先メール・アドレス NSArray（必須） - * @param bccEmailAddresses - BCC メール・アドレス NSArray （Null可） - * @param subject - メール・サブジェクト（Null可） - * @param message - メッセージ（必須） - * @param sendNow - true ですぐに送信します。 - * すぐに送信時には false を設定し後で {@link #sendEmail(String)} で送信するよりも true の方が早い - * - */ - public String composePlainTextEmail(String fromEmailAddress, NSArray-These files are protected under the GNU Lesser Public License. -You should read and understand the terms of this license before using it. -The article 15 in the LICENSE read this: -
- -- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE -LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS -AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE -DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR -OR CORRECTION. -- - -
-This small framework is intended to send mails with the JavaMail API in conjunction to Apple WebObjects (http://www.apple.com/webobjects). You can also use it without WebObjects but some (very little) porting is needed. Two classes can't be used in this context: ERMailDeliveryWOComponentPlainText and ERMailDeliveryHTML. -
- --This framework merely consists of 5 files that you may add to your project or compile as a separate framework. Its originality comes from its ability to send mail with a separated thread. Most of JavaMail functionalities are not hidden so it's easy to write subclasses that extend the use of these classes. -
-When you need to send multiple mails you don't create multiple instances of ERMailDelivery subclasses, you just create one instance and call the newMail () method to create a new message, this is useful for memory / performances issues. -
-I created these classes because there was a bug in WOMailDelivery in deployment mode that I cannot solve. The other advantage is that the mails are sent within the process and JVM of the currently running application. -
- - --Copy and customize the properties given in SampleConfiguration.txt under 'Support' group in the project files. -
- -
-// Create an instance of an ERMailDelivery subclass
-ERMailDeliveryHTML mail = new ERMailDeliveryHTML ();
-
-// Here ERMailDeliveryHTML needs a WOComponent to render the HTML text content.
-mail.setComponent(mailPage);
-
-// Here you create a new instance of the message
-// You can loop over this fragment of code, not forgetting to use newMail ()
-// before you set the attributes of the message.
-try {
- mail.newMail();
- mail.setFromAddress(emailFrom);
- mail.setReplyToAddress(emailReplyTo);
- mail.setSubject(emailSubject);
- mail.setToAddresses(new NSArray (toEmailAddresses));
- // Send the mail. There is an optional sendMail(boolean) that optionally blocks during the send.
- mail.sendMail();
-} catch (Exception e) {
- // handle the exception ...
-}
--Be careful of the WOContext that contains the component you are sending. If you use -ERMailDeliveryHTML inside of the normal request-response loop with the default WOContext, -it is very likely that the next page that is sent to the user will be the emailed component -rather than the page you WANTED to send. There are several possible workarounds for this. -One is to return a specific component rather than null from your action method. I have -had better and more consistent success with the following code: -
- -- --WOContext context = (WOContext) context().clone(); -MyComponent component = (MyComponent) WOApplication.application().pageWithName(MyComponent.class.getName(), context); -ERMailDeliveryHTML mail = new ERMailDeliveryHTML(); -mail.setComponent(component); -... -
-This seems to properly isolate the email to a clone of the current context rather than the -actual active context. Your mileage may vary :) -
- --06/29/2005: - Added support for authenticated SMTP and updated the documentation. - -10/09/2002: - Made API more consistent with Project Wonder. - -09/19/2001: - Packaged the framework into a WebObjects 5 framework. - As long as ProjectBuilder for Mac OX X and ProjectBuilder for Windows are incompatible, - the project can't be used under Windows, unless it is compiled under another platform. - - OFMaildelivery.setToAddress now takes an NSArray as argument. java.util.Vector is no - longer used. -- - -
-Don't hesitate to send {postcards, feedback, love letters} to Camille Troillard <tuscland@mac.com> -
- - - diff --git a/Frameworks/Mail/ERJavaMail/Tests/er/javamail/ERMailSenderTest.java b/Frameworks/Mail/ERJavaMail/Tests/er/javamail/ERMailSenderTest.java deleted file mode 100644 index 5304b640cf6..00000000000 --- a/Frameworks/Mail/ERJavaMail/Tests/er/javamail/ERMailSenderTest.java +++ /dev/null @@ -1,187 +0,0 @@ -package er.javamail; - -import java.util.LinkedList; -import java.util.List; - -import javax.mail.Address; -import javax.mail.Message; -import javax.mail.MessagingException; -import javax.mail.Session; -import javax.mail.Transport; -import javax.mail.URLName; -import javax.mail.internet.AddressException; - -import junit.framework.TestCase; -import er.extensions.foundation.ERXProperties; - -public class ERMailSenderTest extends TestCase { - public List