okutani-t/nphpmailer

NPHPMailer is a PHPMailer wrapper class for easy use of Japanese

NPHPMAILER

PHPMailerを日本語で便利に使うラッパークラス, _(*1)

Description

NPHPMailerは、日本語メールをPHPMailerで送信する際に設定するべき「内部エンコーディング」や「文字コードの指定」を内部で設定してくれるラッパークラスです。また、チェーンメソッドを利用して送信できるので、コード量を少なくしてくれます。, _(*2)

Usage

以下の形でメールを送信する。, _(*3)

use OkutaniT\NPHPMailer;

NPHPMailer::_()
    #->setSMTP(ホスト, ユーザー, パスワード) // サーバーで設定していたら不要
    ->setFrom(差出人)
    ->addAddress(宛先)
    ->setSubject(件名)
    ->setBody(内容)
    ->send();

具体的には、次のように利用する。, _(*4)

use OkutaniT\NPHPMailer;

$from      = "from@example.com";
$to        = [
  "myaddress@example.com"
];
$reply     = $_POST["email"];

$mySubject = "お問い合わせがありました";
$myBody    = "名前: " . $_POST["name"] . "\n" .
"メールアドレス: " . $_POST["email"];
$toSubject =  "[自動返信]お問い合わせありがとうございます";
$toBody    =  "以下の内容でメールを送信しました。\n\n" .
"名前: " . $_POST["name"] . "\n" .
"メールアドレス: " . $_POST["email"] . "\n" .
"今後ともよろしくお願いいたします。";

// 自分宛
NPHPMailer::_()
  ->setSMTP("smtp.gmail.com", "〇〇@gmail.com", "Gmailのパスワード") # gmailの場合
  ->setFrom($from)
  ->addAddress($to)
  ->setSubject($mySubject)
  ->setBody($myBody)
  ->send();

// 相手宛(自動返信用)
NPHPMailer::_()
  ->setSMTP("smtp.gmail.com", "〇〇@gmail.com", "Gmailのパスワード")
  ->setFrom($from)
  ->addAddress($reply)
  ->setSubject($toSubject)
  ->setBody($toBody)
  ->send();

HTMLメール

HTMLメールを利用する場合は以下のメソッドを利用します。, _(*5)

->isHTML(true)

添付ファイル

添付ファイルは以下のメソッドを使います。, _(*6)

->addAttachment(ファイルパス, ファイル名, エンコーディング, MIMEタイプ)

CC, BCC

CC, BCCは以下。, _(*7)

->addCC(アドレス, 名前)
->addBCC(アドレス, 名前)

文字コード

文字コードを変更する場合は以下。デフォルトはUTF-8。, _(*8)

->setCharSet("ISO-8859-1")

エンコード

エンコードを変更する場合は以下。デフォルトはbase64。, _(*9)

->setEncoding("8bit")

SMTPデバッグモード

SMTPデバッグモードを利用したい場合は以下。, _(*10)

->setSMTPDebug(true)

Install

composerを使って導入する。ちなみに、NPHPMailer導入時に最新版のPHPMailerが導入されるので、PHPMailerの記述はいらない。, _(*11)

composer.jsonに以下を記述。, _(*12)

{
    "require": {
        "okutani-t/nphpmailer": "~1.0"
    }
}

composer installで導入。, _(*13)

$ composer install

あとは使いたい場所でrequire＆useしてあげればOK。, _(*14)

<?php
require __DIR__ . "/vendor/autoload.php";
use OkutaniT\NPHPMailer;

// code...

Contribution

バグを見つけた場合や追加実装をおこなう場合、以下の手順でプルリクエストを送ってください。, _(*15)

１. フォーク＆クローン, _(*16)

２. ブランチを切る, _(*17)

$ git checkout -b my-new-feature

３. 変更をコミット, _(*18)

$ git add .
$ git commit -m "修正内容"

４. テスト, _(*19)

$ composer test tests

なお、テスト内容は tests/ 以下に記述してください。, _(*20)

５. プルリクエストを作成, _(*21)

LICENCE

LGPL-2.1, _(*22)

Author

http://okutani.net, _(*23)