Class MessageBlock

Namespace

Sage.CRM.Blocks

Assembly

SageCRMNet.dll

Provides an email form that can be added to the screen.

public class MessageBlock : SageCrmBlock

Inheritance

object

SageCrmBlock

MessageBlock

Inherited Members

SageCrmBlock.Execute()

SageCrmBlock.Execute(string)

SageCrmBlock.DisplayForm

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

MessageBlock()

Initializes a new instance of MessageBlock.

public MessageBlock()

MessageBlock(string)

Initializes a new instance of MessageBlock.

public MessageBlock(string blockName)

Parameters

blockName string

Block Name.

Fields

_messageBlock

Interface to main application.

protected IeWareMessageBlock _messageBlock

Field Value

IeWareMessageBlock

Properties

AddressFrom

Sets the From Address on the email that is being sent.

public string AddressFrom { get; set; }

Property Value

string

Body

Sets the body text on the message.

public string Body { get; set; }

Property Value

string

ErrorMessage

After the message has been sent, any errors will be saved here.

public string ErrorMessage { get; }

Property Value

string

NameFrom

The name of the email sender.

public string NameFrom { get; set; }

Property Value

string

SentOk

Is set to True or False after the message has been sent.

public bool SentOk { get; }

Property Value

bool

ShowBCC

Enables the display of the blind carbon copy (BCC) field in the graphical interface.

public bool ShowBCC { get; set; }

Property Value

bool

ShowCC

Enables the display of the carbon copy (CC) field in the graphical interface.

public bool ShowCC { get; set; }

Property Value

bool

Subject

Sets the subject text of the message.

public string Subject { get; set; }

Property Value

string

Methods

AddRecipient(string, string, AddressTypes)

Adds a recipient to one of the message fields (TO, CC or BCC).

public void AddRecipient(string address, string name, AddressTypes addressType)

Parameters

address string

The email address to which email will be sent.

name string

The of the email recipient.

addressType AddressTypes

A value from Sage.AddressTypes.

AddRecipient(string, string, string)

Adds a recipient to one of the message fields (TO, CC or BCC).

public void AddRecipient(string address, string name, string addressType)

Parameters

address string

The email address to which email will be sent.

name string

Name of the email recipient.

addressType string

The address type - can be "TO", "CC" or "BCC" - see Sage.AddressTypes.

~MessageBlock()

Destructor for the MessageBlock class.

protected ~MessageBlock()

RemoveRecipient(string)

Removes all the occurrences of the address from the TO, CC and BCC fields.

public void RemoveRecipient(string address)

Parameters

address string