MFGS Email Attachment

MFGSEmailAttachment `Public interface`

Description

Represents an email attachment

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
`string`	`ContentId` Gets the content identifier	`get`
`bool`	`IsMessage` Determines if the attachment is a message.	`get`
`string`	`MimeType` Gets the mime type.	`get`
`string`	`Name` Gets the name.	`get`

Methods

Public methods

Returns	Name
byte``[]	`GetBytes`() Gets the attachment content as a byte array.
`IExMFGSEmailMessage`	`GetMesssge`() Gets the attachment as a message.
`string`	`GetString`(`MFGSTextEncoding` encoding) Gets the attachent content as a string.
`void`	`Save`(`string` filePath) Save the attachment as a file.

Details

Summary

Represents an email attachment

Methods

Save

public void Save(string filePath)

Arguments

Type	Name	Description
`string`	filePath	The file path and name to save the attachment to.

Summary

Save the attachment as a file.

GetString

public string GetString(MFGSTextEncoding encoding)

Arguments

Type	Name	Description
`MFGSTextEncoding`	encoding	The encoding to use when converting the attachment.

Summary

Gets the attachent content as a string.

Returns

The attachment content.

GetBytes

public byte GetBytes()

Summary

Gets the attachment content as a byte array.

Returns

The attachment content.

GetMesssge

public IExMFGSEmailMessage GetMesssge()

Summary

Gets the attachment as a message.

Returns

An IExMFGSEmailMessage object.

Properties

ContentId

public string ContentId { get; }

Summary

Gets the content identifier

Remarks

The ContentId is used for uniquely identifying a particular attachment.

Name

public string Name { get; }

Summary

Gets the name.

MimeType

public string MimeType { get; }

Summary

Gets the mime type.

IsMessage

public bool IsMessage { get; }

Summary

Determines if the attachment is a message.

Remarks

true if the attachment is a message; false if the attachment is a file.

Generated with ModularDoc

MFGS Email Attachment