EmailRelay

Represents the configuration for sending an email relay. An email relay routes email sent from Salesforce through your company’s email servers.

Introduced in API version 43.0.

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

  • You must have the Email Administration, Customize Application, and View Setup user permissions to use this object.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 52.0

  • Description:

    Specifies which SASL mechanism Salesforce uses for SMTP authentication. This field is available when Enable SMTP Auth is selected. Select an option:

    • PLAIN- Salesforce uses PLAIN SASL mechanism for SMTP authentication. Default.
    • LOGIN- Salesforce uses LOGIN SASL mechanism for SMTP authentication

    This field is available in API version 52.0 and later.

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Indicates the host name or IP address of your company’s SMTP server.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 68.0
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 44.0
  • Description: Indicates whether (true) or not (false) authentication is required. When setting this field to true, the TlsSetting must be set to **RequiredVerify**.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 68.0
  • Type: encryptedstring
  • Properties: Create, Nillable, Update
  • Introduced: API version 44.0
  • Description: Specifies the password for relay host STMP authentication. When IsRequireAuth is set to true, this field is required.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 68.0

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description:

    Indicates the port number of your company’s SMTP server.

    • 25
    • 587
    • 10025
    • 11025
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Introduced: API version 68.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies whether Salesforce uses TLS for SMTP sessions.
  • Possible values:
    • Off — Off
    • Preferred — Preferred
    • Required — Required
    • PreferredVerify — PreferredVerify
    • RequiredVerify — RequiredVerify
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 44.0
  • Description: Specifies the username for relay host STMP authentication. When IsRequireAuth is set to true, this field is required.

An email relay must be associated with an active email domain filter to take effect. If you set up multiple email relays in one org, they are processed in the priority order of their email domain filters.

If you also plan to activate Bounce Management and Email Compliance Management, confirm with your email admin that your company allows relaying email sent from Salesforce. For more information on bounce management, see Configure Deliverability Settings for Emails Sent from Salesforce.