openGionopenGion
5.6.3.0

org.opengion.hayabusa.taglib
クラス MailSenderTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 javax.servlet.jsp.tagext.BodyTagSupport
          上位を拡張 org.opengion.hayabusa.taglib.CommonTagSupport
              上位を拡張 org.opengion.hayabusa.taglib.MailSenderTag
すべての実装されたインタフェース:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class MailSenderTag
extends CommonTagSupport

メールを送信するための簡易タグです。 Body 部に、メッセージを記述します。

関連項目:
直列化された形式
形式サンプル:
 ●形式:<og:mailSender from="…" to="…" subject="・・・"/>
 ●body:あり

 ●Tag定義:
   <og:mailSender
       subject            【TAG】タイトルを指定します
       from               【TAG】送信元(FROM)アドレスを指定します
       to                 【TAG】送信先(TO)アドレスをCSV形式で指定します
       cc                 【TAG】送信先(CC)アドレスをCSV形式で指定します
       bcc                【TAG】送信先(BCC)アドレスをCSV形式で指定します
       replyTo            【TAG】返信先(replyTo)アドレスをCSV形式で指定します
       host               【TAG】メールサーバーを指定します (初期値:COMMON_MAIL_SERVER[=])
       charset            【TAG】文字エンコーディングを指定します (初期値:MAIL_DEFAULT_CHARSET[=ISO-2022-JP])
       fileURL            【TAG】添付ファイルのセーブディレクトリを指定します (初期値:FILE_URL[=filetemp/])
       filename           【TAG】添付ファイル名をCSV形式で指定します
       useLDAP            【TAG】メールアドレスをLDAPを利用して取得するかどうか[true/false]を指定します(初期値:false)
       ldapKey            【TAG】アドレスを検索するキーを指定します(初期値:uid C社員番号)
       ldapVals           【TAG】LDAP検索時の属性名を指定します(初期値:cn,mail)
       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
   >   ... Body ...
   </og:mailSender>

 ●使用例
     <og:mailSender from="C00000" to="C99999" subject="{@SUBJECT}" >
          メール内容
     </og:mailSender >

        charset   = キャラクタセット  (例:Windows-31J , ISO-2022-JP)
        from      = From       送信元
        to        = To         送信先(複数登録可能)
        cc        = Cc         送信先(複数登録可能)
        bcc       = Bcc        送信先(複数登録可能)
        replyTo   = ReplyTo    返信先先(複数登録可能)
        useLDAP   = false/true メールアドレスをLDAPを利用して取得するかどうか
        ldapKey   = "uid"      アドレスを検索するキー(初期値:uid C社員番号)
        ldapVals  = "cn,mail"  LDAP検索時の属性名。ひとつならアドレス。2つなら名前とアドレス
        host      = SMTPサーバー名
        subject   = タイトル
        fileURL   = 添付ファイルのセーブディレクトリ
        filename  = 添付ファイル名(ローカルにセーブされたファイル名)(複数登録可能)
        debug     = true/false;

 複数登録可能な個所は、カンマ区切りで、複数登録できます。
 アドレス(from,to,cc,bcc,replyTo)は、『"名称" <メールアドレス>』形式が
 指定できます。< と > で囲まれた範囲がメールアドレスになります。
 名称には、漢字が使用できます。

 host は、システムパラメータ の COMMON_MAIL_SERVER 属性が初期値で設定されます。
 charset は、システムパラメータ の MAIL_DEFAULT_CHARSET 属性が初期値で設定されます。
機能階層
その他出力
バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
 
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたフィールド
bodyContent
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
id, pageContext
 
インタフェース javax.servlet.jsp.tagext.BodyTag から継承されたフィールド
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
EVAL_BODY_AGAIN
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
コンストラクタの概要
MailSenderTag()
           
 
メソッドの概要
 int doAfterBody()
          Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
 int doEndTag()
          Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
 int doStartTag()
          Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
