EmailServicesFunction | メタデータ API 開発者ガイド

ファイルのサフィックスおよびディレクトリの場所

EmailServicesFunction コンポーネントのサフィックスは .xml で、このコンポーネントは emailservices フォルダに保存されます。

バージョン

EmailServicesFunction コンポーネントは、API バージョン 42.0 以降で使用できます。

項目

項目名	項目の型	説明
apexClass	string	必須。メールサービスが受信メッセージを処理するために使用する Apex クラスの名前。
attachmentOption	EmailServicesAttOptions (string 型の列挙)	必須。メールサービスが受け取る添付ファイルの種類を示します。次のいずれかの値になります。 `None` — メールサービスは、メッセージを受け入れますが、添付ファイルはいずれも破棄します。 `NoContent` — 添付ファイルメタデータ (ファイル名、MIME タイプなど) は Apex クラスに提供されますが、本文は `null` に設定されます。 `TextOnly` — メールサービスは、次の種別の添付ファイルのみを受け入れます。 text の Multipurpose Internet Mail Extension (MIME) タイプの添付ファイル。 application/octet-stream の MIME タイプの添付ファイルと、.vcf または .vcs 拡張子で終わるファイル名の添付ファイル。これらはそれぞれ、text/x-vcard および text/calendar MIME タイプとして保存されます。 `BinaryOnly` — メールサービスは、画像、音声、アプリケーション、映像ファイルなどのバイナリの添付ファイルのみを受け入れます。 `All` — メールサービスは、どのような種別の添付ファイルでも受け入れます。
authenticationFailureAction	EmailServicesErrorAction (string 型の列挙)	必須。isAuthenticationRequired 項目が true の場合に、認証プロトコルでエラーになったメッセージや、どの認証プロトコルもサポートしていないメッセージを、メールサービスでどのように処理するかを示します。次のいずれかの値になります。 `UseSystemDefault` — システムのデフォルトが使用されます。 `Bounce` — メールサービスは、メッセージが却下された理由を説明する通知と共にメッセージを送信者に返します。 `Discard` — メールサービスは、送信者に通知せずにメッセージを破棄します。 `Requeue` — メールサービスは、次の 24 時間以内に処理するようにメッセージをキューに入れます。メッセージが 24 時間以内に処理されない場合は、メッセージが却下された理由を説明する通知と共に、メッセージを送信者に返します。
authorizationFailureAction	EmailServicesErrorAction (string 型の列挙)	必須。メールサービスまたはメールサービスアドレスの authorizedSenders 項目に設定されていない送信者から受信したメッセージを、メールサービスでどのように処理するかを示します。次のいずれかの値になります。 `UseSystemDefault` — システムのデフォルトが使用されます。 `Bounce` — メールサービスは、メッセージが却下された理由を説明する通知と共にメッセージを送信者に返します。 `Discard` — メールサービスは、送信者に通知せずにメッセージを破棄します。 `Requeue` — メールサービスは、次の 24 時間以内に処理するようにメッセージをキューに入れます。メッセージが 24 時間以内に処理されない場合は、メッセージが却下された理由を説明する通知と共に、メッセージを送信者に返します。
authorizedSenders	string	メールサービスを、この項目に一覧表示されたメールアドレスまたはドメインからのメッセージのみを受け取るよう設定します。メールサービスが、リストに記載されていないメールアドレスまたはドメインからのメッセージを受信すると、authorizationFailureAction 項目で指定されたアクションを実行します。メールサービスですべてのメールアドレスからのメールを受信する場合は、空白のままにしておきます。
emailServicesAddresses	EmailServicesAddress[]	EmailServiceAddress レコードのリスト。
errorRoutingAddress	email	isErrorRoutingEnabled が `true` の場合の、エラー通知メールメッセージの宛先のメールアドレス。
functionInactiveAction	EmailServicesErrorAction (string 型の列挙)	必須。メールサービス自体が無効なときに受信したメッセージを、メールサービスでどのように処理するかを示します。次のいずれかの値になります。 `UseSystemDefault` — システムのデフォルトが使用されます。 `Bounce` — メールサービスは、メッセージが却下された理由を説明する通知と共にメッセージを送信者に返します。 `Discard` — メールサービスは、送信者に通知せずにメッセージを破棄します。 `Requeue` — メールサービスは、次の 24 時間以内に処理するようにメッセージをキューに入れます。メッセージが 24 時間以内に処理されない場合は、メッセージが却下された理由を説明する通知と共に、メッセージを送信者に返します。
functionName	string	必須。API 内のメールサービスの名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。この 64 文字の項目の値には、最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目は自動的に生成されますが、API を使用してレコードを作成する場合は独自の値を指定できます。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。大規模データセットを作成する場合、必ずレコードごとに一意の functionName を指定してください。functionName が指定されていないと、Salesforce でレコードごとに functionName を生成している間にパフォーマンスが低下する可能性があります。メモ
isActive	boolean	このオブジェクトが有効か (`true`)、有効でないか (`false`) を示します。
isAuthenticationRequired	boolean	メールサービスを、メッセージを処理する前に送信サーバの妥当性を検証するよう設定します。メールサービスは SPF、SenderId、DomainKeys プロトコルを使用して、送信者の妥当性を検証します。送信サーバがこれらのプロトコルの少なくとも 1 つを渡し、1 つもエラーが発生しなかった場合、メールサービスはメールを受け入れます。サーバがプロトコルでエラーになった場合や、サーバがどのプロトコルもサポートしていない場合、メールサービスは、authenticationFailureAction 項目で指定されたアクションを実行します。
isErrorRoutingEnabled	boolean	受信メールメッセージを処理できない場合、エラー通知のメールメッセージを選択したアドレスに送信するか、または送信者に送信するかを示します。
isTextAttachmentsAsBinary	boolean	`true` の場合、テキスト形式の添付ファイルは `Messaging.TextAttachment` としてではなく `Messaging.BinaryAttachment` として Apex コードに提供されます。つまり、本文は Apex 文字列としてではなく Apex Blob として提供されます。
isTlsRequired	boolean	現在使用されていません。
overLimitAction	EmailServicesErrorAction (string 型の列挙)	必須。すべてのメールサービスを合わせた処理メッセージの合計数が組織の 1 日の制限値に達した場合、メールサービスでメッセージをどのように処理するかを示します。次のいずれかの値になります。 `UseSystemDefault` — システムのデフォルトが使用されます。 `Bounce` — メールサービスは、メッセージが却下された理由を説明する通知と共にメッセージを送信者に返します。 `Discard` — メールサービスは、送信者に通知せずにメッセージを破棄します。 `Requeue` — メールサービスは、次の 24 時間以内に処理するようにメッセージをキューに入れます。メッセージが 24 時間以内に処理されない場合は、メッセージが却下された理由を説明する通知と共に、メッセージを送信者に返します。制限値は、ユーザライセンス数 x 1,000 で算出されます。

