【PHP8.x】CURLOPT_MAIL_AUTH定数の使い方

Copy
1<?php
2
3/**
4 * cURL を使用して SMTP サーバー経由でメールを送信するサンプル関数。
5 *
6 * この関数は CURLOPT_MAIL_AUTH 定数と CURLOPT_USERPWD オプションの具体的な使用例を示します。
7 * 実際のメール送信には、有効な SMTP サーバー情報と認証情報が必要です。
8 *
9 * @param string $smtpHost   SMTP サーバーのホスト名 (例: 'smtp.example.com')
10 * @param int    $smtpPort   SMTP サーバーのポート番号 (例: 587 for TLS, 465 for SMTPS)
11 * @param string $username   SMTP 認証に使用するユーザー名
12 * @param string $password   SMTP 認証に使用するパスワード
13 * @param string $fromEmail  送信元メールアドレス
14 * @param string $toEmail    送信先メールアドレス
15 * @param string $subject    メールの件名
16 * @param string $body       メールの本文
17 * @return bool              メール送信が成功した場合は true、失敗した場合は false
18 */
19function sendEmailViaSmtpWithCurl(
20    string $smtpHost,
21    int $smtpPort,
22    string $username,
23    string $password,
24    string $fromEmail,
25    string $toEmail,
26    string $subject,
27    string $body
28): bool {
29    // メールヘッダーと本文を結合して RFC 形式のメッセージを作成
30    $message = "From: {$fromEmail}\r\n"
31             . "To: {$toEmail}\r\n"
32             . "Subject: {$subject}\r\n"
33             . "MIME-Version: 1.0\r\n"
34             . "Content-Type: text/plain; charset=UTF-8\r\n"
35             . "Content-Transfer-Encoding: 8bit\r\n"
36             . "\r\n" // ヘッダーと本文の間の空行
37             . $body;
38
39    // メールコンテンツを一時的なストリームに書き込む
40    // cURL はこのストリームからメール本文を読み取ります。
41    $stream = fopen('php://temp', 'r+');
42    if ($stream === false) {
43        echo "エラー: 一時ストリームを作成できませんでした。\n";
44        return false;
45    }
46    fwrite($stream, $message);
47    rewind($stream); // ストリームのポインタを先頭に戻す
48
49    $curl = curl_init();
50
51    if ($curl === false) {
52        echo "エラー: cURL セッションを初期化できませんでした。\n";
53        fclose($stream);
54        return false;
55    }
56
57    // SMTP サーバーの URL を設定
58    // ポートに応じて適切なプロトコル (smtps:// for 465, smtp:// for 587) を選択します。
59    $protocol = ($smtpPort === 465) ? 'smtps://' : 'smtp://';
60    curl_setopt($curl, CURLOPT_URL, $protocol . $smtpHost . ':' . $smtpPort);
61
62    // 送信元と送信先のメールアドレスを設定
63    curl_setopt($curl, CURLOPT_MAIL_FROM, '<' . $fromEmail . '>');
64    curl_setopt($curl, CURLOPT_MAIL_RCPT, ['<' . $toEmail . '>']);
65
66    // cURL にメールコンテンツをアップロードするように指示します。
67    // SMTP では、メール本文をサーバーに「アップロード」する形になります。
68    curl_setopt($curl, CURLOPT_UPLOAD, true);
69    // アップロードするデータを含むストリームと、そのバイトサイズを指定します。
70    curl_setopt($curl, CURLOPT_INFILE, $stream);
71    curl_setopt($curl, CURLOPT_INFILESIZE, strlen($message));
72
73    // SMTP 認証のユーザー名とパスワードを設定します。
74    // キーワード: CURLOPT_USERPWD
75    // このオプションは、HTTP や SMTP の認証で使用され、"ユーザー名:パスワード" の形式で指定します。
76    curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password);
77
78    // SMTP 認証のタイプを指定します。
79    // リファレンス情報: CURLOPT_MAIL_AUTH
80    // 一般的には 'LOGIN' や 'PLAIN' が使用されますが、SMTP サーバーがサポートする認証タイプに合わせる必要があります。
81    curl_setopt($curl, CURLOPT_MAIL_AUTH, 'LOGIN'); 
82
83    // ポート 587 の場合、STARTTLS を有効にして暗号化接続を開始します。
84    if ($smtpPort === 587) {
85        curl_setopt($curl, CURLOPT_USE_SSL, CURLUSESSL_ALL);
86    }
87    // ポート 465 (SMTPS) の場合は、URL の 'smtps://' プロトコル指定により自動的に SSL が使用されます。
88
89    // ※ 注意: 以下の SSL/TLS 検証設定は開発環境やテスト向けです。
90    // 本番環境ではセキュリティのため、通常は 'true' に設定し、
91    // 信頼できる CA 証明書を CURLOPT_CAINFO オプションで指定することを強く推奨します。
92    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
93    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
94
95    // デバッグ情報を詳細に出力（初心者向けに推奨）
96    // これを true にすると、cURL の詳細な通信内容が標準エラー出力に表示され、
97    // 問題解決に非常に役立ちます。
98    curl_setopt($curl, CURLOPT_VERBOSE, true);
99
100    // cURL リクエストを実行します。
101    $result = curl_exec($curl);
102
103    if ($result === false) {
104        echo "cURL エラー: " . curl_error($curl) . "\n";
105        $success = false;
106    } else {
107        // cURL は、SMTP サーバーからの最終的な応答が成功 (例: 2xx コード) であれば
108        // 通常 true を返します。詳細な SMTP 応答は verbose 出力で確認できます。
109        echo "メール送信処理が完了しました。\n";
110        $success = true;
111    }
112
113    // cURL セッションを閉じます。
114    curl_close($curl);
115    // ストリームを閉じます。
116    fclose($stream);
117
118    return $success;
119}
120
121// --------------------------------------------------------------------------
122// サンプルコードの実行部分 (実際には設定値を適宜変更してください)
123// --------------------------------------------------------------------------
124
125// !!!!!!!! ここから下の設定は、ご自身の SMTP サーバー情報に合わせて変更してください !!!!!!!!
126// 本番環境でパスワードを直接コードにハードコードするのは非推奨です。
127// 環境変数や安全な設定ファイルなど、よりセキュアな方法で管理することを強く推奨します。
128
129$smtpConfig = [
130    'host'     => 'your.smtp.host', // 例: 'smtp.mailtrap.io' や 'smtp.gmail.com'
131    'port'     => 587,              // 例: 587 (TLS/STARTTLS) または 465 (SMTPS)
132    'username' => 'your_smtp_username',
133    'password' => 'your_smtp_password',
134];
135
136$emailConfig = [
137    'from'    => 'sender@example.com',
138    'to'      => 'recipient@example.com',
139    'subject' => 'PHP cURL を使ったメール送信テスト',
140    'body'    => 'これは PHP と cURL を使って送信されたテストメールです。CURLOPT_MAIL_AUTH および CURLOPT_USERPWD オプションが使用されています。'
141];
142
143echo "cURL を使用してメールを送信中...\n";
144
145$isSent = sendEmailViaSmtpWithCurl(
146    $smtpConfig['host'],
147    $smtpConfig['port'],
148    $smtpConfig['username'],
149    $smtpConfig['password'],
150    $emailConfig['from'],
151    $emailConfig['to'],
152    $emailConfig['subject'],
153    $emailConfig['body']
154);
155
156if ($isSent) {
157    echo "結果: メール送信処理が成功しました。\n";
158} else {
159    echo "結果: メール送信処理が失敗しました。\n";
160}