protected  void release2()
          タグリブオブジェクトをリリースします。
 void setBcc(java.lang.String bccAdrs)
          【TAG】送信先(BCC)アドレスをCSV形式で指定します。
 void setCc(java.lang.String ccAdrs)
          【TAG】送信先(CC)アドレスをCSV形式で指定します。
 void setCharset(java.lang.String chset)
          【TAG】文字エンコーディングを指定します (初期値:MAIL_DEFAULT_CHARSET[=ISO-2022-JP])。
 void setFilename(java.lang.String fname)
          【TAG】添付ファイル名をCSV形式で指定します。
 void setFileURL(java.lang.String url)
          【TAG】添付ファイルのセーブディレクトリを指定します (初期値:FILE_URL[=filetemp/])。
 void setFrom(java.lang.String fromAdrs)
          【TAG】送信元(FROM)アドレスを指定します。
 void setHost(java.lang.String hst)
          【TAG】メールサーバーを指定します (初期値:COMMON_MAIL_SERVER[=])。
 void setLdapKey(java.lang.String ldapKey)
          【TAG】アドレスを検索するキーを指定します(初期値:uid C社員番号)。
 void setLdapVals(java.lang.String ldapVals)
          【TAG】LDAP検索時の属性名を指定します(初期値:cn,mail)。
 void setReplyTo(java.lang.String replyToAdrs)
          【TAG】返信先(replyTo)アドレスをCSV形式で指定します。
 void setSubject(java.lang.String subjct)
          【TAG】タイトルを指定します。
 void setTo(java.lang.String toAdrs)
          【TAG】送信先(TO)アドレスをCSV形式で指定します。
 void setUseLDAP(java.lang.String useLDAP)
          【TAG】メールアドレスをLDAPを利用して取得するかどうか[true/false]を指定します(初期値:false)。
 java.lang.String toString()
          このオブジェクトの文字列表現を返します。
 
クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck
 
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたメソッド
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたメソッド
getParent, setPageContext, setParent
 

コンストラクタの詳細

MailSenderTag

public MailSenderTag()
メソッドの詳細

doStartTag

public int doStartTag()
Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doStartTag
オーバーライド:
クラス CommonTagSupport 内の doStartTag
戻り値:
後続処理の指示( EVAL_BODY_BUFFERED )

doAfterBody

public int doAfterBody()
Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。

定義:
インタフェース javax.servlet.jsp.tagext.IterationTag 内の doAfterBody
オーバーライド:
クラス CommonTagSupport 内の doAfterBody
戻り値:
後続処理の指示(SKIP_BODY)
変更履歴:
3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。

doEndTag

public int doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doEndTag
オーバーライド:
クラス CommonTagSupport 内の doEndTag
戻り値:
後続処理の指示
変更履歴:
3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
3.7.1.0 (2005/04/15) LDAP検索 新規追加

release2

protected void release2()
タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。

オーバーライド:
クラス CommonTagSupport 内の release2
変更履歴:
2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
3.7.1.0 (2005/04/15) LDAP検索 useLDAP,ldapKey,ldapVals 属性追加

setFrom

public void setFrom(java.lang.String fromAdrs)
【TAG】送信元(FROM)アドレスを指定します。

パラメータ:
fromAdrs - 送信元(FROM)アドレス
説明:
 送信元(FROM)アドレスを指定します。

setTo

public void setTo(java.lang.String toAdrs)
【TAG】送信先(TO)アドレスをCSV形式で指定します。

パラメータ:
toAdrs - 送信先(TO)アドレス(CSV形式)
説明:
 複数アドレスをカンマ区切りでセットできます。
変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得
3.5.6.4 (2004/07/16) 先にリクエスト変数の値を取得してから配列に分解

setCc

public void setCc(java.lang.String ccAdrs)
【TAG】送信先(CC)アドレスをCSV形式で指定します。

パラメータ:
ccAdrs - 送信先(CC)アドレス(CSV形式)
説明:
 複数アドレスをカンマ区切りでセットできます。
変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得
3.5.6.4 (2004/07/16) 先にリクエスト変数の値を取得してから配列に分解

setBcc

public void setBcc(java.lang.String bccAdrs)
【TAG】送信先(BCC)アドレスをCSV形式で指定します。

パラメータ:
bccAdrs - 送信先(BCC)アドレス(CSV形式)
説明:
 複数アドレスをカンマ区切りでセットできます。
変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得
3.5.6.4 (2004/07/16) 先にリクエスト変数の値を取得してから配列に分解

setReplyTo

public void setReplyTo(java.lang.String replyToAdrs)
【TAG】返信先(replyTo)アドレスをCSV形式で指定します。

パラメータ:
replyToAdrs - 返信先(replyTo)アドレス(CSV形式)
説明:
 複数アドレスをカンマ区切りでセットできます。
変更履歴:
3.5.6.6 (2004/08/23) 新規追加

setHost

public void setHost(java.lang.String hst)
【TAG】メールサーバーを指定します (初期値:COMMON_MAIL_SERVER[=])。

