Class Mail

Inheritance

object

Mail

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Services.Mail

Assembly: DotNetNuke.dll

Syntax

public class Mail

Constructors

Mail()

Declaration

public Mail()

Methods

ConvertToText(string)

Declaration

public static string ConvertToText(string sHTML)

Parameters

Type	Name	Description
string	sHTML

Returns

Type	Description
string

IsValidEmailAddress(string, int)

Declaration

public static bool IsValidEmailAddress(string email, int portalid)

Parameters

Type	Name	Description
string	email
int	portalid

Returns

Type	Description
bool

SendEmail(string, string, string, string)

Declaration

public static void SendEmail(string fromAddress, string toAddress, string subject, string body)

Parameters

Type	Name	Description
string	fromAddress
string	toAddress
string	subject
string	body

SendEmail(string, string, string, string, string)

Declaration

public static void SendEmail(string fromAddress, string senderAddress, string toAddress, string subject, string body)

Parameters

Type	Name	Description
string	fromAddress
string	senderAddress
string	toAddress
string	subject
string	body

SendEmail(string, string, string, string, string, ICollection<MailAttachment>)

Declaration

public static string SendEmail(string fromAddress, string senderAddress, string toAddress, string subject, string body, ICollection<MailAttachment> attachments)

Parameters

Type	Name	Description
string	fromAddress
string	senderAddress
string	toAddress
string	subject
string	body
ICollection<MailAttachment>	attachments

Returns

Type	Description
string

SendEmail(string, string, string, string, string, List<Attachment>)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.0. Please use SendEmail() with ICollection<MailAttachment>. Scheduled for removal in v11.0.0.")]
public static string SendEmail(string fromAddress, string senderAddress, string toAddress, string subject, string body, List<Attachment> attachments)

Parameters

Type	Name	Description
string	fromAddress
string	senderAddress
string	toAddress
string	subject
string	body
List<Attachment>	attachments

Returns

Type	Description
string

SendMail(UserInfo, MessageType, PortalSettings)

Declaration

public static string SendMail(UserInfo user, MessageType msgType, PortalSettings settings)

Parameters

Type	Name	Description
UserInfo	user
MessageType	msgType
PortalSettings	settings

Returns

Type	Description
string

SendMail(int, int, MessageType, PortalSettings)

Declaration

public static string SendMail(int portalId, int userId, MessageType msgType, PortalSettings settings)

Parameters

Type	Name	Description
int	portalId
int	userId
MessageType	msgType
PortalSettings	settings

Returns

Type	Description
string

SendMail(string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string, string, string, string, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string attachment, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string	attachment
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword

Returns

Type	Description
string

SendMail(string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string, string, string, string, string, bool)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string attachment, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string	attachment
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string, string, string, string, string, bool, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string attachment, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string	attachment
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string[], string, string, string, string, bool)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string[] attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string[]	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string[], string, string, string, string, bool, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string[] attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string[]	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, ICollection<MailAttachment>, string, string, string, string, bool)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, ICollection<MailAttachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
ICollection<MailAttachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, ICollection<MailAttachment>, string, string, string, string, bool, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, ICollection<MailAttachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
ICollection<MailAttachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, List<Attachment>, string, string, string, string, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.0. Please use SendEmail() with ICollection<MailAttachment>. Scheduled for removal in v11.0.0.")]
public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, List<Attachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
List<Attachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, List<Attachment>, string, string, string, string, bool, string)

Declaration

[Obsolete("This method has been deprecated. Please use SendEmail() with ICollection<MailAttachment> Scheduled removal in v11.0.0.")]
public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, List<Attachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
List<Attachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string[], string, string, string, string, bool)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string[] attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string[]	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, string[], string, string, string, string, bool, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, string[] attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
string[]	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, ICollection<MailAttachment>, string, string, string, string, bool)

Declaration

public static string SendMail(string mailFrom, string mailSender, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, ICollection<MailAttachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailSender
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
ICollection<MailAttachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, ICollection<MailAttachment>, string, string, string, string, bool, string)

Declaration

public static string SendMail(string mailFrom, string mailSender, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, ICollection<MailAttachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailSender
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
ICollection<MailAttachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, List<Attachment>, string, string, string, string, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.0. Please use SendEmail() with ICollection<MailAttachment>. Scheduled for removal in v11.0.0.")]
public static string SendMail(string mailFrom, string mailSender, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, List<Attachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL)

Parameters

Type	Name	Description
string	mailFrom
string	mailSender
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
List<Attachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL

Returns

Type	Description
string

SendMail(string, string, string, string, string, string, MailPriority, string, MailFormat, Encoding, string, List<Attachment>, string, string, string, string, bool, string)

Declaration

[Obsolete("This method has been deprecated. Please use SendEmail() with ICollection<MailAttachment> Scheduled removal in v11.0.0.")]
public static string SendMail(string mailFrom, string mailSender, string mailTo, string cc, string bcc, string replyTo, MailPriority priority, string subject, MailFormat bodyFormat, Encoding bodyEncoding, string body, List<Attachment> attachments, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword, bool smtpEnableSSL, string authProvider)

Parameters

Type	Name	Description
string	mailFrom
string	mailSender
string	mailTo
string	cc
string	bcc
string	replyTo
MailPriority	priority
string	subject
MailFormat	bodyFormat
Encoding	bodyEncoding
string	body
List<Attachment>	attachments
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword
bool	smtpEnableSSL
string	authProvider

Returns

Type	Description
string

SendMail(string, string, string, string, string, string, string, string, string, string, string)

Declaration

public static string SendMail(string mailFrom, string mailTo, string bcc, string subject, string body, string attachment, string bodyType, string smtpServer, string smtpAuthentication, string smtpUsername, string smtpPassword)

Parameters

Type	Name	Description
string	mailFrom
string	mailTo
string	bcc
string	subject
string	body
string	attachment
string	bodyType
string	smtpServer
string	smtpAuthentication
string	smtpUsername
string	smtpPassword

Returns

Type	Description
string

Extension Methods

JsonExtensionsWeb.ToJson(object)