BPA Email Message

BPAEmailMessage `Public interface`

Description

Describes methods and properties available on the static instance object BPA.Email.Message.

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
`int`	`AttachmentLevel` Gets the number of level a message is nested within attachments.	`get`
`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`
`BPAEmailMessageFlags`	`Flags` Gets the flags set on the message.	`get`
`MFGSEmailMessageImportance`	`Importance` Gets or sets the message importance.	`get, set`
`bool`	`IsAttachment` Gets if the message is an attachment of another message.	`get`
`bool`	`IsFlagged` Gets or sets an indicator if the message has been flagged.	`get, set`
`bool`	`IsHtml` Gets if the message contains an html body.	`get`
`bool`	`IsSeen` Gets or sets an indicator if the message has been seen.	`get, set`
`string`	`MessageId` Gets the message identifier.	`get`
`IExMFGSEmailMessage`	`ParentMessage` Gets the parent message if this message is an attachment.	`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`
`int`	`UniqueId` Gets the unique identifier of the message within the current folder.	`get`

Methods

Public methods

Returns	Name
`void`	`Delete`() Deletes the message from the current folder.
`void`	`Move`(`string` folderPath) Moves a message to a different folder.
`void`	`Resend`(`string` toAddresses, `string` subject, `string` fromAddress) Resends the message.
`void`	`SkipAuto`() Flags the watcher to skip any automatic processing after session has ended.

Details

Summary

Describes methods and properties available on the static instance object BPA.Email.Message.

Methods

Delete

public void Delete()

Summary

Deletes the message from the current folder.

Move

public void Move(string folderPath)

Arguments

Type	Name	Description
`string`	folderPath

Summary

Moves a message to a different folder.

SkipAuto

public void SkipAuto()

Summary

Flags the watcher to skip any automatic processing after session has ended.

Remarks

An email watcher can be configured to automatically perform certain processes on a message, like moving to a different folder or flagging it as seen, once the script has finished.

Resend

public void Resend(string toAddresses, string subject, string fromAddress)

Arguments

Type	Name	Description
`string`	toAddresses	A semi-colon delimited list of addresses the message will be sent to.
`string`	subject	The subject of the message. If blank, the existing subject will be used.
`string`	fromAddress	The address the message should be sent from. If blank, the default SMTP from address will be used.

Summary

Resends the message.

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.

UniqueId

public int UniqueId { get; }

Summary

Gets the unique identifier of the message within the current folder.

Remarks

This value can change if the message is moved to a different folder.

Flags

public BPAEmailMessageFlags Flags { get; }

Summary

Gets the flags set on the message.

IsSeen

public bool IsSeen { get; set; }

Summary

Gets or sets an indicator if the message has been seen.

IsFlagged

public bool IsFlagged { get; set; }

Summary

Gets or sets an indicator if the message has been flagged.

IsAttachment

public bool IsAttachment { get; }

Summary

Gets if the message is an attachment of another message.

AttachmentLevel

public int AttachmentLevel { get; }

Summary

Gets the number of level a message is nested within attachments.

ParentMessage

public IExMFGSEmailMessage ParentMessage { get; }

Summary

Gets the parent message if this message is an attachment.

Generated with ModularDoc

BPA Email Message