MFGS Email Attachment Collection

MFGSEmailAttachmentCollection `Public interface`

Description

Represents a collection of email attachments

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
`int`	`Count` Gets the number of attachments in the collection.	`get`
`IExMFGSEmailAttachment`	`Item`	`get`

Methods

Public methods

Returns	Name
`IExMFGSEmailAttachment`	`AddFile`(`string` filePath) Add a file to the attachment collection.
`IExMFGSEmailAttachment`	`AddMessage`(`IExMFGSEmailMessage` message) Add a message to the attachment collection.
`void`	`Clear`() Clears the collection.
`string`	`Join`(`string` separator) Concatenates the name of each attachment in the collection.
`void`	`ParseAddFiles`(`string` filePathList, `string` delimiter) Add multiple files to the attachment collection.
`bool`	`Remove`(`string` name, `bool` ignoreCase) Remove an attachment from the collection.
`void`	`RemoveAt`(`int` index) Remove the attachent at the specified index from the collection.

Details

Summary

Represents a collection of email attachments

Methods

Join

public string Join(string separator)

Arguments

Type	Name	Description
`string`	separator	The separator between each attachment name.

Summary

Concatenates the name of each attachment in the collection.

Returns

A string of attachment names.

Clear

public void Clear()

Summary

Clears the collection.

AddFile

public IExMFGSEmailAttachment AddFile(string filePath)

Arguments

Type	Name	Description
`string`	filePath	The path to the file.

Summary

Add a file to the attachment collection.

Returns

The IExMFGSEmailAttachment object, containing the file, which was added to the collection.

AddMessage

public IExMFGSEmailAttachment AddMessage(IExMFGSEmailMessage message)

Arguments

Type	Name	Description
`IExMFGSEmailMessage`	message	The IExMFGSEmailMessage object.

Summary

Add a message to the attachment collection.

Returns

The IExMFGSEmailAttachment object, containing the message, which was added to the collection.

ParseAddFiles

public void ParseAddFiles(string filePathList, string delimiter)

Arguments

Type	Name	Description
`string`	filePathList	A delimited list of files to be added.
`string`	delimiter	The delimiter to be used when parsing the list.

Summary

Add multiple files to the attachment collection.

Remove

public bool Remove(string name, bool ignoreCase)

Arguments

Type	Name	Description
`string`	name	The name of the attachment to remove.
`bool`	ignoreCase	Determine if case should be ignored.

Summary

Remove an attachment from the collection.

Returns

true if one or more attachments were found and removed, otherwise false.

RemoveAt

public void RemoveAt(int index)

Arguments

Type	Name	Description
`int`	index	The index of the attachment.

Summary

Remove the attachent at the specified index from the collection.

Properties

Count

public int Count { get; }

Summary

Gets the number of attachments in the collection.

Item

public IExMFGSEmailAttachment Item { get; }

Generated with ModularDoc

MFGS Email Attachment Collection