設定ファイルの記述方法(v2)

tagawa edited this page Jan 17, 2018 · 8 revisions

ここでは YAML 形式の場合の設定ファイルの記述方法についてご紹介します。 YAML 形式以外の設定ファイルの記述方法はサンプルファイル( config/config.xxx.sample )を参考に記述をしてください。

また、 config.yml 以外の設定ファイルを利用する場合は、 index.php12 行目 を適宜修正してください。

送信先メールアドレス

to_email: info@example.com

複数の宛先に送信する場合、 to_email: info@example.com,test@example.com と記述します。複数の宛先を設定する場合は、 auto_reply_from_email と場合によっては return_path に、 1 つの、 auto_reply_from_emailreturn_path で同じメールアドレスを設定してください。

送信メールの件名

to_subject: [株式会社テスト]お問い合わせ

自動返信メール機能の利用

auto_reply: true
  • true => 自動返信メール機能を有効にする
  • false => 自動返信メール機能を無効にする

自動返信メールの宛先

auto_reply_email: メールアドレス

上記の場合、入力画面の <input type="text" name="メールアドレス"> の value 宛に送信されます。

自動返信メールの件名

auto_reply_subject: [株式会社テスト]お問い合わせありがとうございます

空の場合は「送信メールの件名」が設定されます。

自動返信メールの送信元メールアドレス

auto_reply_from_email: no-reply@example.com

空の場合は「送信先メールアドレス」が設定されます。

「システム上のメール送信元」と「自動返信メールの送信元」(返信先)を分けたい場合などにご利用ください。

チェックモードの利用

checkmode: 2
  • 0 => チェックモードを無効にする
  • 1 => 簡易チェックモードを有効にする
  • 2 => 詳細チェックモードを有効にする

http://{TransmitMail設置ディレクトリ}/index.php?checkmode にアクセスするとチェックモードが表示されます。セキュリティ上、チェックモードを表示したくない場合は 0 にしてください。

ファイル添付機能の利用

file: true
  • true => ファイル添付機能を有効にする
  • false => ファイル添付機能を無効にする

ファイル添付を許可する拡張子

file_allow_extension: gif,jpg,jpeg,png

カンマ区切りで複数の拡張子を設定可能です。

  • 例1: 画像 -> gif,jpg,jpeg,png
  • 例2: Office系 -> doc,docx,xls,xlsx,ppt,pptx

ファイル添付の1ファイルの上限サイズ(Byte)

file_max_size: 512000
  • 例: 512000Bytes = 500KB

添付ファイルのファイル保存期間(秒)

file_retention_period: 1800

上記で設定した期間を過ぎると、一時保存ファイルにアクセスできなくなります。

  • 例: 30分 = 1800秒

CSV出力機能の利用

csv_output: false
  • true => CSV出力機能を有効にする
  • false => CSV出力機能を無効にする

アクセス拒否ホスト設定

deny_host: ^192.168.1.*

アクセスを拒否したいホスト名またはIPアドレスを正規表現で記述します。

  • 例1: 前方一致は先頭に ^ をつける -> ^192.168.1.*
  • 例2: 後方一致は末尾に $ をつける -> *.example.com$
  • 例3: 上記両方を設定する場合 -> ^192.168.1.*|*.example.com$

外部 SMTP サーバーの利用

# 外部 SMTP サーバーの利用
# true => yes, false => no
smtp: true

# 外部 SMTP サーバーのホスト名
# Gmailの場合: ssl://smtp.gmail.com もしくは tls://smtp.gmail. com
smtp_host: ssl://smtp.gmail.com

# 外部 SMTP サーバーのポート番号
# Gmailの場合: 465
smtp_port: 465

# 外部 SMTP サーバーに接続するプロトコル(SMTP_AUTH, POP_BEFORE, SMTP)
# Gmailの場合: SMTP_AUTH
smtp_protocol: SMTP_AUTH

# 外部 SMTP サーバーに接続するユーザー名
# Gmailの場合: username@gmail.com
smtp_user: username@gmail.com

# 外部SMTPに接続するパスワード
smtp_password: password

その他設定情報

上記に紹介した以外にも設定を変更可能な項目があります。

詳しくは lib/TransmitMail.php68 行目 付近をご確認ください。

YAML 記法についての補足

利用できない文字について

ハードタブ

インデントにハードタブ(タブ文字)は使用できません。ソフトタブ(半角スペース)を利用してください。

特殊文字

{}[] は YAML の記法で利用される特殊な文字のため、設定値として利用したい場合はシングルクオート、またはダブルクオートで囲んでください。

auto_reply_subject: '[株式会社テスト] お問い合わせありがとうございます'

参考

YAML 記法の正誤チェック

YAML 記法の正誤チェックには YAMLlint が便利です。

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.