Skip to content

MFGS Email Resource

MFGSEmailResource Public interface

Description

Represents an email resource

Diagram

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

Members

Properties

Public properties

TypeNameMethods
stringContentId
Gets the content identifier
get
stringMimeType
Gets the mime type.
get
stringName
Gets the name.
get

Methods

Public methods

ReturnsName
byte``[]GetBytes()
Gets the attachment content as a byte array.
stringGetString(MFGSTextEncoding encoding)
Gets the resource content as a string.
voidSave(string filePath)
Save the resource as a file.

Details

Summary

Represents an email resource

Methods

Save

public void Save(string filePath)
Arguments
TypeNameDescription
stringfilePathThe file path and name to save the resource to.
Summary

Save the resource as a file.

GetString

public string GetString(MFGSTextEncoding encoding)
Arguments
TypeNameDescription
MFGSTextEncodingencodingThe encoding to use when converting the resource.
Summary

Gets the resource content as a string.

Returns

The resource content.

GetBytes

public byte GetBytes()
Summary

Gets the attachment content as a byte array.

Returns

The resource content.

Properties

ContentId

public string ContentId { get; }
Summary

Gets the content identifier

Remarks

The ContentId is used for uniquely identifying a particular resource. A resource can be referenced by its unique identifier, typically by using a “cid:” URI in an HTML-formatted message body. This can be useful, for example, when the HTML-formatted message body needs to reference image attachments.

Name

public string Name { get; }
Summary

Gets the name.

MimeType

public string MimeType { get; }
Summary

Gets the mime type.

Generated with ModularDoc