Skip to content

Class: metadata

When configuring Email to Vault, Admins use Inbound Email Addresses to create and manage Vault-owned email addresses and define the Email Processor with which to create documents, attachments, or object records from the email.

Learn more about Email to Vault in Vault Help.

AttributeMetadataDescription
labelType: String
Max length: 60
UI-friendly string in the Vault's base language.
activeType: BooleanIndicates whether the component is active.
allowed_sender_groupsType: String
Max length: 1500
Multi-value
If allowed_senders = VAULT_Groups, stores the groups whose users are allowed to send emails to this address. There is a maximum of five groups.
allowed_sendersType: Enum
Required
Allowed values:
  • VAULT_USERS_AND_PERSONS
  • VAULT_USERS
  • VAULT_GROUPS
  • UNSPECIFIED
Indicates the type of senders from whom this inbound email address can receive emails.
authenticate_senderType: BooleanIf true, Vault checks the sender’s authenticity via Sender Policy Framework (SPF) and DomainKeys Identified Mail (DKIM). Can only be set to false for certain Veeva-provided email processors. Use caution when setting to false as unauthenticated emails may come from spoofed addresses. Must always be set to true if allowed_senders = VAULT_USERS or VAULT_GROUPS.
descriptionType: String
Max length: 1500
A general description of the inbound email address.
email_processorType: ComponentReference
Required
The email processor to run when an email is sent to this address.
email_processor_userType: String
Max length: 255
The default originating user when the sender’s email address does not belong to a user in this Vault. If run_as_processor_user is true, this inbound email address uses this email_processor_user even when the sender's email address belongs to a Vault User.
email_usernameType: String
Required
Max length: 64
The username of the inbound email address, for example, inquiries in inquiries@verteopharma.veevavault.com.
run_as_processor_userType: BooleanIndicates if this inbound email address’ email_processor always runs as the email_processor_user, even if the sender's email address belongs to a Vault User. Can only be true for inbound email addresses where the allowed_senders are either VAULT_USERS_AND_PERSONS or UNSPECIFIED.
send_bounce_notificationType: BooleanIf true, Vault sends a notification to the User or Person sender when an Email record created from their email enters the Bounced state.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Alter: MDL Operation may not be supported for some multi-value attributes.