ข้ามไปยังเนื้อหา

Class MailgunInvitationDeliveryOptions

เนื้อหานี้ยังไม่ได้แปลเป็นภาษาไทย แสดงเป็นภาษาอังกฤษแทน

Namespace: Cephalon.MultiTenancy.Governance.MailgunDelivery.Configuration
Assembly: Cephalon.MultiTenancy.Governance.MailgunDelivery.dll

Configures Mailgun Messages API delivery for tenant invitations dispatched by the governance companion pack.

public sealed class MailgunInvitationDeliveryOptions

objectMailgunInvitationDeliveryOptions

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

The Mailgun sender posts one multipart Messages API request to Mailgun. It does not own Mailgun webhook callbacks, bounce translation, provider polling, public onboarding, SMS, chat, CRM, or identity-provider invitation flows.

Initializes a new instance of the class.

public MailgunInvitationDeliveryOptions()

Gets or sets response status codes that indicate the Mailgun API accepted the request.

public IReadOnlyList<int> AcceptedStatusCodes { get; set; }

IReadOnlyList<int>

The default accepts 200 OK, which Mailgun returns when a message is queued.

Gets or sets the Mailgun private API key used with basic authentication.

public string? ApiKey { get; set; }

string?

Gets or sets the Mailgun API base URL.

public string BaseUrl { get; set; }

string

The default is the US endpoint. Hosts that use EU regional sending can set this value to https://api.eu.mailgun.net.

Gets or sets the Mailgun sending domain name used in the Messages API route.

public string? DomainName { get; set; }

string?

Gets or sets a value indicating whether Mailgun test mode should be enabled through o:testmode=yes.

public bool EnableTestMode { get; set; }

bool

Gets or sets a value indicating whether the Mailgun invitation sender should be registered.

public bool Enabled { get; set; }

bool

Gets or sets the sender email address used in the Mailgun message.

public string? FromEmail { get; set; }

string?

Gets or sets the optional sender display name used in the Mailgun message.

public string? FromName { get; set; }

string?

Gets or sets additional Mailgun custom headers added through h:* form fields.

public IReadOnlyDictionary<string, string> Headers { get; set; }

IReadOnlyDictionary<string, string>

The sender filters empty, multi-line, and message-core headers before sending.

Gets or sets the optional HTML Mailgun message body template.

public string? HtmlBodyTemplate { get; set; }

string?

Gets or sets a value indicating whether safe Cephalon custom headers should be added to the Mailgun request.

public bool IncludeContextHeaders { get; set; }

bool

Gets or sets a value indicating whether safe Cephalon user variables should be added to the Mailgun request.

public bool IncludeContextVariables { get; set; }

bool

Gets or sets the JSON property name that contains the Mailgun provider message identifier.

public string ProviderMessageIdJsonPropertyName { get; set; }

string

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; }

string

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.

Gets or sets the sender identifier used by TenantInvitationDeliveryRequest.SenderId.

public string SenderId { get; set; }

string

Gets or sets the Mailgun message subject template.

public string SubjectTemplate { get; set; }

string

Gets or sets delivery channels accepted by this sender.

public IReadOnlyList<string> SupportedChannels { get; set; }

IReadOnlyList<string>

When empty, the sender accepts every requested channel.

Gets or sets Mailgun message tags added through o:tag form fields.

public IReadOnlyList<string> Tags { get; set; }

IReadOnlyList<string>

Gets or sets the plain-text Mailgun message body template.

public string TextBodyTemplate { get; set; }

string

Gets or sets the maximum time allowed for the Mailgun API request.

public int TimeoutSeconds { get; set; }

int

Gets or sets Mailgun user variables added through v:* form fields.

public IReadOnlyDictionary<string, string> Variables { get; set; }

IReadOnlyDictionary<string, string>

These values are sent to Mailgun and may appear in provider activity or webhook data. Do not put secrets here.

FromConfiguration(IConfiguration, string)

Section titled “ FromConfiguration(IConfiguration, string)”

Binds Mailgun invitation delivery options from configuration.

public static MailgunInvitationDeliveryOptions FromConfiguration(IConfiguration configuration, string sectionPath = "Engine")

configuration IConfiguration

The application configuration root.

sectionPath string

The configuration section path that contains the engine settings. The default is Engine.

MailgunInvitationDeliveryOptions

The bound Mailgun invitation delivery options.