MFGS Email Message

MFGSEmailMessage `Public interface`

Description

Represents an email message

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSEmailMessage[[IExMFGSEmailMessage]]
  class VGWWCoreIEx.IExMFGSEmailMessage interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
`IExMFGSEmailAttachmentCollection`	`Attachments` Gets the attachment collection of the message.	`get`
`IExMFGSEmailAddressCollection`	`Bcc` Gets the collection of addresses in the Bcc header.	`get`
`string`	`BodyHtml` Gets the html body of the message if it exists.	`get, set`
`string`	`BodyText` Gets the text body of the message if it exists.	`get, set`
`IExMFGSEmailAddressCollection`	`Cc` Gets the collection of addresses in the Cc header.	`get`
`DateTime`	`Date` Gets the date of the message.	`get, set`
`MFGSEmailMessageImportance`	`Importance` Gets or sets the message importance.	`get, set`
`bool`	`IsHtml` Gets if the message contains an html body.	`get`
`string`	`MessageId` Gets the message identifier.	`get`
`MFGSEmailMessagePriority`	`Priority` Gets or sets the message priority.	`get, set`
`IExMFGSEmailAddressCollection`	`ReplyTo` Gets the collection of addresses in the ReplyTo header.	`get`
`bool`	`RequestReceiptDelivery` Gets or sets if a receipt should be sent to the sender upon delivery of the message.	`get, set`
`bool`	`RequestReceiptRead` Gets or sets if a receipt should be sent to the sender once the message has been read.	`get, set`
`IExMFGSEmailResourceCollection`	`Resources` Gets the resource collection of the message.	`get`
`IExMFGSEmailAddress`	`Sender` Gets the address in the Sender header.	`get`
`string`	`Subject` Gets the message subject.	`get, set`
`IExMFGSEmailAddressCollection`	`To` Gets the collection of addresses in the To header.	`get`

Methods

Public methods

Returns	Name
`void`	`Send`() Sends the message.

Details

Summary

Represents an email message

Methods

Send

public void Send()

Summary

Sends the message.

Remarks

The SMTP Client settings, on the Email section of the MFGStream Configuration, must be properly configured otherwise attempting to send an email message will result in an error

Properties

MessageId

public string MessageId { get; }

Summary

Gets the message identifier.

Remarks

The MessageId is meant to be a globally unique identifier for a message.

Subject

public string Subject { get; set; }

Summary

Gets the message subject.

Date

public DateTime Date { get; set; }

Summary

Gets the date of the message.

Remarks

If the date is not explicitly set before the message is written to a stream, the date will default to the exact moment when it is written to said stream.

Sender

public IExMFGSEmailAddress Sender { get; }

Summary

Gets the address in the Sender header.

To

public IExMFGSEmailAddressCollection To { get; }

Summary

Gets the collection of addresses in the To header.

Cc

public IExMFGSEmailAddressCollection Cc { get; }

Summary

Gets the collection of addresses in the Cc header.

Bcc

public IExMFGSEmailAddressCollection Bcc { get; }

Summary

Gets the collection of addresses in the Bcc header.

ReplyTo

public IExMFGSEmailAddressCollection ReplyTo { get; }

Summary

Gets the collection of addresses in the ReplyTo header.

BodyText

public string BodyText { get; set; }

Summary

Gets the text body of the message if it exists.

BodyHtml

public string BodyHtml { get; set; }

Summary

Gets the html body of the message if it exists.

IsHtml

public bool IsHtml { get; }

Summary

Gets if the message contains an html body.

Attachments

public IExMFGSEmailAttachmentCollection Attachments { get; }

Summary

Gets the attachment collection of the message.

Resources

public IExMFGSEmailResourceCollection Resources { get; }

Summary

Gets the resource collection of the message.

Importance

public MFGSEmailMessageImportance Importance { get; set; }

Summary

Gets or sets the message importance.

Priority

public MFGSEmailMessagePriority Priority { get; set; }

Summary

Gets or sets the message priority.

RequestReceiptDelivery

public bool RequestReceiptDelivery { get; set; }

Summary

Gets or sets if a receipt should be sent to the sender upon delivery of the message.

Remarks

Not all email systems support delivery receipt.

RequestReceiptRead

public bool RequestReceiptRead { get; set; }

Summary

Gets or sets if a receipt should be sent to the sender once the message has been read.

Remarks

Not all email systems support read receipt.

Generated with ModularDoc

MFGS Email Message