cfhttp

url = "server URL"
charset = "character encoding"
clientCert = "filename"
clientCertPassword = "password"
columns = "query columns"
delimiter = "character"
file = "filename"
firstrowasheaders = "yes|no"
getAsBinary = "auto|yes|no|never"
method = "method name"
multipart = "yes|no"
name = "query name"
password = "password"
path = "path"
port = "port number"
proxyServer = "host name"
proxyPort = "port number"
proxyUser = "username"
proxyPassword = "password"
redirect = "yes|no"
resolveURL = "yes|no"
result = "result name"
textQualifier = "character"
throwOnError = "yes|no"
timeout = "time-out period in seconds"
username = "username"
userAgent = "user agent"
authType = "BASIC|NTLM"
domain = "domain name"
workstation = "workstation name">

cfhttpparam tags [optional for some methods]

</cfhttp>

注意：このタグの属性は attributeCollection 属性で指定でき、その値は構造体になります。attributeCollection 属性で構造体の名前を指定し、タグの属性名を構造体のキーとして使用します。

url

必須

http プロトコルを使用

リクエストを処理するサーバー上のリソースのアドレスです。この URL にはホスト名か IP アドレスを含める必要があります。
トランザクションプロトコル（ http :// または

）を指定しなかった場合は、デフォルトのプロトコルである http が使用されます。
この属性でポート番号を指定した場合は、port 属性の値が上書きされます。
この cfhttpparam タグの URL 属性を使用すると、クエリ文字列の属性と値のペアがこの URL に追加されます。

charset

オプション

リクエスト：UTF-8 応答 ：Content-type ヘッダーによって指定された文字セット（ response で charset を指定していない場合は UTF-8）。

URL クエリ文字列、フォームまたはファイルデータ、レスポンスなどのリクエストの文字エンコードです。一般的に使用される値を次に示します。

• utf -8
• iso-8859-1
• windows-1252
• us- ascii
• shift_jis
• iso-2022-jp
• euc -jp
• euc - kr
• big5
• euc - cn
• utf -16
  文字エンコードについて詳しくは、www.w3.org/International/O-charset.en.html を参照してください。

clientCert

オプション

リクエストのためのクライアント証明書が含まれている PKCS12 形式のファイルへの絶対パスです。

clientCertPassword

オプション

クライアント証明書を復号するために使用されるパスワードです。

compression

オプション

ターゲット Web サーバーの圧縮ステータスです。サポートされている値は none のみです。ターゲットの Web サイトが、HTTP 圧縮が有効な IIS で実行されている場合は、この属性を使用して、GET または POST オペレーションを実行するときの接続エラーを回避できます。

getAsBinary

オプション

×

• × : ColdFusion がレスポンス本文のタイプをテキストとして認識しない場合は、それを ColdFusion オブジェクトに変換します。
• auto: ColdFusion がレスポンス本文のタイプをテキストとして認識しない場合は、それを ColdFusion Binary タイプデータに変換します。
• yes: レスポンス本文のコンテンツを必ず ColdFusion Binary タイプデータに変換します。ColdFusion がレスポンス本文のタイプをテキストとして認識する場合でも同様です。
• never: 特定の MIME タイプから ColdFusion の Binary タイプデータへの自動変換が防止され、返される内容が常にテキストとして処理されます。
  ColdFusion は、次の場合にレスポンス本文をテキストとして認識します。
• ヘッダにコンテンツタイプが指定されていない場合
• コンテンツタイプが "text" で始まっている場合
• コンテンツタイプが "message" で始まっている場合
• コンテンツタイプが "application/octet-stream" である場合
  ColdFusion がレスポンス本文をテキストとして認識せず、オブジェクトに変換した場合でも、その本文がテキストから構成されている場合は、 cfoutput タグを使用して表示することができます。この cfoutput タグでは Binary タイプデータを表示できません。バイナリデータをテキストに変換するには、ToString 関数を使用します。

method

