Show / Hide Table of Contents

Class Message

Represents an email msg that needs to be sent

Inheritance
System.Object
Row
TypedRow
Message
Implements
IConfigurable
IConfigurationPersistent
System.IEquatable<Row>
System.Collections.Generic.IEnumerable<System.Object>
System.Collections.IEnumerable
IValidatable
IJSONWritable
Inherited Members
TypedRow.Schema
TypedRow.GetFieldValue(Schema.FieldDef)
TypedRow.SetFieldValue(Schema.FieldDef, Object)
Row.MakeRow(Schema, Type)
Row.TryFillFromJSON(Row, IJSONDataObject, SetFieldFunc)
Row.Item[String]
Row.Item[Int32]
Row.GetDataStoreKey(String)
Row.Configure(IConfigSectionNode)
Row.PersistConfiguration(ConfigSectionNode)
Row.Validate(String)
Row.ValidateField(String, String)
Row.ValidateField(String, Schema.FieldDef)
Row.Equals(Row)
Row.Equals(Object)
Row.GetHashCode()
Row.SimpleFilterPredicate(String, Boolean)
Row.IEnumerable.GetEnumerator()
Row.GetEnumerator()
Row.ConvertFieldValueToDef(Schema.FieldDef, Object)
Row.ApplyDefaultFieldValues(String, Boolean)
Row.CopyFields(Row, Boolean, Boolean, Func<String, Schema.FieldDef, Boolean>, Func<String, String, Boolean>)
Row.GetFieldValueDescription(String, String, Boolean)
Row.GetFieldValueDescription(Int32, String, Boolean)
Row.GetDisplayFieldValue(String, String, Func<Object, Object>)
Row.GetDisplayFieldValue(Int32, String, Func<Object, Object>)
Row.GetClientFieldValueList(Object, Schema.FieldDef, String, String)
Row.GetClientFieldDef(Object, Schema.FieldDef, String, String)
Row.GetClientFieldValue(Object, Schema.FieldDef, String, String)
Row.WriteAsJSON(TextWriter, Int32, JSONWritingOptions)
Row.CheckMinMax(FieldAttribute, String, IComparable)
Row.FilterJSONSerializerField(Schema.FieldDef, JSONWritingOptions, String)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Web.Messaging
Assembly: NFX.Web.dll
Syntax
[Serializable]
public class Message : TypedRow, IConfigurable, IConfigurationPersistent, IEquatable<Row>, IEnumerable<object>, IEnumerable, IValidatable, IJSONWritable

Constructors

Message()

Declaration
protected Message()

Message(Nullable<Guid>, Nullable<DateTime>)

Declaration
public Message(Guid? id, DateTime? utcCreateDate = default (DateTime? ))
Parameters
Type Name Description
System.Nullable<System.Guid> id
System.Nullable<System.DateTime> utcCreateDate

Properties

AddressBCC

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "a_bcc", null, null, null, false, null, null, null, true)]
public string AddressBCC { get; set; }
Property Value
Type Description
System.String

AddressBCCBuilder

Declaration
public MessageAddressBuilder AddressBCCBuilder { get; }
Property Value
Type Description
MessageAddressBuilder

AddressCC

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "a_cc", null, null, null, false, null, null, null, true)]
public string AddressCC { get; set; }
Property Value
Type Description
System.String

AddressCCBuilder

Declaration
public MessageAddressBuilder AddressCCBuilder { get; }
Property Value
Type Description
MessageAddressBuilder

AddressFrom

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "a_frm", null, null, null, false, null, null, null, true)]
public string AddressFrom { get; set; }
Property Value
Type Description
System.String

AddressFromBuilder

Declaration
public MessageAddressBuilder AddressFromBuilder { get; }
Property Value
Type Description
MessageAddressBuilder

AddressReplyTo

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "a_rto", null, null, null, false, null, null, null, true)]
public string AddressReplyTo { get; set; }
Property Value
Type Description
System.String

AddressReplyToBuilder

Declaration
public MessageAddressBuilder AddressReplyToBuilder { get; }
Property Value
Type Description
MessageAddressBuilder