パラメータ:
hst - メールサーバー
関連項目:
SystemData.COMMON_MAIL_SERVER
説明:
 メールサーバーを指定します。
 (初期値:システム定数のCOMMON_MAIL_SERVER[={@og.value org.opengion.hayabusa.common.SystemData#COMMON_MAIL_SERVER}])。
変更履歴:
3.5.6.6 (2004/08/23) 初期値を考慮するように変更。

setSubject

public void setSubject(java.lang.String subjct)
【TAG】タイトルを指定します。

パラメータ:
subjct - タイトル
説明:
 タイトルを指定します。

setFilename

public void setFilename(java.lang.String fname)
【TAG】添付ファイル名をCSV形式で指定します。

パラメータ:
fname - 添付ファイル名(CSV形式)
説明:
 複数ファイルをセットできます。
 設定方法は、カンマで区切って並べ複数指定できます。
変更履歴:
3.5.6.6 (2004/08/23) 複数ファイル指定方法を、重複リクエストからカンマ区切りに変更

setCharset

public void setCharset(java.lang.String chset)
【TAG】文字エンコーディングを指定します (初期値:MAIL_DEFAULT_CHARSET[=ISO-2022-JP])。

パラメータ:
chset - 文字エンコーディング
関連項目:
SystemData.MAIL_DEFAULT_CHARSET
説明:
 文字エンコーディングは、メール本文に対するエンコーディング指定です。
 これは、Windows-31J 、MS932、Shift_JIS のどれかが指定された場合、
 『指定の文字コード + 8bit 送信』します。
 それ以外の指定は、『ISO-2022-JP に独自変換 + 7bit 送信』になります。
 (初期値:システム定数のMAIL_DEFAULT_CHARSET[={@og.value org.opengion.hayabusa.common.SystemData#MAIL_DEFAULT_CHARSET}])。

setFileURL

public void setFileURL(java.lang.String url)
【TAG】添付ファイルのセーブディレクトリを指定します (初期値:FILE_URL[=filetemp/])。

パラメータ:
url - 添付ファイルのセーブディレクトリ
関連項目:
SystemData.FILE_URL
説明:
 この属性で指定されるディレクトリに、添付ファイルが存在すると仮定します。
 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
 さらに、各個人ID別のフォルダを作成して、そこを使用します。
 (初期値:システム定数のFILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。
変更履歴:
4.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。

setUseLDAP

public void setUseLDAP(java.lang.String useLDAP)
【TAG】メールアドレスをLDAPを利用して取得するかどうか[true/false]を指定します(初期値:false)。

パラメータ:
useLDAP - メールアドレスをLDAPを利用して取得するかどうか [true:取得する/false:取得しない]
説明:
 LDAP のメールアドレスを取得する場合は、true をセットします。false の場合は、
 from,to,cc,bcc,replyTo の設定値がそのまま使用されます。
 上記アドレスに、@ を含む場合は、LDAP を検索せず、メールアドレスとして
 そのまま使用します。LDAP の検索結果が存在しない場合は、不正なアドレスとして、
 エラーとします。
 初期値は、false です。
変更履歴:
3.7.1.0 (2005/04/15) LDAP検索 新規追加

setLdapKey

public void setLdapKey(java.lang.String ldapKey)
【TAG】アドレスを検索するキーを指定します(初期値:uid C社員番号)。

パラメータ:
ldapKey - アドレスを検索するキー
説明:
 LDAP のメールアドレスを取得する場合の、検索するキーを指定します。
 from,to,cc,bcc,replyTo の設定値を、このキーにセットして、検索します。
 uid C社員番号 、employeeNumber 社員番号 などが考えられます。
 初期値は、uid(C社員番号)です。
 このキーで複数の検索結果が得られた場合は、エラーとします。
変更履歴:
3.7.1.0 (2005/04/15) LDAP検索 新規追加

setLdapVals

public void setLdapVals(java.lang.String ldapVals)
【TAG】LDAP検索時の属性名を指定します(初期値:cn,mail)。

パラメータ:
ldapVals - LDAP検索時の属性名
説明:
 LDAPを検索する場合、"担当者名"<メールアドレス>形式のメールアドレスを作成する
 場合、検索する属性値を指定します。
 ひとつならアドレス。2つなら名前とアドレスの順で指定されたと認識します。
変更履歴:
3.7.1.0 (2005/04/15) LDAP検索 新規追加

toString

public java.lang.String toString()
このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。

オーバーライド:
クラス CommonTagSupport 内の toString
戻り値:
このクラスの文字列表現

openGion 5.6.3.0

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.