メール環境定義ファイル(jimmail.conf)
形式
Charset=メールの文字コード From=送信元メールアドレス DefaultTo=デフォルトの送信先メールアドレス[,デフォルトの送信先メールアドレス…] SmtpServer=SMTPサーバ名 SmtpPort=SMTPポート番号 AuthMethod=メール送信時の認証方式 SmtpAuthPort=SMTP-AUTH認証のサブミッションポート番号 Pop3Server=POP3サーバ名 Pop3Port=POP3ポート番号 AuthUser=認証アカウント名 AuthPassword=認証パスワード ConnectTimeout=ネットワーク接続タイムアウト時間 SoTimeout=通信タイムアウト時間 MailSubjectCutting=メール主題の切り捨て設定 MailNewLine=メールの改行コード
ファイル
jimmail.conf(メール環境定義ファイル)
jimmail.conf.model(メール環境定義ファイルのモデルファイル)
格納先ディレクトリ
- Windowsの場合
-
- 物理ホストのとき
-
Consoleパス\conf\mail
- 論理ホストのとき
-
共有フォルダ\JP1Cons\conf\mail
説明
メール環境定義ファイルは,メールサーバのホスト名や認証方式,認証アカウント名・パスワードなどメール送信に必要な情報を設定する定義ファイルです。
定義の反映時期
jimmailコマンドを実行したときに有効になります。
記述内容
メール環境定義ファイルには,次に示す規則があります。
-
設定項目の1行は「パラメーター名=設定値」形式で記述し,パラメーター名と設定値は,1行の最初の"="(0x3d)で区切ります。
-
改行は,「CR(0x0d)」「LF(0x0a)」です。「CRLF」以外の改行コードを含む場合,jimmailpasswdコマンドでパスワードを設定すると「CRLF」に統一して出力します。
-
パラメーター名は大文字・小文字を区別します。
-
先頭が「#(0x23)」または「△#」で始まる行は,コメント行になります。ただし,#の前に半角スペース(0x20)またはタブ(0x09)を除く文字がある場合は,コメント行として扱いません(△は半角スペースまたはタブ)。
-
半角スペースまたはタブの扱いは次のとおりです(△は半角スペースまたはタブ)。
-
パラメーター名の前後の半角スペースおよびタブは無視されます。
例)△パラメーター名△=設定値
-
設定値の前後の半角スペースおよびタブ文字は無視されます。ただし,AuthPasswordパラメーターの場合だけ,前後の半角スペースおよびタブ文字を無視しないで,文字として扱います。
例)パラメーター名=△設定値△
-
-
無効なパラメーターが記述してある場合,エラーとなります。また,パラメーター名の後ろに"="がない場合も,エラーとなります。
- Charset=メールの文字コード
-
送信するメールの件名と本文の文字コードを定義します。
文字コードは大文字・小文字を区別しません。
Charsetパラメーターの初期値と,Charsetパラメーターの値を取得できなかった場合の設定値を次の表に示します。
表2‒54 Charsetパラメーターの初期値と値を取得できなかった場合の設定値 初期値
値を取得できなかった場合の設定値
iso-2022-jp
iso-2022-jp
Charsetに指定できる文字コードを次の表に示します。
指定できない文字コードを定義した場合,上記表の値を取得できなかった場合の設定値として処理を行います。
表2‒55 Charsetに指定できる文字コード 文字コード
説明
iso-2022-jp
JISコード
shift_jis
シフトJISコード
euc-jp
EUCコード
utf-8
UTF-8コード
iso-8859-1
Latin1コード
us-ascii
ANSIコード
上記以外
指定できない。
パラメーターがない場合,パラメーターに値がない場合,またはパラメーターに指定できない文字コードが定義されている場合は,KAVB8715-Wのメッセージを出力して,初期値で処理を継続します。
- From=送信元メールアドレス
-
通知メールの送信元メールアドレスを定義します。
初期値は,空文字("")です。
送信元メールアドレスは,1件だけ定義できます。
この項目は,省略できません。
送信元メールアドレスは,1〜256バイトの範囲で指定してください。
使用できる文字は,次の表に示す文字です。
表2‒56 Fromで使用できる文字コード 使用できる文字
説明
半角英数字
0-9,a-z
@
アットマーク(0x40)
.
ピリオド(0x2e)
-
ハイフン(0x2d)
_
アンダーバー(0x5f)
必須パラメーターがない場合,パラメーターに値がない場合,パラメーターに使用できない文字が定義されている場合,パラメーターがRFC822フォーマットではない場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
- DefaultTo=デフォルトの送信先メールアドレス[,デフォルトの送信先メールアドレス…]
-
デフォルトの送信先メールアドレスを定義します。
初期値は,空文字("")です。
送信先メールアドレスは,20件定義できます。複数のメールアドレスを指定する場合は,「,(コンマ)」でアドレスを区切って指定してください。
メールアドレスと「,(コンマ)」の間の半角スペース,タブは無視されます。
連続した「,(コンマ)」は一つの「,(コンマ)」と見なし,先頭と末尾の「,(コンマ)」は無視されます。同じメールアドレスを複数指定した場合,指定したアドレスにはメールを1件だけ送信します。
このパラメーターは省略できます。省略した場合,jimmailコマンドの-toオプションは必ず指定してください。
DefaultToパラメーターとjimmailコマンドの-toオプションどちらも指定されている場合,-toオプションが優先されます。
送信先メールアドレスは,1〜256バイトの範囲で指定してください。
使用できる文字は,送信元メールアドレスと同じです。
使用できない文字が指定されている場合,パラメーターがRFC822フォーマットではない場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
また,DefaultToパラメーターとjimmailコマンドの-toオプションどちらも指定がない場合は,KAVB8712-Eのメッセージを出力して,異常終了します。
- SmtpServer=SMTPサーバ名
-
メール送信時に接続するSMTPサーバのホスト名またはIPアドレスを定義します。IPアドレスは,IPv4アドレスだけを指定できます。IPv6アドレスは指定できません。
SmtpServerパラメーターの初期値は,空文字("")です。
SMTPサーバ名は,システムで一つだけ指定します。
また,このパラメーターは省略できません。
ホスト名を指定する場合,1〜255バイトの半角文字で指定してください。
必須パラメーターがない場合,パラメーターに値がない場合,パラメーターに使用できない文字が定義されている場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
- SmtpPort=SMTPポート番号
-
SMTPサーバの通信ポートのポート番号を定義します。
SmtpPortパラメーターの初期値は25です。値を取得できなかった場合,25を仮定します。ポート番号は,1〜65535の範囲で指定してください。
AuthMethodで「NONE」または「POP」を定義した場合,この項目は有効になります。
パラメーターがない場合,パラメーターに値がない場合,パラメーターに数値でない文字列が指定されている場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
- AuthMethod=メール送信時の認証方法
-
メール送信時の認証方式を定義します。
このパラメーターは,省略できません。
認証方式は,次の表に示す値で定義します。初期値は「NONE」です。
表2‒57 AuthMethodの認証方式 AuthMethodの値
認証方式
NONE
認証なし
POP
POP before SMTP認証
SMTP
SMTP-AUTH認証
メール送信時の認証方式によって,メール環境定義ファイルの設定の必須・任意項目が変わります。
必須パラメーターがない場合,パラメーターに値がない場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
AuthMethodの値ごとの設定項目の一覧を次に示します。
表2‒58 AuthMethodがNONEのときの設定項目 パラメーター名
設定要否
省略
省略時の値
Charset
○
省略可能
iso-2022-jp
From
○
必須
−
DefaultTo
○
省略可能
""
AuthMethod
○
必須
−
SmtpServer
○
必須
−
SmtpPort
○
省略可能
25
SmtpAuthPort
×
−
−
Pop3Server
×
−
−
Pop3Port
×
−
−
AuthUser
×
−
−
AuthPassword
×
−
−
ConnectTimeout
○
省略可能
10,000
SoTimeout
○
省略可能
10,000
MailSubjectCutting
○
省略可能
OFF
MailNewLine
○
省略可能
CRLF
- (凡例)
-
○:設定の必要あり
×:設定の必要なし
表2‒59 AuthMethodがPOPのときの設定項目 パラメーター名
設定要否
省略
省略時の値
Charset
○
省略可能
iso-2022-jp
From
○
必須
−
DefaultTo
○
省略可能
""
AuthMethod
○
必須
−
SmtpServer
○
必須
−
SmtpPort
○
省略可能
25
SmtpAuthPort
×
−
−
Pop3Server
○
必須
−
Pop3Port
○
省略可能
110
AuthUser
○
必須
−
AuthPassword
○
必須
−
ConnectTimeout
○
省略可能
10,000
SoTimeout
○
省略可能
10,000
MailSubjectCutting
○
省略可能
OFF
MailNewLine
○
省略可能
CRLF
- (凡例)
-
○:設定の必要あり
×:設定の必要なし
表2‒60 AuthMethodがSMTPのときの設定項目 パラメーター名
設定要否
省略
省略時の値
Charset
○
省略可能
iso-2022-jp
From
○
必須
−
DefaultTo
○
省略可能
""
AuthMethod
○
必須
−
SmtpServer
○
必須
−
SmtpPort
×
−
−
SmtpAuthPort
○
必須
587
Pop3Server
×
−
−
Pop3Port
×
−
−
AuthUser
○
必須
−
AuthPassword
○
必須
−
ConnectTimeout
○
省略可能
10,000
SoTimeout
○
省略可能
10,000
MailSubjectCutting
○
省略可能
OFF
MailNewLine
○
省略可能
CRLF
- (凡例)
-
○:設定の必要あり
×:設定の必要なし
- SmtpAuthPort=SMTP-AUTH認証のサブミッションポート番号
-
SMTP-AUTH認証用の通信ポートのサブミッションポート番号を定義します。初期値は587です。値を取得できなかった場合,587を仮定します。ポート番号は,1〜65535の範囲で指定してください。
SMTP-AUTH認証を使用する場合,接続メールサーバがサブミッションポートを使用しないときは,SmtpAuthPortパラメーターには,接続するSMTPサーバが使用する宛先ポート番号を指定してください。
AuthMethodで「SMTP」を定義した場合,この項目は有効になります。
パラメーターがない場合,パラメーターに値がない場合,パラメーターに数値でない文字列が指定されている場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
- Pop3Server=POP3サーバ名
-
POP before SMTP認証で使用するPOP3サーバのホスト名またはIPアドレスを定義します。IPアドレスは,IPv4アドレスを指定できます。IPv6アドレスは指定できません。
メールサーバがSMTPサーバとPOP3サーバを兼ねている場合,SmtpServerに指定したSMTPサーバ名を指定してください。
POP3サーバ名は,システムで一つだけ指定してください。
POP3サーバのホスト名を指定する場合,1〜255バイトの半角文字で指定します。初期値は,空文字("")です。POP3サーバのホスト名に使用できる文字は,SMTPサーバのホスト名に使用できる文字と同じです。
AuthMethodで「POP」を定義した場合,この項目は有効になります。有効の場合,このパラメーターの指定は必須です。
必須パラメーターがない場合,パラメーターに値がない場合,パラメーターに使用できない文字が定義されている場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
- Pop3Port=POP3ポート番号
-
POP before SMTP認証で使用するPOP3サーバの通信ポートのポート番号を定義します。
パラメーターの初期値は110です。値を取得できなかった場合,110を仮定します。ポート番号は,1〜65535の範囲で指定してください。
AuthMethodで「POP」を定義した場合,この項目は有効になります。
パラメーターがない場合,パラメーターに値がない場合,パラメーターに数値でない文字列が指定されている場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
- AuthUser=認証アカウント名
-
AuthUserパラメーターでは,POP before SMTP認証またはSMTP-AUTH認証で使用する認証アカウント名を定義します。
認証アカウント名は,1〜255バイトの半角文字で指定します。
初期値は空文字("")です。
AuthMethodパラメーターに「POP」または「SMTP」を指定した場合,この項目は有効になります。
必須パラメーターがない場合,パラメーターに値がない場合,パラメーターに使用できない文字(マルチバイト)が定義されている場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
- AuthPassword=認証パスワード
-
AuthPasswordパラメーターでは,POP before SMTP認証またはSMTP-AUTH認証の認証パスワードが設定されます。
AuthPasswordパラメーターの認証パスワードはjimmailpasswdコマンドで設定します。
メール環境定義ファイルを直接編集してAuthPasswordパラメーターに平文のパスワードを設定した場合,メールサーバ接続時に認証パスワードが一致しないため,メールサーバにログインできません。
AuthMethodパラメーターに「POP」または「SMTP」を指定した場合,この項目は有効になります。
必須パラメーターがない場合,パラメーターに値がない場合,パラメーターに使用できない文字(マルチバイト)が指定されている場合,またはパラメーターが最大長を超えている場合は,KAVB8714-Eのメッセージを出力して,異常終了します。
- ConnectTimeout=ネットワーク接続タイムアウト時間
-
ConnectTimeoutパラメーターには,SMTPとPOP3サーバとの接続完了を待つタイムアウト時間をミリ秒単位で定義します。初期値は10,000ミリ秒(10秒)です。
タイムアウト時間は1,000〜3,600,000(1〜3,600秒)の範囲で指定します。
初期値で接続タイムアウトが発生する場合だけ,運用環境に合わせて変更してください。
パラメーターがない場合,パラメーターに値がない場合,パラメーターに数値でない文字列が指定されている場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
- SoTimeout=通信タイムアウト時間
-
SoTimeoutパラメーターには,SMTPとPOP3サーバからの応答を受信するまでのタイムアウト時間をミリ秒単位で定義します。初期値は10,000ミリ秒(10秒)です。
タイムアウト時間は1,000〜3,600,000(1〜3,600秒)の範囲で指定します。
初期値で通信タイムアウトのエラーが発生する場合だけ,運用環境に合わせて変更してください。
パラメーターがない場合,パラメーターに値がない場合,パラメーターに数値でない文字列が指定されている場合,またはパラメーターに範囲外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
- MailSubjectCutting=メール主題の切り捨て設定
-
MailSubjectCuttingパラメーターには,メール送信時にメール主題が最大長を超えていた場合にメールの主題を切り捨てて強制的に送信を行うかを定義します。
-
「OFF」の場合は,メールの主題は切り捨てないで,jimmailコマンドが異常終了します。
-
「ON」の場合は,メールの主題をCharsetパラメーターで指定したメールの文字コードに従い512バイト以内になるように切り捨てて,メール送信を継続します。
初期値は,「OFF」です。設定値は大文字・小文字の区別はしません。
パラメーターがない場合,パラメーターに値がない場合,またはパラメーターに「ON」「OFF」以外の値が指定されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
-
- MailNewLine=メール本文の改行コード
-
MailNewLineパラメーターには,メール本文で使用する改行コードを定義します。jimmailコマンドは,コマンドのオプション引数で指定した改行文字「\n」を,このパラメーターで指定した改行コードに置き換えてメール送信します。初期値は,「CRLF」です。
設定値は,大文字・小文字を区別しません。
RFCでメールの改行コードは「CRLF」と規定されていて,理由がないかぎり初期値から変更しないでください。メールサーバによっては,「CRLF」以外の改行コードを使用した場合,メール送信に失敗したり,メールの改行が行われなかったりなどの問題が発生するおそれがあります。
改行コードは,次の表に示す値で定義します。
表2‒61 MailNewLineの設定値 設定値
説明
CRLF
CR(0x0d)+LF(0x0A)
LF
LF(0x0A)
CR
CR(0x0d)
パラメーターがない場合,パラメーターに値がない場合,またはパラメーターに範囲外の値が定義されている場合は,KAVB8715-Wのメッセージが出力され,初期値で処理を継続します。
定義例
インストール直後のメール環境定義ファイルを下に示します。
Charset=iso-2022-jp From= DefaultTo= SmtpServer= SmtpPort=25 AuthMethod=NONE SmtpAuthPort=587 Pop3Server= Pop3Port=110 AuthUser= AuthPassword= ConnectTimeout=10000 SoTimeout=10000 MailSubjectCutting=OFF MailNewLine=CRLF