ホーム > スリーメール > API

API概要

特定のタスクで未達成となったメールアドレス一覧を取得

特定の配信タスクを実行した際に、配信が失敗したメールアドレスの一覧を取得します。取得項目は次の通りです。

  • メールアドレス
  • エラー理由

リクエストURL
https://example.com/API/get_bounces
※正式なURLは御契約後にご連絡致します。

リクエストパラメータ
パラメータ名 データタイプ 必須 説明
login_id string ○ ログイン用ID
password string ○ ログイン用パスワード
id string ○ タスクID

APIからのXMLについて

APIから送信されるXMLの書式は以下の通りとなります。

<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="urn:3hands:3mail">
  <status>OK</status>                        //ステータス
  <code>210</code>                           //コード
  <message>success</message>                           //メッセージ
  <error>
    <email>example@example.com</email>       //メールアドレス
    <reason>user_unknown</reason> //エラー理由
  </error>
  <error>
    (エラーのあったメールアドレスの数だけ繰り返し)
  </error>
</response>

※エラーとなったメールアドレスが0件の場合でもstatusはOKとなります。

返り値の詳細

名前 データタイプ 最大バイト数 説明
status string 2 ステータス(OK=成功、NG=失敗)
code string 3 コード(一覧)
message string 255 メッセージ
error.email string 65535 行の内容
error.reason string 255 エラー理由

サンプルスクリプト

<?php

//APIへ送信するデータ
$post_data = array(
    "login_id" => "login@example.com", //ログインID
    "password" => "password",          //ログインパスワード
    "id" => "90"                       //タスクID
);
   
//APIのHostを設定
$api_host = "example.com";
   
//APIのPathを設定
$api_path = "/API/get_bounces";

//APIへ接続
$sp = fsockopen('ssl://' . $api_host, 443, $errno, $errstr, 30);
   
//エラーチェック
if(!$sp){
    print $errno . "<br>" . $errstr;
    exit;
}

//boundary生成
$boundary = "-----" . md5(uniqid());
   
//header生成
$header  = "POST " . $api_path . " HTTP/1.0\r\n";
$header .= "Host: " . $api_host . "\r\n";
$header .= "Content-type: multipart/form-data, boundary=" . $boundary . "\r\n";
$header .= "Referer: http://" . $_SERVER['SERVER_NAME'] . $_SERVER['SCRIPT_NAME'] . "\r\n";
$header .= "Accept: */*\r\n";
   
//body生成
$body = "";
   
//テキストデータをAPIへ送信できるように変換
foreach ($post_data as $key => $val){
    $body .= "--" . $boundary . "\r\n";
    $body .= "Content-Disposition: form-data; name=\"" . $key . "\"\r\n";
    $body .= "\r\n" . $val . "\r\n";
    $body .= "--" . $boundary . "\r\n";
}
   
//送信データ末尾の区切り文字を追加
$body .= "--" . $boundary . "--\r\n";
$body .= "\r\n\r\n";
   
//ヘッダーにbodyのサイズを追加
$header .= "Content-length: " . strlen($body) . "\r\n\r\n";

//データ送信
fputs($sp, $header);
fputs($sp, $body);

//データ受信
$buf = "";
$response = fgets($sp);
   
if (substr_count($response, "200 OK") > 0){
    while (!feof($sp)){
        $buf = $buf . fread($sp, 4096);
    }
}else{
    print "データ受信に失敗しました";
    exit;
}
   
//接続終了
fclose($sp);

//結果XMLを取得
$result = substr($buf, strpos($buf, "\r\n\r\n")+4);

//XMLをパースする
$result_xml = simplexml_load_string($result);

//結果を取得し表示
print "status:" . $result_xml->status . "<br>";   //ステータス
print "code:" . $result_xml->code . "<br>"; //コード
print "message:" . $result_xml->message . "<br>"; //メッセージ

//タスクの詳細を取得し表示
foreach ($result_xml->erroras $error){
    print "----------" . "<br>";
    print "email:" . $error->email . "<br>";    //メールアドレス
    print "reason:" . $error->reason. "<br>"; //エラー詳細

}

