Office.InternetHeaders interface

InternetHeaders オブジェクトは、メッセージアイテムが Exchange を離れて MIME メッセージに変換された後、保持されるカスタムインターネットヘッダーを表します。

インターネットヘッダーは、項目ごとに文字列キーと値のペアで格納されます。

注: このオブジェクトは、メッセージアイテムのカスタムヘッダーを設定して取得するためのものです。詳細については、「Outlook アドインでメッセージのインターネットヘッダーを取得して設定する」を参照してください。

注釈

重要: インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の Outlook でサポートされています。モバイルデバイスでの Outlook でサポートされている機能の詳細については、「モバイルデバイス上の Outlook でサポートされている JavaScript API」を参照してください。

推奨プラクティス

現在、インターネットヘッダーは、ユーザーのメールボックス上の有限のリソースです。クォータを使い果たすと、そのメールボックスでこれ以上のインターネットヘッダーを作成できなくなり、これに依存するクライアントが機能する際に予期しない動作が発生する可能性があります。

アドインでインターネットヘッダーを作成するときは、次のガイドラインに従います。

必要な最小限のヘッダー数を作成します。ヘッダークォータは、メッセージに適用されるヘッダーの合計サイズに基づきます。 Exchange Online では、ヘッダー制限は 256 KB に制限されていますが、Exchange オンプレミス環境では、制限はorganizationの管理者によって決定されます。ヘッダー制限の詳細については、「Exchange Online メッセージ制限」および「Exchange Server メッセージ制限」を参照してください。
後で値を再利用および更新できるように、ヘッダーに名前を付けます。そのため、(たとえば、ユーザー入力、タイムスタンプなどに基づく) 可変な方法でヘッダーに名前を付けることは避けてください。

使用元

メソッド

getAsync(names, options, callback)	インターネットヘッダー名の配列を指定すると、このメソッドは、それらのインターネットヘッダーとその値を含むレコードを返します。アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。注: このメソッドは、 `setAsync` メソッドを使用して設定したカスタムヘッダーの値を返すことを目的としています。
getAsync(names, callback)	インターネットヘッダー名の配列を指定すると、このメソッドは、それらのインターネットヘッダーとその値を含むレコードを返します。アドインが使用できないヘッダーを要求した場合、そのヘッダーは結果に返されません。注: このメソッドは、 `setAsync` メソッドを使用して設定したカスタムヘッダーの値を返すことを目的としています。
removeAsync(names, options, callback)	インターネットヘッダー名の配列を指定すると、このメソッドは、指定されたヘッダーをインターネットヘッダーコレクションから削除します。注: このメソッドは、 `setAsync` メソッドを使用して設定したカスタムヘッダーを削除することを目的としています。
removeAsync(names, callback)	インターネットヘッダー名の配列を指定すると、このメソッドは、指定されたヘッダーをインターネットヘッダーコレクションから削除します。注: このメソッドは、 `setAsync` メソッドを使用して設定したカスタムヘッダーを削除することを目的としています。
setAsync(headers, options, callback)	指定したインターネットヘッダーを指定した値に設定します。 `setAsync` メソッドは、指定されたヘッダーがまだ存在しない場合は新しいヘッダーを作成します。それ以外の場合は、既存の値が新しい値に置き換えられます。注: このメソッドは、カスタムヘッダーの値を設定することを目的としています。
setAsync(headers, callback)	指定したインターネットヘッダーを指定した値に設定します。 `setAsync` メソッドは、指定されたヘッダーがまだ存在しない場合は新しいヘッダーを作成します。それ以外の場合は、既存の値が新しい値に置き換えられます。注: このメソッドは、カスタムヘッダーの値を設定することを目的としています。

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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り

適用可能な Outlook モード: Compose

重要: インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の 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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り

適用可能な Outlook モード: Compose

重要: インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の 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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り/書き込み

適用可能な Outlook モード: Compose

重要:

インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の Outlook でサポートされています。モバイルデバイスでの Outlook でサポートされている機能の詳細については、「モバイルデバイス上の Outlook でサポートされている JavaScript API」を参照してください。
removeAsync メソッドは、現在 loadItemByIdAsync メソッドを使用して読み込まれているメッセージではサポートされていません。詳細については、「複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。

例

// 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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り/書き込み

適用可能な Outlook モード: Compose

重要:

インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の Outlook でサポートされています。モバイルデバイスでの Outlook でサポートされている機能の詳細については、「モバイルデバイス上の Outlook でサポートされている JavaScript API」を参照してください。
removeAsync メソッドは、現在 loadItemByIdAsync メソッドを使用して読み込まれているメッセージではサポートされていません。詳細については、「複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。

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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り/書き込み

適用可能な Outlook モード: Compose

重要:

インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の Outlook でサポートされています。モバイルデバイスでの Outlook でサポートされている機能の詳細については、「モバイルデバイス上の Outlook でサポートされている JavaScript API」を参照してください。
ヘッダークォータは、メッセージに適用されるヘッダーの合計サイズに基づきます。 Exchange Online では、ヘッダー制限は 256 KB に制限されていますが、Exchange オンプレミス環境では、制限はorganizationの管理者によって決定されます。ヘッダー制限の詳細については、「Exchange Online メッセージ制限」および「Exchange Server メッセージ制限」を参照してください。
setAsync メソッドは、現在 loadItemByIdAsync メソッドを使用して読み込まれているメッセージではサポートされていません。詳細については、「複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。

例

// 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

注釈

API セット: メールボックス 1.8

最小アクセス許可レベル: 項目の読み取り/書き込み

適用可能な Outlook モード: Compose

重要:

インターネットヘッダー API は、Android 版および iOS バージョン 4.2405.0 以降の Outlook でサポートされています。モバイルデバイスでの Outlook でサポートされている機能の詳細については、「モバイルデバイス上の Outlook でサポートされている JavaScript API」を参照してください。
ヘッダークォータは、メッセージに適用されるヘッダーの合計サイズに基づきます。 Exchange Online では、ヘッダー制限は 256 KB に制限されていますが、Exchange オンプレミス環境では、制限はorganizationの管理者によって決定されます。ヘッダー制限の詳細については、「Exchange Online メッセージ制限」および「Exchange Server メッセージ制限」を参照してください。
setAsync メソッドは、現在 loadItemByIdAsync メソッドを使用して読み込まれているメッセージではサポートされていません。詳細については、「複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。

注釈

使用元

メソッド

メソッドの詳細

getAsync(names, options, callback)

パラメーター

返品

注釈

例

getAsync(names, callback)

パラメーター

返品

注釈

removeAsync(names, options, callback)

パラメーター

返品

注釈

例

removeAsync(names, callback)

パラメーター

返品

注釈

setAsync(headers, options, callback)

パラメーター

返品

注釈

例

setAsync(headers, callback)

パラメーター

返品

注釈

フィードバック