Class SmtpInvitationDeliveryOptions
Namespace: Cephalon.MultiTenancy.Governance.SmtpDelivery.Configuration
Assembly: Cephalon.MultiTenancy.Governance.SmtpDelivery.dll
Configures SMTP relay delivery for tenant invitations dispatched by the governance companion pack.
public sealed class SmtpInvitationDeliveryOptionsInheritance
Section titled “Inheritance”object ← SmtpInvitationDeliveryOptions
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 SMTP sender sends one email message through a configured SMTP relay. It does not own provider-specific transactional-email APIs, bounce handling, delivery callbacks, or public onboarding flows.
Properties
Section titled “Properties”Enabled
Section titled “ Enabled”Gets or sets a value indicating whether the SMTP invitation sender should be registered.
public bool Enabled { get; set; }Property Value
Section titled “Property Value”FromAddress
Section titled “ FromAddress”Gets or sets the sender email address used in the SMTP message.
public string? FromAddress { get; set; }Property Value
Section titled “Property Value”FromDisplayName
Section titled “ FromDisplayName”Gets or sets the optional sender display name used in the SMTP message.
public string? FromDisplayName { get; set; }Property Value
Section titled “Property Value”Headers
Section titled “ Headers”Gets or sets additional SMTP message headers added to every delivery message.
public IReadOnlyDictionary<string, string> Headers { get; set; }Property Value
Section titled “Property Value”IReadOnlyDictionary<string, string>
Gets or sets the SMTP relay host name.
public string? Host { get; set; }Property Value
Section titled “Property Value”HtmlBodyTemplate
Section titled “ HtmlBodyTemplate”Gets or sets the optional HTML SMTP message body template.
public string? HtmlBodyTemplate { 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 SMTP message.
public bool IncludeContextHeaders { get; set; }Property Value
Section titled “Property Value”MessageIdDomain
Section titled “ MessageIdDomain”Gets or sets the domain used for deterministic SMTP Message-Id values.
public string MessageIdDomain { get; set; }Property Value
Section titled “Property Value”Password
Section titled “ Password”Gets or sets the SMTP password when the relay requires explicit credentials.
public string? Password { get; set; }Property Value
Section titled “Property Value”Gets or sets the SMTP relay port.
public int Port { get; set; }Property Value
Section titled “Property Value”RecipientAddressMetadataKey
Section titled “ RecipientAddressMetadataKey”Gets or sets the metadata key used to resolve the recipient email address when the invitee id is not an email address.
public string RecipientAddressMetadataKey { 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 SMTP 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 SMTP 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 SMTP send operation.
public int TimeoutSeconds { get; set; }Property Value
Section titled “Property Value”UseSsl
Section titled “ UseSsl”Gets or sets a value indicating whether SSL/TLS should be enabled for the SMTP relay connection.
public bool UseSsl { get; set; }Property Value
Section titled “Property Value”UserName
Section titled “ UserName”Gets or sets the SMTP username when the relay requires explicit credentials.
public string? UserName { get; set; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds SMTP invitation delivery options from configuration.
public static SmtpInvitationDeliveryOptions 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”The bound SMTP invitation delivery options.