オプション

GET

• GET: サーバーに情報をリクエストします。リクエストされた情報をサーバーが 識別するために必要なデータはすべて、 要求された情報は、URL、または cfhttp type = "URL" タグに含める必要があります。
• POST: 処理する情報をサーバーに送信します。1 つまたは複数の cfhttpparam タグが必要です。フォームに似たデータを送信するときによく使用されます。
• PUT: 指定の URL にメッセージ本文を保管するようサーバーにリクエストします。このメソッドは、サーバーにファイルを送信するときに使用されます。
• DELETE: 指定の URL を削除するようサーバーにリクエストします。
• HEAD: GET メソッドと同じですが、サーバーはレスポンス内にメッセージ本文を送信しません。このメソッドは、ハイパーテキストリンクの有効性やアクセシビリティのテスト、ドキュメントのタイプや修正時刻の確認、またはサーバーのタイプの判別に使用します。
• TRACE：サーバーに対し、HTTP ヘッダーを echo を使用して応答本文で送信者に返すようリクエストします。トレースリクエストには本文がありません。このメソッドを使用すると、ColdFusion アプリケーションはサーバー側で何を受信したかを調べ、そのデータをテストや診断情報に利用することができます。
• OPTIONS: サーバーまたは指定の URL で使用できる通信オプションについての情報をリクエストします。このメソッドを使用すると、ColdFusion アプリケーションは、追加のサーバー 活動 を要求しなくても、URL に関連付けられているオプションや要件、あるいはサーバーの機能を判別することができます。
• PATCH：指定 URL での リクエストされた エンティティに、部分的なアップデートをリクエストします。このメソッドは、リソースの一部を変更する（PUT メソッドを使用して指定した URL にあるリソースを完全に置き換える）場合に使用します。

password

オプション

基本認証のターゲット URL にパスワードを渡すために使用します。 username を組み合わせて base64 エンコードされた文字列を 作成し、 Authenticate ヘッダーで渡します。統合 Windows 認証または Kerebos 認証には対応しません。

port

オプション

80 （ http の場合）、443（https の場合）

リクエストの送信先となるサーバー上のポート番号です。この値よりも url 属性の port 値が優先されます。

proxyServer

オプション

リクエストの送信先となるプロキシサーバーのホスト名または IP アドレスです。

proxyPort

オプション

80

プロキシサーバー上で使用するポート番号です。

proxyUser

オプション

プロキシサーバーに提供するユーザー名 です。

proxyPassword

オプション

プロキシサーバーに提供するパスワードです。

redirect

オプション

yes

レスポンスヘッダに Location フィールドが含まれ、ColdFusion が 300 系列 (リダイレクション) のステータスコードを受け取った場合、そのフィールド内で指定された URL に実行をリダイレクトするかどうかを指定します。

• yes: 指定のページに実行をリダイレクトします。
• no：実行を停止し、 cfhttp 変数で応答情報を返す、または throwOnError 属性が True の場合はエラーをスローします。
  cfhttp.responseHeader.Location 変数にはリダイレクトパスが含まれています。ColdFusion では、1 つのリクエストで最大 4 回までリダイレクトが行われます。これよりも多くなると、redirect ="no" を指定した場合と同じ処理が行われます。
  メモ： cflocation タグによって HTTP 302 応答と、Location ヘッダー値として cfm 属性が生成されます。

resolveURL

オプション

×

• × : レスポンス本文の中の URL を変換しません。その結果、レスポンス本文に含まれる相対 URL リンクはすべて機能しなくなります。
• yes: 取得したページ内でもリンクが機能するように、レスポンス本文中の URL (ポート番号も含む) を絶対 URL に変換します。次の HTML タグに適用されます。
• img
• src
• a href
• form action
• applet code
• script src
• embed src
• に pluginspace
• body background
• frame src
• bgsound src
• object data
• object classid
• object codebase
• object usemap
  file 属性および path 属性を使用する場合は、URL を変換しません。

