EmailHelper Class

E-mail utility methods.

Inheritance Hierarchy

System.Object
  CMS.EmailEngine.EmailHelper

Namespace: CMS.EmailEngine
Assembly: CMS.EmailEngine (in CMS.EmailEngine.dll) Version: 13.0.131

Syntax

public static class EmailHelper

The EmailHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	DEFAULT_EMAIL_SENDER	E-mail used as default sender

Properties

	Name	Description
Public property Static member	DebugEmails	Gets if the debug mode is active. Default value is false. If the debug mode is on, the e-mail sending thread sleeps for 500-1000ms instead of actually sending the e-mail. The setting may be changed via web.config app-key "CMSDebugEmails".
Public property Static member	LogEmails	If true, sent e-mails are logged to the file. Default value is false. The setting may be changed via web.config app-key "CMSLogEmails".
Public property Static member	LogFile	Path to the log file if logging is enabled, see LogEmails property.
Public property Static member	SimulateFailedEmails	Gets if the simulation of send failures is active during debug mode (see DebugEmails property). Default value is false. If true, and exception is thrown when trying to send an e-mail. The setting may be changed via web.config app-key "CMSSimulateFailedEmails".
Public property Static member	TransferEncoding	E-mail transfer encoding. Default value is TransferEncoding.Base64. The setting may be changed via web.config app-key "CMSEmailTransferEncoding".

Methods

	Name	Description
Public method Static member	GetEmailFormat(Int32)	Gets the e-mail format for the site given its site ID.
Public method Static member	GetEmailFormat(String)	Gets the e-mail format for the site given its site name.
Public method Static member	GetReplyToEmailAddress	Returns ReplyTo e-mail address from message (internally handles .NET 4.0 backward compatibility).
Public method Static member	GetSender	Returns e-mail sender from template, if defined or specified sender.
Public method Static member	GetSubject	Returns e-mail subject from template, if defined or default subject.
Public method Static member	GetTransferEncoding	Gets the transfer encoding enumeration.
Public method Static member	IsAnySendingEnabled	Returns if e-mail sending is enabled in either global or any site settings.
Public method Static member	ResolveMetaFileImages(EmailMessage, IEnumerable<MetaFileInfo>)	Appends all attached files to given email. Replaces link 'src="...GetMetaFile.aspx?...fileguid=..."' or 'src=".../GetMetaFile/..." with link to e-mail in-line attachments (only for images).
Public method Static member	ResolveMetaFileImages(EmailMessage, Int32, String, String)	Appends all attached files to given email. Replaces link 'src="...GetMetaFile.aspx?...fileguid=..."' or 'src=".../GetMetaFile/..." with link to e-mail in-line attachments (only for images).
Public method Static member	SetReplyToEmailAddress	Sets ReplyTo e-mail address of the given message (internally handles .NET 4.0 backward compatibility).
Public method Static member	ToEmailPriority	Obsolete. Converts a MailPriority value to EmailPriorityEnum value.
Public method Static member	ToMailPriority	Obsolete. Converts a EmailPriorityEnum value to MailPriority value.