EmailServicesFunction

An email service.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields

Field Details
AddressInactiveAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates what the email service does with messages received at an email address that is inactive.
One of the following values:
  • 0—The system default is used.
  • 1—The email service returns the message to the sender with a notification that explains why the message was rejected.
  • 2—The email service deletes the message without notifying the sender.
  • 3—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected.
ApexClassId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required. The ID of the Apex class that the email service uses to process inbound messages.

This field is required for API version 12.0 and later.

AttachmentOption
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates the types of attachments the email service accepts. One of the following values:
  • 0—The email service accepts the message but discards any attachment.
  • 1—The email service only accepts the following types of attachments:
    • Attachments with a Multipurpose Internet Mail Extension (MIME) type of text.
    • Attachments with a MIME type of application/octet-stream and a file name that ends with either a .vcf or .vcs extension. These are saved as text/x-vcard and text/calendar MIME types, respectively.
  • 2—The email service only accepts binary attachments, such as image, audio, application, and video files.
  • 3—The email service accepts any type of attachment.
AuthenticationFailureAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates what the email service does with messages that fail or do not support any of the authentication protocols if the IsAuthenticationRequired field is true.
One of the following values:
  • 0—The system default is used.
  • 1—The email service returns the message to the sender with a notification that explains why the message was rejected.
  • 2—The email service deletes the message without notifying the sender.
  • 3—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected.
AuthorizationFailureAction
Type
picklist
Properties
Group, Sort, Create, Filter, Nillable, Restricted picklist, Update
Description
Indicates what the email service does with messages received from senders who are not listed in the AuthorizedSenders field on either the email service or email service address.
One of the following values:
  • 0—The system default is used.
  • 1—The email service returns the message to the sender with a notification that explains why the message was rejected.
  • 2—The email service deletes the message without notifying the sender.
  • 3—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected.
AuthorizedSenders
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Configures the email service to only accept messages from the email addresses or domains listed in this field. If the email service receives a message from an unlisted email address or domain, the email service performs the action specified in the AuthorizationFailureAction field. Leave this field blank if you want the email service to receive email from any email address.
ErrorRoutingAddress
Type
email
Properties
Create, Filter, Nillable, Sort, Update
Description
The destination email address for error notification email messages when IsErrorRoutingEnabled is true.
FunctionInactiveAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates what the email service does with messages it receives when the email service itself is inactive.
One of the following values:
  • 0—The system default is used.
  • 1—The email service returns the message to the sender with a notification that explains why the message was rejected.
  • 2—The email service deletes the message without notifying the sender.
  • 3—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected.
FunctionName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The name of the email service.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this object is active (true) or not (false).
IsAuthenticationRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Configures the email service to verify the legitimacy of the sending server before processing a message. The email service uses the SPF, SenderId, and DomainKeys protocols to verify the sender's legitimacy: If the sending server passes at least one of these protocols and does not fail any, the email service accepts the email. If the server fails a protocol or does not support any of the protocols, the email service performs the action specified in the AuthenticationFailureAction field.
IsErrorRoutingEnabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
When incoming email messages can’t be processed, indicates whether error notification email messages are routed to a chosen address or to the senders.
IsTextAttachmentsAsBinary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the email service converts text attachments to binary files.
IsTextTruncated
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
This field is deprecated. It is not available as of API version 23.0 and is deprecated and hidden in versions 17.0 through 22.0. In all API versions, the email service now accepts inbound email messages up to the 10 MB size limit, without truncating the text. Previously, it indicated whether the email service truncated and accepted email messages with HTML body text, plain body text, and text attachments over approximately 100,000 characters (true) or rejected these email messages and notified the sender (false).
IsTlsRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Configures the email service to use Transport Layer Security (TLS), a protocol for secure email communication, to ensure the security and authenticity of inbound email.
OverLimitAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates what the email service does with messages if the total number of messages processed by all email services combined has reached the daily limit for your organization.
One of the following values:
  • 0—The system default is used.
  • 1—The email service returns the message to the sender with a notification that explains why the message was rejected.
  • 2—The email service deletes the message without notifying the sender.
  • 3—The email service queues the message for processing in the next 24 hours. If the message is not processed within 24 hours, the email service returns the message to the sender with a notification that explains why the message was rejected.

The system calculates the limit by multiplying the number of user licenses by 1,000.

Usage

This object supports the email services feature, which allows you to create automated processes that use Apex classes to process the contents, headers, and attachments of inbound email. For example, you can create an email service that automatically creates contact records based on contact information in messages.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.