このサンプルコードは、PHPのcURL拡張機能を利用して、SMTPサーバー経由でメールを送信する方法を示しています。sendEmailViaSmtpWithCurl関数は、SMTPサーバーのホスト名やポート番号、認証に必要なユーザー名とパスワード、送信元・送信先メールアドレス、件名、本文といった情報を引数として受け取ります。そして、これらの情報を用いてcURLセッションを設定し、メール送信処理を実行します。

特に重要なオプションとして、CURLOPT_MAIL_AUTHとCURLOPT_USERPWDがあります。CURLOPT_MAIL_AUTHは、SMTPサーバーが要求する認証方式（例えば、'LOGIN'や'PLAIN'など）を指定するために使用されます。このオプションの値は、ご利用のSMTPサーバーがサポートする認証タイプに合わせる必要があります。また、CURLOPT_USERPWDは、SMTP認証に使用するユーザー名とパスワードを「ユーザー名:パスワード」という形式で指定するために利用されます。

関数内では、メールのヘッダーと本文を結合してメッセージを作成し、一時的なストリームに書き込みます。cURLは、このストリームからメールの内容を読み取り、CURLOPT_UPLOADなどの設定を通じてSMTPサーバーへ送信します。ポート587を利用する際には、CURLOPT_USE_SSLオプションでSTARTTLSによる暗号化接続を有効にします。トラブルシューティングのためにCURLOPT_VERBOSEオプションを有効にすると、cURLの詳細な通信ログを確認できます。

この関数は、メール送信処理が成功した場合はtrueを、cURLエラーなどにより失敗した場合はfalseを戻り値として返します。実際にメールを送信するには、コードの実行部分にご自身のSMTPサーバー情報と認証情報を正しく設定する必要があります。

