kCura.Notification.Email

Email

public class Email

Provides the ability to send notification emails for Errors, User Passwords, Analytics categorization sets, Productions and generic MailMessages.

Documentation

public enum AgentSuccess

A yes/no enumaration determining whether an agent succeeded.

public enum BodyFormat

An enumeration of possible email body formats.

public static Email Instance { get; }

Gets the singleton instance of Email.

protected Email()

Initializes a new instance of Email.

public Email(IConfig configuration, SmtpClientWrapperFactory smtpClientWrapperFactory)

Constructs a new email mailer that pulls its configuration values from the provided instead of the default.

public static string GetErrorMessageText()

Gets the error message template text.

public void SendAutoGeneratedPasswordNotification(string to, string from, string subject, string body, string userEmail, string url, string password)

Sends an auto-generated password notification email to the configured SMTP server.

public void SendCACategorizationNotification(string from, string to, string catName, string workspaceName, AgentSuccess success, bool hasErrors, string errMessage)

Sends a analytics categorization email using the configured SMTP server.

public void SendCASearchNotification(string from, string to, string indexName, string caseName, AgentSuccess success, string jobTypeMessage, bool stopped, bool hasErrors, string additionalInformation = null)

Sends an analytics search email using the configured SMTP server.

public void SendErrorNotification(string user, DateTime dateTime, string exceptionFullText, string emailTo)

Sends an error notification using the configured SMTP server.

public void SendErrorNotification(string user, DateTime dateTime, string exceptionFullText)

Sends an error notification using the configured SMTP server with the configured EmailTo recipient.

public virtual void SendNotification(string from, string to, string subject, string messageText)

Sends a plaintext email using the configured SMTP server.

public virtual void SendNotification(EmailOption emailOptions)

Sends an email using the configured SMTP server.

public void SendNotification(string from, string to, string subject, string messageText, BodyFormat bodyFormat)

Sends a notification email using the configured SMTP server.

public void SendNotification(MailMessage mail)

Sends a notification email using the configured SMTP server.

public virtual void SendNotificationHTML(string from, string to, string subject, string messageText)

Sends an HTML email using the configured SMTP server.

public void SendProductionNotification(string from, string to, string prodName, string caseName, AgentSuccess success, bool fatal)

Send a production notification email using the configured SMTP server.

public void SendSelfServePasswordResetCompleteNotification(string to, string from, string subject, string body, string userEmail, string loginLinkHTML, string loginLink)

Sends a self-serve password reset completed email using the configured SMTP server.

public void SendSelfServePasswordResetRequestNotification(string to, string from, string subject, string body, string userEmail, string resetLinkHTML, string resetLink)

Sends a self-serve password reset request email using the configured SMTP server.

public bool VerifyConnectionSettings()

Verifies the validity of the connection to the configured SMTP server by ensuring a connection can be made, and ServiceReady is received when sending the SMTP EHLO message.