Class EmailHandler

Namespace

Dynamicweb.Mailing

Assembly

Dynamicweb.Core.dll

Provides static members for sending e-mails with logging and Dynamicweb system settings for mail servers.

public sealed class EmailHandler

Inheritance

object

EmailHandler

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

using System.Net.Mail;
using System.Text;
using Dynamicweb.Logging;

namespace Dynamicweb.Mailing.Examples;

public static class EmailHandlerSample
{
    public static void SendMail()
    {
        bool sendSucceded;

        using (var mailMessage = new MailMessage())
        {
            mailMessage.Subject = "This is a test mail";
            mailMessage.From = new MailAddress(EmailHandler.SystemMailFromAddress(), "John Doe");
            mailMessage.To.Add("someone@gmail.com");
            mailMessage.IsBodyHtml = true;
            mailMessage.Body = "<h1>Hi John</h1>Here is your message.";
            mailMessage.BodyEncoding = Encoding.UTF8;
            mailMessage.SubjectEncoding = Encoding.UTF8;
            mailMessage.HeadersEncoding = Encoding.UTF8;

            sendSucceded = EmailHandler.Send(mailMessage);
        }

        if (sendSucceded)
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails").Info("Mail successfully sent");
        }
        else
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails/Error").Error(("ERROR: Mail not sent"));
        }
    }
}

Remarks

Uses dropfolder if possible - otherwise fall back to direct SMTP protocol. Log can be found in /Files/Filer/MailLog/.NET/

Properties

DefaultSmtpServer

Returns the first SMTP server from the control panel if more then one.

public static string DefaultSmtpServer { get; }

Property Value

string

Methods

GetEncodingByName(string)

Returns an encoding associated with the specified code page name.

public static Encoding GetEncodingByName(string encoding)

Parameters

encoding string

The code page name of the preferred encoding, i.e. "utf-8".

Returns

Encoding

SaveMail(string, MailMessage)

Saves the MailMessage to the specified folder and returns the name of the file.

public static string SaveMail(string folder, MailMessage mailObj)

Parameters

folder string

The folder to save the MailMessage in.

mailObj MailMessage

The MailMessage to save.

Returns

string

The name of the saved file.

SaveMail(string, MailMessage, bool)

Saves the MailMessage to the specified folder and returns the name of the file.

public static string SaveMail(string saveFolder, MailMessage mailObj, bool returnFileName)

Parameters

saveFolder string

The folder to save the MailMessage in.

mailObj MailMessage

The MailMessage to save.

returnFileName bool

Indicates whether to return the name of the saved file. Not returning the name will increase performance inside loops considerably.

Returns

string

The name of the saved file or String.Empty depending on the returnFileName parameter.

Send(MailMessage)

Sends the specified mail message.

public static bool Send(MailMessage mailMessage)

Parameters

mailMessage MailMessage

The mail message.

Returns

bool

true if send was succesful; otherwise false.

Examples

using System.Net.Mail;
using System.Text;
using Dynamicweb.Logging;

namespace Dynamicweb.Mailing.Examples;

public static class EmailHandlerSample
{
    public static void SendMail()
    {
        bool sendSucceded;

        using (var mailMessage = new MailMessage())
        {
            mailMessage.Subject = "This is a test mail";
            mailMessage.From = new MailAddress(EmailHandler.SystemMailFromAddress(), "John Doe");
            mailMessage.To.Add("someone@gmail.com");
            mailMessage.IsBodyHtml = true;
            mailMessage.Body = "<h1>Hi John</h1>Here is your message.";
            mailMessage.BodyEncoding = Encoding.UTF8;
            mailMessage.SubjectEncoding = Encoding.UTF8;
            mailMessage.HeadersEncoding = Encoding.UTF8;

            sendSucceded = EmailHandler.Send(mailMessage);
        }

        if (sendSucceded)
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails").Info("Mail successfully sent");
        }
        else
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails/Error").Error(("ERROR: Mail not sent"));
        }
    }
}

Exceptions

EmailException

