Click or drag to resize

Message Class

Wrapper class for MailMessage and other artifacts
Inheritance Hierarchy
SystemObject
  NetQuarry.MailMessage

Namespace:  NetQuarry.Mail
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class Message

The Message type exposes the following members.

Constructors
  NameDescription
Public methodMessage(IAppContext)
Constructs an empty object
Public methodMessage(IAppContext, String, String)
Constructs a new instance of the object.
Public methodMessage(IAppContext, MailMessage, SendEmailFlags, String, String, MessageRelationships)
Constructs a new instance of the object.
Public methodMessage(IAppContext, MailMessage, SendEmailFlags, String, String, MessageRelationships, String)
Constructs a new instance of the object.
Top
Properties
  NameDescription
Public propertyApplication
Gets/Sets the IAppContext object
Public propertyAttachments
Gets/Sets the attachment collection
Public propertyBcc
Gets/Sets the original BCC set of addresses. This is BEFORE addresses are removed because of the no send list.
Public propertyCategories
Returns a list of categories to log / send with this message
Public propertyCategoryID
Gets/Sets the category id used to send the email (optional)
Public propertyCC
Gets/Sets the original CC set of addresses. This is BEFORE addresses are removed because of the no send list.
Public propertyDateSent
Gets/Sets the sent date of the message (in UTC)
Public propertyFrom
Gets/Sets the From address to use.
Public propertyMailMessage
Gets the mail message. You cannot set this object. To create a message before sending you should call the PrepareMessage method.
Public propertyMapper
Gets/Sets the mapper object
Public propertyMessageID
Gets/Sets the unique message ID (GUID)
Public propertyPlainTextBody
The plain text body of the message
Public propertyRelationships
Collection of relationships to add during the log
Public propertyRemovedAddresses
Gets/Sets email addresses that were removed due to no send list.
Public propertySendEmailFlags
Gets/Sets email flags specific to this send
Public propertyServiceName
Gets/Sets the Service Name through which the email will be sent
Public propertyStatus
Gets/Sets the status of the message (by default this is 0, meaning sent, but added to support logging of received emails)
Public propertyTemplateData
Gets/Sets the name/value collection of data to be merged into the template.
Public propertyTemplateName
Gets/Sets the template name used to send the email.
Public propertyTo
Gets/Sets the original To set of addresses. This is BEFORE addresses are removed because of the no send list.
Public propertyUnsubscribeEmail
The unsubscribe email address
Public propertyUnsubscribeUrl
The unsubscribe URL
Top
Methods
  NameDescription
Public methodAddListUnsubscribeHeader
Adds the list-unsubscribe header to the email
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberExpectedAddressCount
Determine the number of email address that would be expected in the specified email address list. Knowing the number of expected email addresses can be helpful in determining whether a MailMessage created by PrepareMessage rejected any invalid email addresses that were provided to To, CC, or Bcc. Currently the number of expected addresses is determined by looking for semi-colons and/or at-signs.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsertRelationships
Adds any existing relationships to the xot_email_message_rel table.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepareMessage
Prepares the message to be sent. This expands the template data set on this object into the template, creates the MailMessage object with the associated data. The message is ready to be sent at this point.
Public methodPreparePlainTextBody
Prepares the text/plain body of the message if it exists
Public methodSend
Sends an email with using this message.
Public methodSend(String)
Sends an email with using this message.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also