Office.InternetHeaders interface
InternetHeaders オブジェクトは、メッセージ 項目が Exchange から離れた後に保持され、MIME メッセージに変換されるカスタム インターネット ヘッダーを表します。
インターネット ヘッダーは、アイテムごとに文字列キーと値のペアとして格納されます。
注: このオブジェクトは、メッセージ項目にカスタム ヘッダーを設定して取得することを目的としています。 詳細については、「 Outlook アドインのメッセージでインターネット ヘッダーを取得して設定する」を参照してください。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
重要: インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
推奨されるプラクティス:
現在、インターネット ヘッダーは、ユーザーのメールボックス上の有限リソースです。 クォータが不足すると、そのメールボックスにインターネット ヘッダーをこれ以上作成できないため、この機能に依存するクライアントから予期しない動作が発生する可能性があります。
アドインでインターネット ヘッダーを作成する場合は、次のガイドラインを適用します。
必要なヘッダーの最小数を作成します。 ヘッダー クォータは、メッセージに適用されるヘッダーの合計サイズに基づいています。 Exchange Online では、ヘッダーの上限は 256 KB ですが、Exchange オンプレミス環境では、組織の管理者によって制限が決定されます。 ヘッダーの制限の詳細については、「 Exchange Online メッセージの制限 」と「 Exchange Server メッセージの制限」を参照してください。
後で値を再利用して更新できるように、ヘッダーに名前を付けます。 そのため、(ユーザー入力やタイムスタンプに基づくなど) 可変の方法でヘッダーに名前を付けるのは避けてください。
メソッド
| get |
インターネット ヘッダー名の配列を指定すると、このメソッドは、これらのインターネット ヘッダーとその値を含むレコードを返します。 アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。
注: このメソッドは、 |
| get |
インターネット ヘッダー名の配列を指定すると、このメソッドは、これらのインターネット ヘッダーとその値を含むレコードを返します。 アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。
注: このメソッドは、 |
| remove |
インターネット ヘッダー名の配列を指定すると、このメソッドはインターネット ヘッダー コレクションから指定されたヘッダーを削除します。
注: このメソッドは、 |
| remove |
インターネット ヘッダー名の配列を指定すると、このメソッドはインターネット ヘッダー コレクションから指定されたヘッダーを削除します。
注: このメソッドは、 |
| set |
指定したインターネット ヘッダーを指定した値に設定します。 指定したヘッダーがまだ存在しない場合は、 注: このメソッドは、カスタム ヘッダーの値を設定することを目的としています。 |
| set |
指定したインターネット ヘッダーを指定した値に設定します。 指定したヘッダーがまだ存在しない場合は、 注: このメソッドは、カスタム ヘッダーの値を設定することを目的としています。 |
メソッドの詳細
getAsync(names, options, callback)
インターネット ヘッダー名の配列を指定すると、このメソッドは、これらのインターネット ヘッダーとその値を含むレコードを返します。 アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。
注: このメソッドは、 setAsync メソッドを使用して設定したカスタム ヘッダーの値を返すことを目的としています。
getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;パラメーター
- names
-
string[]
返されるインターネット ヘッダーの名前。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。
asyncResult.value プロパティでは、インターネット ヘッダーの文字列キーと値のペアが返されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
重要: インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.getAsync(
["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
function (asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Selected headers: " + JSON.stringify(asyncResult.value));
} else {
console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
}
}
);
getAsync(names, callback)
インターネット ヘッダー名の配列を指定すると、このメソッドは、これらのインターネット ヘッダーとその値を含むレコードを返します。 アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。
注: このメソッドは、 setAsync メソッドを使用して設定したカスタム ヘッダーの値を返すことを目的としています。
getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void): void;パラメーター
- names
-
string[]
返されるインターネット ヘッダーの名前。
- callback
-
(asyncResult: Office.AsyncResult<Record<string, string>>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。
asyncResult.value プロパティでは、インターネット ヘッダーの文字列キーと値のペアが返されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: 新規作成
重要: インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
removeAsync(names, options, callback)
インターネット ヘッダー名の配列を指定すると、このメソッドはインターネット ヘッダー コレクションから指定されたヘッダーを削除します。
注: このメソッドは、 setAsync メソッドを使用して設定したカスタム ヘッダーを削除することを目的としています。
removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- names
-
string[]
削除するインターネット ヘッダーの名前。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
重要: インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.removeAsync(
["best-vegetable", "nonexistent-header"],
function (asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Successfully removed selected headers");
} else {
console.log("Error removing selected headers: " + JSON.stringify(asyncResult.error));
}
}
);
removeAsync(names, callback)
インターネット ヘッダー名の配列を指定すると、このメソッドはインターネット ヘッダー コレクションから指定されたヘッダーを削除します。
注: このメソッドは、 setAsync メソッドを使用して設定したカスタム ヘッダーを削除することを目的としています。
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- names
-
string[]
削除するインターネット ヘッダーの名前。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
重要: インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
setAsync(headers, options, callback)
指定したインターネット ヘッダーを指定した値に設定します。
指定したヘッダーがまだ存在しない場合は、 setAsync メソッドによって新しいヘッダーが作成されます。それ以外の場合は、既存の値が新しい値に置き換えられます。
注: このメソッドは、カスタム ヘッダーの値を設定することを目的としています。
setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- headers
-
Record<string, string>
設定するヘッダーの名前と対応する値。 これは、キーがインターネット ヘッダー名であり、値が対応するヘッダー値文字列であるレコード オブジェクトである必要があります。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
重要:
インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
ヘッダー クォータは、メッセージに適用されるヘッダーの合計サイズに基づいています。 Exchange Online では、ヘッダーの上限は 256 KB ですが、Exchange オンプレミス環境では、組織の管理者によって制限が決定されます。 ヘッダーの制限の詳細については、「 Exchange Online メッセージの制限 」と「 Exchange Server メッセージの制限」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml
Office.context.mailbox.item.internetHeaders.setAsync(
{ "preferred-fruit": "orange", "preferred-vegetable": "broccoli", "best-vegetable": "spinach" },
function (asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Successfully set headers");
} else {
console.log("Error setting headers: " + JSON.stringify(asyncResult.error));
}
}
);
setAsync(headers, callback)
指定したインターネット ヘッダーを指定した値に設定します。
指定したヘッダーがまだ存在しない場合は、 setAsync メソッドによって新しいヘッダーが作成されます。それ以外の場合は、既存の値が新しい値に置き換えられます。
注: このメソッドは、カスタム ヘッダーの値を設定することを目的としています。
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- headers
-
Record<string, string>
設定するヘッダーの名前と対応する値。 これは、キーがインターネット ヘッダー名であり、値が対応するヘッダー値文字列であるレコード オブジェクトである必要があります。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult型の 1 つのパラメーターasyncResultで呼び出されます。 発生したエラーは、 asyncResult.error プロパティで提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: 新規作成
重要:
インターネット ヘッダー API は、Outlook on Android およびバージョン 4.2405.0 以降の iOS でサポートされています。 モバイル デバイス上の Outlook でサポートされる機能の詳細については、「モバイル デバイスで Outlook でサポートされている Outlook JavaScript API」を参照してください。
ヘッダー クォータは、メッセージに適用されるヘッダーの合計サイズに基づいています。 Exchange Online では、ヘッダーの上限は 256 KB ですが、Exchange オンプレミス環境では、組織の管理者によって制限が決定されます。 ヘッダーの制限の詳細については、「 Exchange Online メッセージの制限 」と「 Exchange Server メッセージの制限」を参照してください。
Office Add-ins