exit;

?>

サンプルスクリプト解説

APIへ送信するデータ及び、APIのURLについて設定を行います。

//APIへ送信するデータ
$post_data = array(
    "login_id" => "login@example.com", //ログインID
    "password" => "password",          //ログインパスワード
    "id" => "90"                       //タスクID

);
   
//APIのHostを設定
$api_host = "example.com";
   
//APIのPathを設定
$api_path = "/API/get_bounces";

APIへソケットを使って接続を行います。

//APIへ接続
$sp = fsockopen('ssl://' . $api_host, 443, $errno, $errstr, 30);
   
//エラーチェック
if(!$sp){
    print $errno . "<br>" . $errstr;
    exit;
}

APIへ送信するデータの作成を行います。

//boundary生成
$boundary = "-----" . md5(uniqid());
   
//header生成
$header  = "POST " . $api_path . " HTTP/1.0\r\n";
$header .= "Host: " . $api_host . "\r\n";
$header .= "Content-type: multipart/form-data, boundary=" . $boundary . "\r\n";
$header .= "Referer: http://" . $_SERVER['SERVER_NAME'] . $_SERVER['SCRIPT_NAME'] . "\r\n";
$header .= "Accept: */*\r\n";
   
//body生成
$body = "";
   
//テキストデータをAPIへ送信できるように変換
foreach ($post_data as $key => $val){
    $body .= "--" . $boundary . "\r\n";
    $body .= "Content-Disposition: form-data; name=\"" . $key . "\"\r\n";
    $body .= "\r\n" . $val . "\r\n";
    $body .= "--" . $boundary . "\r\n";
}
   
//送信データ末尾の区切り文字を追加
$body .= "--" . $boundary . "--\r\n";
$body .= "\r\n\r\n";
   
//ヘッダーにbodyのサイズを追加
$header .= "Content-length: " . strlen($body) . "\r\n\r\n";

APIへデータの送信を行います。

//データ送信
fputs($sp, $header);
fputs($sp, $body);

データの受信を行います。

へッダーが "200 OK" 以外の場合はエラーとなります。

//データ受信
$buf = "";
$response = fgets($sp);
   
if (substr_count($response, "200 OK") > 0){
    while (!feof($sp)){
        $buf = $buf . fread($sp, 4096);
    }
}else{
    print "データ受信に失敗しました";
    exit;
}
   
//接続終了
fclose($sp);

受信したデータからXML部分のみを取得後パースを行います。

//結果XMLを取得
$result = substr($buf, strpos($buf, "\r\n\r\n")+4);

//XMLをパースする
$result_xml = simplexml_load_string($result);

結果の基本項目は以下の方法で取得できます。

今回はサンプルなので取得結果をそのまま表示します。

//結果を取得し表示
print "status:" . $result_xml->status . "<br>"; //ステータス
print "code:"   . $result_xml->code   . "<br>"; //コード
print "message:"   . $result_xml->message   . "<br>"; //メッセージ

配信エラーとなったメールアドレスのデータは以下の方法で取得できます。

詳細はステータスがOK(送信した内容に問題が無い)の場合のみ取得できます。 

//エラーの詳細を取得し表示
foreach ($result_xml as $error){
    print "----------" . "<br>";
    print "line:" . $error->line . "<br>";       //行数
    print "email:" . $error->email . "<br>";     //メールアドレス
    print "reason:" . $error->reason . "<br>"; //エラー詳細
}

サンプルスクリプトの実行結果は以下の通りとなります。

status:OK
code:210
message:success
----------
email:mail1@mail.com
reason:user_unknown
----------
email:mail100@mail.com
reason:domain_error

スクリプト実行後の処理について

実際にはXMLを取得後、ステータス及びコードに合わせて処理を行ってください。(正常終了、エラー表示等)

前のページへ戻る

特長 | 機能 | 事例 | 料金 | FAQ | 利用規約 | マニュアル | API | オンライン申込 | パンフレットのダウンロード
online-order
3HANDS Information お問い合わせはこちら