result

オプション

結果を受け取る代替変数を指定することができます。

throwOnError

オプション

no

• yes：サーバーがエラーレスポンスコードを返す場合に、 cftry と cfcatch または ColdFusion エラーページ使って検出できる例外を返します。
• no: エラーレスポンスを返す場合に例外を返しません。このような場合は、アプリケーションで cfhttp .StatusCode 変数を使用して、エラーの 有無 とその原因を判断できます。

timeout

オプション

リクエストの最大待機時間を秒数で指定します。レスポンスがないままタイムアウトになった場合は、そのリクエストが失敗したものと見なされます。クライアントが URL 検索パラメータ内でタイムアウトを指定した場合は (例 : ?RequestTime=120)、その URL タイムアウトと timeout 属性値のうち、短いほうが採用されます。これにより、リクエストが確実にページよりも先に (あるいは同時に) タイムアウトになります。
URL にタイムアウトが指定されていない場合は、Administrator タイムアウトと timeout 属性値のうち、短いほうが採用されます。
上記のどの方法でもタイムアウト値が設定されていない場合は、ColdFusion は cfhttp リクエストが処理されるのを無限に待機することになります。

userAgent

オプション

ColdFusion

ユーザーエージェントリクエストヘッダに配置されるテキストです。リクエストクライアントソフトウェアを識別するために使われます。ColdFusion アプリケーションをブラウザのように見せることができます。

username

オプション

これを使用して ユーザー名 を基本認証のターゲット URL に渡します。これを password と組み合わせ、認証ヘッダー で 渡された base64 形式でエンコードされた文字列を作成します。統合 Windows 認証または Kerberos 認証には対応しません。

• BASIC
• NTLM

メモ：
認証タイプが NTLM である場合は、「リダイレクト」を false に設定しないようにします。

multipart

オプション

no（ファイルタイプデータが request に含まれる場合にのみマルチパートとして送信）

ColdFusion に対し、 cfhttpparam type = "formField" タグで指定されたすべてのデータをマルチパート／フォームデータのコンテンツタイプを使用したマルチパート／フォームデータのコンテンツタイプを使用して、として使用できます。デフォルトでは、ColdFusion によって送信されるのは、 cfhttp リクエストに、 コンテンツタイプ 「application/x-www-form- urlencoded 」を使用した formField のみを含むもののみです。ただし、リクエストに File タイプデータも含まれている場合は、すべての部分に multipart/form-data コンテンツタイプが使用されます。この属性を yes に設定した場合は、Content-Type の記述の中でリクエストの文字セットも送信されます。すべてのフォームフィールドデータをこの文字エンコードでエンコードする必要があります。ColdFusion はこのデータに URLEncode を実行しません。フィールド名は ISO-88591-1 または ASCII である必要があります。一部の http パーサ（以前のバージョンの ColdFusion で使われていたものも含む）は、マルチパートフォームフィールドの文字エンコードの説明を無視します。

multipartType

オプション

form-data

マルチパートヘッダフィールドを related または form-data に設定できます。デフォルトでは、値は form-data です。

result

オプション

結果を返すために使用する変数の名前を指定します。

ファイル

path 属性を指定していて、GET メソッドでない場合は必須

「説明」を参照

レスポンス本文の保管先となるファイルの名前です。GET オペレーションでは、URL 内でリクエストされたファイルがデフォルトになります（ファイルが指定されている場合）。例えば、GET メソッドの URL が http:www.myco.com/test.htm である場合、デフォルトファイルは test.htm です。この属性ではディレクトリへのパスを指定しないでください。パスは path 属性で指定します。

path

file 属性を指定している場合は必須

HTTP レスポンス本文をファイルに保管することを ColdFusion に指示します。ファイルの保管先となるディレクトリへの絶対パスを指定します。

ram:///filepath

列[れつ]

オプション

レスポンスの 1 行目には列名が含まれます。