AddressTo

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "a_to", null, null, null, false, null, null, null, true)]
public string AddressTo { get; set; }
Property Value
Type Description
System.String

AddressToBuilder

Declaration
public MessageAddressBuilder AddressToBuilder { get; }
Property Value
Type Description
MessageAddressBuilder

Attachments

Collection of Attachments

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "ats", null, null, null, false, null, null, null, true)]
public Message.Attachment[] Attachments { get; set; }
Property Value
Type Description
Message.Attachment[]

Body

Plain/text body

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "plain", null, null, null, false, null, null, null, true)]
public string Body { get; set; }
Property Value
Type Description
System.String

CreateDateUTC

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "cdt", null, null, null, false, null, null, null, true)]
public DateTime CreateDateUTC { get; set; }
Property Value
Type Description
System.DateTime

ID

Every message has an ID of type GUID generated upon the creation, it is used for unique identification in small systems and message co-relation into conversation threads

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "id", null, null, null, false, null, null, null, true)]
public Guid ID { get; }
Property Value
Type Description
System.Guid

Importance

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "im", null, null, null, false, null, null, null, true)]
public MsgImportance Importance { get; set; }
Property Value
Type Description
MsgImportance

Priority

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "pr", null, null, null, false, null, null, null, true)]
public MsgPriority Priority { get; set; }
Property Value
Type Description
MsgPriority

RelatedID

When set, identifies the message in a thread which this one relates to

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "rel", null, null, null, false, null, null, null, true)]
public Guid? RelatedID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

RichBody

Rich-formatted body per content type

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "rich", null, null, null, false, null, null, null, true)]
public string RichBody { get; set; }
Property Value
Type Description
System.String

RichBodyContentType

Rich body content type

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "rctp", null, null, null, false, null, null, null, true)]
public string RichBodyContentType { get; set; }
Property Value
Type Description
System.String

ShortBody

Short text body

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "short", null, null, null, false, null, null, null, true)]
public string ShortBody { get; set; }
Property Value
Type Description
System.String

Subject

Subject short text

Declaration
[Field("*", StoreFlag.LoadAndStore, false, DataKind.Text, false, true, null, null, null, null, 0, 0, CharCase.AsIs, "sb", null, null, null, false, null, null, null, true)]
public string Subject { get; set; }
Property Value
Type Description
System.String

Methods

Validate()

Declaration
public override Exception Validate()
Returns
Type Description
System.Exception
Overrides
Row.Validate()

Implements

IConfigurable
IConfigurationPersistent
System.IEquatable<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
IValidatable
IJSONWritable

Extension Methods

CollectionUtils.ForEach<T>(IEnumerable<T>, Action<T>)
CollectionUtils.ForEach<T>(IEnumerable<T>, Action<T, Int32>)
CollectionUtils.SkipLast<T>(IEnumerable<T>)
CollectionUtils.SkipLast<T>(IEnumerable<T>, Int32)
CollectionUtils.FirstMin<TResult, TComparand>(IEnumerable<TResult>, Func<TResult, TComparand>)
CollectionUtils.FirstMin<TResult, TComparand>(IEnumerable<TResult>, Func<TResult, TComparand>, out TComparand)
CollectionUtils.FirstMax<TResult, TComparand>(IEnumerable<TResult>, Func<TResult, TComparand>)
CollectionUtils.FirstMax<TResult, TComparand>(IEnumerable<TResult>, Func<TResult, TComparand>, out TComparand)
CollectionUtils.FirstOrAnyOrDefault<TResult>(IEnumerable<TResult>, Func<TResult, Boolean>)
CollectionUtils.Distinct<TResult, TKey>(IEnumerable<TResult>, Func<TResult, TKey>)
MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
LookAheadExtensions.AsLookAheadEnumerable<T>(IEnumerable<T>)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
ErlSchemaUtils.ToErlObject(Row, String, String, Boolean)
ErlSchemaUtils.Update(Row, IErlObject, Schema, String, String, Registry<Schema>)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX