Class SendGridInvitationDeliveryOptions
Namespace: Cephalon.MultiTenancy.Governance.SendGridDelivery.Configuration
Assembly: Cephalon.MultiTenancy.Governance.SendGridDelivery.dll
Configures SendGrid Mail Send API delivery for tenant invitations dispatched by the governance companion pack.
public sealed class SendGridInvitationDeliveryOptionsInheritance
Section titled “Inheritance”object ← SendGridInvitationDeliveryOptions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”The SendGrid sender sends one transactional email request to the SendGrid Mail Send API. It does not own SendGrid Event Webhook callbacks, bounce translation, provider polling, public onboarding, SMS, chat, CRM, or identity-provider invitation flows.
Constructors
Section titled “Constructors”SendGridInvitationDeliveryOptions()
Section titled “ SendGridInvitationDeliveryOptions()”Initializes a new instance of the
public SendGridInvitationDeliveryOptions()Properties
Section titled “Properties”AcceptedStatusCodes
Section titled “ AcceptedStatusCodes”Gets or sets response status codes that indicate the SendGrid API accepted the request.
public IReadOnlyList<int> AcceptedStatusCodes { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The default accepts 202 Accepted. When sandbox mode is enabled, 200 OK is also accepted.
ApiKey
Section titled “ ApiKey”Gets or sets the SendGrid API key used as the bearer token.
public string? ApiKey { get; set; }Property Value
Section titled “Property Value”BaseUrl
Section titled “ BaseUrl”Gets or sets the SendGrid v3 API base URL.
public string BaseUrl { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The default is the global SendGrid endpoint. Hosts that use EU regional sending can set this value to
https://api.eu.sendgrid.com.
Categories
Section titled “ Categories”Gets or sets SendGrid message categories added to each request.
public IReadOnlyList<string> Categories { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”SendGrid allows up to ten category names. Values beyond that limit are ignored by the sender.
CustomArgs
Section titled “ CustomArgs”Gets or sets SendGrid custom arguments added to each personalization.
public IReadOnlyDictionary<string, string> CustomArgs { get; set; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Remarks
Section titled “Remarks”These values are sent to SendGrid and may appear in provider activity or webhook data. Do not put secrets here.
EnableSandboxMode
Section titled “ EnableSandboxMode”Gets or sets a value indicating whether SendGrid sandbox mode should be enabled.
public bool EnableSandboxMode { get; set; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Gets or sets a value indicating whether the SendGrid invitation sender should be registered.
public bool Enabled { get; set; }Property Value
Section titled “Property Value”FromEmail
Section titled “ FromEmail”Gets or sets the verified sender email address used in the SendGrid message.
public string? FromEmail { get; set; }Property Value
Section titled “Property Value”FromName
Section titled “ FromName”Gets or sets the optional sender display name used in the SendGrid message.
public string? FromName { get; set; }Property Value
Section titled “Property Value”Headers
Section titled “ Headers”Gets or sets additional SendGrid message headers added to each request.
public IReadOnlyDictionary<string, string> Headers { get; set; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Remarks
Section titled “Remarks”The sender filters empty, multi-line, and SendGrid-reserved headers before sending.
HtmlBodyTemplate
Section titled “ HtmlBodyTemplate”Gets or sets the optional HTML SendGrid message body template.
public string? HtmlBodyTemplate { get; set; }Property Value
Section titled “Property Value”IncludeContextCustomArgs
Section titled “ IncludeContextCustomArgs”Gets or sets a value indicating whether safe Cephalon custom arguments should be added to the SendGrid request.
public bool IncludeContextCustomArgs { get; set; }Property Value
Section titled “Property Value”IncludeContextHeaders
Section titled “ IncludeContextHeaders”Gets or sets a value indicating whether safe Cephalon context headers should be added to the SendGrid request.
public bool IncludeContextHeaders { get; set; }Property Value
Section titled “Property Value”ProviderMessageIdHeaderName
Section titled “ ProviderMessageIdHeaderName”Gets or sets the SendGrid response header that contains the provider message identifier.
public string ProviderMessageIdHeaderName { get; set; }Property Value
Section titled “Property Value”RecipientEmailMetadataKey
Section titled “ RecipientEmailMetadataKey”Gets or sets the metadata key used to resolve the recipient email address when the invitee id is not an email address.
public string RecipientEmailMetadataKey { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The sender checks dispatch metadata first and invitation metadata second. If neither contains a value and
InviteeKind is email, the invitee id is treated as the recipient address.
SenderId
Section titled “ SenderId”Gets or sets the sender identifier used by TenantInvitationDeliveryRequest.SenderId.
public string SenderId { get; set; }Property Value
Section titled “Property Value”SubjectTemplate
Section titled “ SubjectTemplate”Gets or sets the SendGrid message subject template.
public string SubjectTemplate { get; set; }Property Value
Section titled “Property Value”SupportedChannels
Section titled “ SupportedChannels”Gets or sets delivery channels accepted by this sender.
public IReadOnlyList<string> SupportedChannels { get; set; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”When empty, the sender accepts every requested channel.
TextBodyTemplate
Section titled “ TextBodyTemplate”Gets or sets the plain-text SendGrid message body template.
public string TextBodyTemplate { get; set; }Property Value
Section titled “Property Value”TimeoutSeconds
Section titled “ TimeoutSeconds”Gets or sets the maximum time allowed for the SendGrid API request.
public int TimeoutSeconds { get; set; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds SendGrid invitation delivery options from configuration.
public static SendGridInvitationDeliveryOptions FromConfiguration(IConfiguration configuration, string sectionPath = "Engine")Parameters
Section titled “Parameters”configuration IConfiguration
The application configuration root.
sectionPath string
The configuration section path that contains the engine settings. The default is Engine.
Returns
Section titled “Returns”SendGridInvitationDeliveryOptions
The bound SendGrid invitation delivery options.