EmailServicesAddress

各メールサービスには、メールアドレスが 1 つ以上あり、ユーザはそのアドレス宛てに処理を求めるメッセージを送信できます。メールサービスは、そのアドレスの 1 つが受信したメッセージを処理するだけです。

項目名	項目の型	説明
authorizedSenders	string	メールサービスアドレスを、この項目に一覧表示されたメールアドレスまたはドメインからのメッセージのみを受け取るよう設定します。メールサービスアドレスは、リストに記載されていないメールアドレスまたはドメインからのメッセージを受信すると、関連するメールサービスの authorizationFailureAction 項目で指定されたアクションを実行します。メールサービスアドレスですべてのメールアドレスからのメールを受信する場合は、空白のままにしておきます。
developerName	string	必須。API 内のオブジェクトの名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この 25 文字の項目は、同じ親 EmailServiceFunction の下にあるすべての EmailServicesAddress レコード間で一意である必要があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目は自動的に生成されますが、API を使用してレコードを作成する場合は独自の値を指定できます。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。大規模データセットを作成する場合、必ずレコードごとに一意の developerName を指定してください。developerName が指定されていないと、Salesforce でレコードごとに developerName を生成している間にパフォーマンスが低下する可能性があります。メモ
isActive	boolean	このオブジェクトが有効か (`true`)、有効でないか (`false`) を示します。
localPart	string	必須。メールサービスアドレスのローカル部分の、@ 記号の前の文字列。Salesforce メールアドレスのローカル部分には、すべての英数字を使用できるほか、次の特殊文字も使用できます。 ! # $ % & amp; ' * / = ? ^ _ + - ` { \| } ~ , 先頭または末尾の文字として使用しない限りは、ピリオド (.) も使用できます。メールアドレスでは、大文字と小文字は区別されません。
runAsUser	string	必須。このアドレスに送信されたメッセージを処理するときにメールサービスがどのユーザ (ユーザ名) の権限を引き受けるかを指定します。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。