Thrown when email sending fails.

Send(MailMessage, bool)

Sends the specified mail message.

public static bool Send(MailMessage mailMessage, bool logging)

Parameters

mailMessage MailMessage

The mail message.

logging bool

Specifies whether logging should take place. Default is true.

Returns

bool

true if send was succesful; otherwise false.

Examples

using System.Net.Mail;
using System.Text;
using Dynamicweb.Logging;

namespace Dynamicweb.Mailing.Examples;

public static class EmailHandlerSample
{
    public static void SendMail()
    {
        bool sendSucceded;

        using (var mailMessage = new MailMessage())
        {
            mailMessage.Subject = "This is a test mail";
            mailMessage.From = new MailAddress(EmailHandler.SystemMailFromAddress(), "John Doe");
            mailMessage.To.Add("someone@gmail.com");
            mailMessage.IsBodyHtml = true;
            mailMessage.Body = "<h1>Hi John</h1>Here is your message.";
            mailMessage.BodyEncoding = Encoding.UTF8;
            mailMessage.SubjectEncoding = Encoding.UTF8;
            mailMessage.HeadersEncoding = Encoding.UTF8;

            sendSucceded = EmailHandler.Send(mailMessage);
        }

        if (sendSucceded)
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails").Info("Mail successfully sent");
        }
        else
        {
            //Log to /Files/System/Log/MyMails
            LogManager.Current.GetLogger("/MyMails/Error").Error(("ERROR: Mail not sent"));
        }
    }
}

Exceptions

EmailException

Thrown when email sending fails.

ArgumentNullException

Thrown when mailMessage is null.

Send(MailMessage, bool, string, string, int, bool, string)

Sends the specified mail message.

public static bool Send(MailMessage mailMessage, bool logging, string username, string password, int port, bool useSsl, string host)

Parameters

mailMessage MailMessage

The mail message.

logging bool

Specifies whether logging should take place. Default is true.

username string

Specifies a username for the smpt server. Password must also be specified, otherwise ignored.

password string

Password for the username specified.

port int

The SMTP server port. Default is 25.

useSsl bool

Specifies whether the connection should use SSL or not.

host string

The list of smtp host to try - seperate by ;

Returns

bool

true if send was succesful; otherwise false.

Send(MailMessage, string)

Sends the specified mail message, if the given key has not already been used.

public static bool Send(MailMessage mailMessage, string key)

Parameters

mailMessage MailMessage

The mail message.

key string

The key identifying previously sent emails.

Returns

bool

true if email was send succesfully; otherwise false.

SendTestMail(SmtpOptions)

Send email to test smtp mail settings

public static ApplicationResponse<string> SendTestMail(SmtpOptions options)

Parameters

options SmtpOptions

Configuration options for SMTP

Returns

ApplicationResponse<string>

SendTestMail(string, string, string, int, bool)

Send email to test smtp mail settings

public static ApplicationResponse<string> SendTestMail(string username, string password, string hostname, int port, bool useSsl)

Parameters

username string

User name

password string

Password

hostname string

Host name

port int

Port

useSsl bool

Use SSL or not

Returns

ApplicationResponse<string>

SystemMailFrom()

Gets the system email address from settings for use as mail from for system emails

public static MailAddress SystemMailFrom()

Returns

MailAddress

The email address found in /Globalsettings/Settings/CommonInformation/Email if it is valide, otherwise noreply@dynamicweb.dk

SystemMailFromAddress()

Gets the system email address from settings for use as mail from for system emails

public static string SystemMailFromAddress()

Returns

string

The email address found in /Globalsettings/Settings/CommonInformation/Email if it is valide, otherwise noreply@dynamicweb.dk

TrySend(MailMessage, bool)

Attempts to send an email message without throwing exceptions on failure.

public static bool TrySend(MailMessage mailMessage, bool logging = true)

Parameters

mailMessage MailMessage

The mail message.

logging bool

Specifies whether logging should take place. Default is true.

Returns

bool

true if send was succesful; otherwise false.