Copy
1<?php
2
3/**
4 * 指定されたURLにHTTP POSTリクエストを送信します。
5 *
6 * この関数は、cURLライブラリを使用してHTTP POSTリリクエストを実行します。
7 * 主にCURLOPT_POSTオプションとCURLOPT_POSTFIELDSオプションの使用法を示します。
8 *
9 * @param string $url POSTリクエストを送信するターゲットURL。
10 * @param array $data POSTするデータ。連想配列として指定すると、
11 *                    'application/x-www-form-urlencoded'形式で自動的にエンコードされます。
12 * @return string|false 成功した場合はサーバーからのレスポンス本文、失敗した場合は false を返します。
13 *                      エラーが発生した場合は、エラーメッセージを含む文字列を返すこともあります。
14 */
15function performHttpPostRequest(string $url, array $data): string|false
16{
17    // cURLセッションを初期化
18    $ch = curl_init();
19
20    // cURLセッションの初期化に失敗した場合の処理
21    if ($ch === false) {
22        return "エラー: cURLセッションの初期化に失敗しました。";
23    }
24
25    // cURLオプションを設定
26    // リクエストを送信するURLを設定
27    curl_setopt($ch, CURLOPT_URL, $url);
28
29    // HTTP POSTリクエストであることを指定
30    // CURLOPT_POST に true を設定することで、リクエストメソッドが POST になります。
31    curl_setopt($ch, CURLOPT_POST, true);
32
33    // POSTで送信するデータを設定
34    // 配列を指定すると、自動的にURLエンコードされ、Content-Typeは application/x-www-form-urlencoded になります。
35    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
36
37    // サーバーからのレスポンスを文字列として取得する設定
38    // trueに設定すると、curl_exec() はレスポンス本文を返します。
39    // falseの場合は、レスポンスは直接出力されます。
40    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
41
42    // SSL証明書の検証を無効にする設定（開発環境でのみ使用し、本番環境では非推奨です）
43    // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
44    // curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
45
46    // リクエストを実行し、レスポンスを取得
47    $response = curl_exec($ch);
48
49    // エラーが発生した場合の処理
50    if ($response === false) {
51        $error_message = curl_error($ch);
52        curl_close($ch);
53        return "cURLエラー: " . $error_message;
54    }
55
56    // cURLセッションを閉じる
57    curl_close($ch);
58
59    return $response;
60}
61
62// --------------------------------------------------------------------------
63// サンプル使用例
64// --------------------------------------------------------------------------
65
66// テスト用のダミーPOSTエンドポイント
67// この例では、https://jsonplaceholder.typicode.com/posts を使用しています。
68// これはダミーデータをPOSTできる公開APIです。
69$targetUrl = "https://jsonplaceholder.typicode.com/posts";
70
71// POSTするデータ
72$postData = [
73    'title' => 'PHP cURL サンプル',
74    'body' => 'これはCURLOPT_POSTを使用したテスト投稿です。',
75    'userId' => 101,
76];
77
78echo "POSTリクエストを " . $targetUrl . " に送信中...\n";
79echo "送信データ: " . json_encode($postData) . "\n\n";
80
81// HTTP POSTリクエストを実行
82$result = performHttpPostRequest($targetUrl, $postData);
83
84// 結果の表示
85if ($result !== false && strpos($result, "cURLエラー:") === false) {
86    echo "成功: レスポンスを受信しました。\n";
87    echo "--------------------------------------------------\n";
88    echo $result . "\n";
89    echo "--------------------------------------------------\n";
90} else {
91    echo "エラー: リクエストの実行中に問題が発生しました。\n";
92    echo $result . "\n"; // エラーメッセージを表示
93}
94
95?>

このサンプルコードは、PHPのcURLライブラリを使ってHTTP POSTリクエストを送信する方法を、システムエンジニアを目指す初心者にもわかりやすく説明しています。

performHttpPostRequest関数は、指定されたURLに配列形式のデータをPOSTするために設計されています。この関数では、まずcurl_init()でcURLセッションを初期化し、次にcurl_setopt()関数を使って様々なオプションを設定します。

特に重要なオプションは以下の二つです。CURLOPT_POSTにtrueを設定することで、このリクエストがHTTP POSTメソッドであることをcURLに伝えます。また、CURLOPT_POSTFIELDSには送信したいデータを配列として渡します。配列を指定すると、cURLが自動的にデータをURLエンコードし、適切な形式でサーバーへ送信してくれます。

さらに、CURLOPT_RETURNTRANSFERをtrueに設定することで、curl_exec()の実行結果（サーバーからのレスポンス）を直接出力せずに、関数の戻り値として文字列で取得できるようにしています。

関数の引数には、リクエストを送信するターゲットのURL（$url）と、POSTするデータ（$data）を連想配列で渡します。戻り値は、リクエストが成功した場合はサーバーからのレスポンス本文、失敗した場合はエラーメッセージを含む文字列を返します。エラー処理も適切に行われており、安全にHTTPリクエストを実行する基本的な流れが学べます。