このクエリの列名をカンマで区切って指定します。スペースは使用しません。列名は文字で始める必要があります。2 文字目以降には、文字、数字、アンダースコア文字 (_) を使用できます。
レスポンス内に列名ヘッダーがない場合は、列名を識別するためにこの属性を指定します。この属性を設定したときに、firstrowasHeader 属性が true (デフォルト) だった場合には、この属性で指定した列名によってレスポンスの 1 行目が置き換えられます。この動作を利用して、リクエストによって取得された列名を独自の名前に置き換えることができます。
この属性またはレスポンスからの列名の中で重複する列ヘッダがある場合、その名前にアンダースコアが付加され、固有の名前が作成されます。
この属性で指定した列の数が HTTP レスポンス本文の中の列数と等しくない場合は、エラーが発生します。

delimiter

オプション

, (カンマ)

クエリ列を区切る文字です。レスポンス本文はこの文字を使用してクエリ列を区切る必要があります。

firstrowasheaders

オプション

yes

ColdFusion で、クエリのレコードセットの最初の行を処理する方法を決定します。

• yes：1 行目を列ヘッダーとして扱います。columns 属性を指定した場合は、ファイルの 1 行目が無視されます。
• no: 1 行目をデータとして扱います。columns 属性を指定しなかった場合は、"column_1" のように、"column" という単語に数字を付加した列名が作成されます。

name

オプション

返された HTTP レスポンス本文から指定の名前のクエリオブジェクトを作成するよう ColdFusion に指示します。

textQualifier

オプション

" 二重引用符

テキスト列の始まりと終わりを示すオプションの文字です。レスポンス本文中のテキストフィールドがフィールド値の一部に区切り文字を含んでいる場合は、テキストフィールドをこの文字で囲む必要があります。
この文字を列テキストの中に含めるときには、文字を 2 つ指定してエスケープします。例えば、テキスト修飾子が二重引用符である場合に、この文字をエスケープするには "" と指定します。

cfhttp.charSet

レスポンスの Content-Type ヘッダで指定されたレスポンス文字セット (文字エンコード) です。

cfhttp.errorDetail

HTTP サーバーへの接続が失敗した場合に、失敗の詳細を記録します(例 : "Unknown host: my.co.com")。それ以外の場合は、空の文字列になります。エラー状態について、他の変数を確認する前にこの変数を確認することをお勧めします。

cfhttp.fileContent

レスポンス本文です。例えば、GET オペレーションによって取得された HTML ページのコンテンツなどです。レスポンスをファイルに保管した場合は空になります。

cfhttp.header

すべてのヘッダ情報を 1 つの文字列に格納した生のレスポンスヘッダーです。cfhttp.responseHeader 変数と同じ情報を含みます。

cfhttp.mimeType

レスポンスの Content-Type ヘッダで指定されている MIME タイプです (例 : text/html)。

cfhttp.responseHeader

構造体の形式にされたレスポンスヘッダです。要素キーは、Content-Type や Status_Code などのヘッダ名です。あるヘッダータイプのインスタンスが複数ある場合は、そのタイプの値が配列に格納されます。よく使用されるテクニックは、#cfhttp.resonseHeaderfieldVariable# のように、cfhttp.responseHeader 構造体をダイナミック配列としてダイナミックにアクセスすることです。

cfhttp.statusCode

HTTP Explanation ヘッダ値の後に続く HTTP status_code ヘッダ値です (例 : "200 OK")。

cfhttp.text

ブール値。レスポンス本文のコンテンツタイプがテキストである場合は true になります。ColdFusion は、次の場合にレスポンス本文をテキストとして認識します。

• ヘッダにコンテンツタイプが指定されていない場合
• コンテンツタイプが "text" で始まっている場合
• コンテンツタイプが "message" で始まっている場合
• コンテンツタイプが "application/octet-stream" である場合

Field1,Field2,Field3
"A comma, in text","A quote: ""Oh My!""",Plain text