Package com.veeva.vault.sdk.api.email

Interface EmailProcessor

All Superinterfaces:
com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<EmailProcessorContext>
public interface EmailProcessor extends com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<EmailProcessorContext>
Defines the entry point for a custom email processor. Custom email processors contain custom business logic to perform actions when your Vault receives email. Learn more about email processing in Vault Help.

A class that implements this interface and is annotated with EmailProcessorInfo becomes a configurable component in Vault that can be triggered by an inbound email.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(EmailProcessorContext emailProcessorContext)
    Contains the business logic for processing an inbound email.

  • Method Details

    • execute

      void execute(EmailProcessorContext emailProcessorContext)
      Contains the business logic for processing an inbound email.

      This method is executed when an email is received by a configured Inbound Email Address. If an unhandled exception is thrown from this method, the current transaction is rolled back, and the email__sys object record associated with the EmailItem automatically transitions to the FAILED lifecycle state.

      Parameters:
      emailProcessorContext - The context for the current execution, which provides access to the EmailItem and other metadata.