Aspose::Email Namespace Reference

Namespaces
	Amp
	AntiSpam
	Bounce
	Calendar
	Clients
	Common
	Mapi
	Mime
	PersonalInfo
	Storage
	Tnef
	Tools

Classes
class	AlternateView
	Represents the format to view a message. More...
class	AlternateViewCollection
	Represents a collection of AlternateView objects. More...
class	AlternateViewRemovedEventArgs
	Provides data for the AlternateViewCollection::AlternateViewRemoved event. More...
class	Attachment
	Represents an e-mail attachment. More...
class	AttachmentBase
	Base class for mail attachment. More...
class	AttachmentCollection
	Represents a collection of e-mail message attachments. More...
class	EmlLoadOptions
	Allows to specify additional options when loading MailMessage from Eml format. More...
class	EmlSaveOptions
	Allows to specify additional options when saving MailMessage to Eml and Emlx format. More...
class	EmlValidationError
	Represents the eml validation error information. More...
class	EmlValidationErrorCollection
	Represents the collection of EmlValidationError More...
class	EmlxLoadOptions
	Allows to specify additional options when loading MailMessage from Eml format. More...
class	FileFormatInfo
	Contains data returned by FileFormatUtil file format detection methods. More...
class	GlobalFormattingOptions
	Class that allow to set some formatting options for all newly created instances of this options. More...
class	HeadersFormattingOptions
	Allows to specify headers formatting options when saving MailMessage to Mhtml or Html format. More...
class	HeaderType
	Represents the Internet standards and RFCs define header fields which may occur on Internet Mail Messages . More...
class	HtmlLoadOptions
	Allows to specify additional options when loading MailMessage from Html format. More...
class	HtmlSaveOptions
	Allows to specify additional options when saving MailMessage to Html format. More...
class	IAttachment
	Represents a common attachment interface More...
class	IMailAddress
	Represents a common mail address interface More...
class	IMessage
	Represents a common message interface More...
class	IMessageFormatter
	Provides a mechanism for retrieving an object to Message formatting. More...
class	IPreferredTextEncodingProvider
	Defines a interface for objects that can define PreferredTextEncoding. More...
class	License
	Provides methods to license the component. More...
class	LinkedResource
	Represents an embedded resource in a message. More...
class	LinkedResourceCollection
	Represents a collection of LinkedResource objects More...
class	LinkedResourceRemovedEventArgs
class	LoadOptions
	This is an abstract base class for classes that allow the user to specify additional options when loading a MailMessage from a particular format. More...
class	MailAddress
	Represents the address of a message. More...
class	MailAddressCollection
	Represents a collection of MailAddress objects. More...
class	MailboxInfo
	Represents identification information about message in a mailbox. More...
class	MailMessage
	Provides possibility to handle rendering of hyperlink in custom style. More...
class	MailMessageCollection
	Represents a collection of MailMessage objects. More...
class	MailMessageSaveType
	Represents the mail message format.It can be in eml,msg or mhtml format. More...
class	MessageFormat
	Represents the mail message format.It can be in eml,msg or mhtml format. More...
class	MhtmlLoadOptions
	Allows to specify additional options when loading MailMessage from Mhtml format. More...
class	MhtSaveOptions
	Allows to specify additional options when saving MailMessage to Mhtml format. More...
class	MhtTemplateName
	Defines well known names of headers for Mhtml formatting. More...
class	MsgLoadOptions
	Allows to specify additional options when loading MailMessage from Msg format. More...
class	MsgSaveOptions
	This class allows the user to specify additional settings when saving a MailMessage in the Msg(ASCII) and Msg(Unicode) format. More...
class	ObjectIdentifier
	Contains object identification information More...
class	ProgressEventHandlerInfo
	This class represents information about conversion progress that can be used in external applicatuion to show conversion progress to end user. More...
class	ReferenceAttachment
	This class represents a reference attachment More...
class	ResourceHtmlRenderingEventArgs
	Represents additional parameters for ResourceHtmlRendering event. More...
class	SaveOptions
	This is an abstract base class for classes that allow the user to specify additional options when saving a MailMessage into a particular format. More...
class	TnefLoadOptions
	Allows to specify additional options when loading MailMessage from Tnef format. More...

Typedefs
using	SmtpException = System::ExceptionWrapper< Details_SmtpException >
using	MessageAcceptanceCallback = System::MulticastDelegate< bool(System::SharedPtr< Mapi::MapiMessage >)>
using	ConversionProgressEventHandler = System::MulticastDelegate< void(System::SharedPtr< ProgressEventHandlerInfo >)>

Enumerations
enum	AttachmentPermissionType {   AttachmentPermissionType::None = 0, AttachmentPermissionType::RecipientsCanView = 1, AttachmentPermissionType::RecipientsCanEdit = 2, AttachmentPermissionType::AnyoneCanView = 3,   AttachmentPermissionType::AnyoneCanEdit = 4, AttachmentPermissionType::OrganizationCanView = 5, AttachmentPermissionType::OrganizationCanEdit = 6 }
	The permission type data associated with a web reference attachment. More...
enum	AttachmentProviderType { AttachmentProviderType::OneDrivePro, AttachmentProviderType::OneDriveConsumer }
	The type of web service manipulating the attachment. More...
enum	ContactFieldsSet {   ContactFieldsSet::None = 0, ContactFieldsSet::NameInfo = 1, ContactFieldsSet::PersonalInfo = 2, ContactFieldsSet::ProfessionalInfo = 4,   ContactFieldsSet::PhysicalAddresses = 8, ContactFieldsSet::Telephones = 0x10, ContactFieldsSet::ElectronicAddresses = 0x20, ContactFieldsSet::Events = 0x40,   ContactFieldsSet::OtherFields = 0x80, ContactFieldsSet::AllExisting = 0x100 }
	Enumerates the groups of Contact fields that will be included in resultant mhtml file. More...
enum	DeliveryNotificationOptions {   DeliveryNotificationOptions::None = 0, DeliveryNotificationOptions::OnSuccess = 1, DeliveryNotificationOptions::OnFailure = 2, DeliveryNotificationOptions::Delay = 4,   DeliveryNotificationOptions::Never = 0x08000000 }
	Specifies delivery notifications. More...
enum	EmlValidationErrorType { EmlValidationErrorType::MessageStructureError, EmlValidationErrorType::EmailAddressError, EmlValidationErrorType::TransferEncodingError }
	Enumerates the types of the eml validation errors. More...
enum	FileCompatibilityMode { FileCompatibilityMode::None = 0, FileCompatibilityMode::AllowCROnly = 1, FileCompatibilityMode::PreserveTnefAttachments = 2 }
	Defines inner conversions, that are necessarily to be done when loading or saving a message. By default CR is not replaces by CRLF, Tnef-attachment is not saved. More...
enum	HtmlFormatOptions {   HtmlFormatOptions::None = 0, HtmlFormatOptions::WriteHeader = 1, HtmlFormatOptions::WriteCompleteEmailAddress = 2, HtmlFormatOptions::WriteCompleteToEmailAddress = 4,   HtmlFormatOptions::WriteCompleteFromEmailAddress = 8, HtmlFormatOptions::WriteCompleteCcEmailAddress = 0x10, HtmlFormatOptions::WriteCompleteBccEmailAddress = 0x20, HtmlFormatOptions::DisplayAsOutlook = 0x40,   HtmlFormatOptions::RenderCalendarEvent = 0x80, HtmlFormatOptions::RenderVCardInfo = 0x100, HtmlFormatOptions::RenderTaskFields = 0x200 }
	Enumerates the Html format options. More...
enum	MailPriority { MailPriority::Normal = 0, MailPriority::Low = 1, MailPriority::High = 2 }
	Represents the mail priopity More...
enum	MailSensitivity {   MailSensitivity::None, MailSensitivity::Normal, MailSensitivity::Personal, MailSensitivity::Private,   MailSensitivity::CompanyConfidential }
	Specifies the sensitivity of a MailMessage. More...
enum	MhtFormatOptions {   MhtFormatOptions::None = 0, MhtFormatOptions::WriteHeader = 1, MhtFormatOptions::WriteOutlineAttachments = 2, MhtFormatOptions::WriteCompleteEmailAddress = 4,   MhtFormatOptions::NoEncodeCharacters = 8, MhtFormatOptions::HideExtraPrintHeader = 0x10, MhtFormatOptions::WriteCompleteToEmailAddress = 0x20, MhtFormatOptions::WriteCompleteFromEmailAddress = 0x40,   MhtFormatOptions::WriteCompleteCcEmailAddress = 0x80, MhtFormatOptions::WriteCompleteBccEmailAddress = 0x100, MhtFormatOptions::RenderCalendarEvent = 0x200, MhtFormatOptions::SkipByteOrderMarkInBody = 0x400,   MhtFormatOptions::RenderVCardInfo = 0x800, MhtFormatOptions::DisplayAsOutlook = 0x1000, MhtFormatOptions::RenderTaskFields = 0x2000 }
	Enumerates the Mht format options More...
enum	ParticipationStatus {   ParticipationStatus::NeedsAction, ParticipationStatus::Accepted, ParticipationStatus::Declined, ParticipationStatus::Tentative,   ParticipationStatus::Delegated }
	Identifies the participation status for the calendar user. More...
enum	ProgressEventType { ProgressEventType::MimeStructureCreated, ProgressEventType::MimePartSaved, ProgressEventType::SavedToStream }
	Type of progress event that occured. More...
enum	ResourceRenderingMode { ResourceRenderingMode::None, ResourceRenderingMode::EmbedIntoHtml, ResourceRenderingMode::SaveToFile, ResourceRenderingMode::SubstituteFromFile }
	Provides set various modes of rendering resources in html. More...
enum	FileFormatType {   FileFormatType::Unknown, FileFormatType::Msg, FileFormatType::Eml, FileFormatType::Mht,   FileFormatType::Emlx, FileFormatType::Ics, FileFormatType::Vcf, FileFormatType::Ost,   FileFormatType::Pst, FileFormatType::Tnef, FileFormatType::Mbox, FileFormatType::Oft,   FileFormatType::Olm, FileFormatType::Tgz, FileFormatType::Nsf }
	Enumerates file format types. More...

Typedef Documentation

ConversionProgressEventHandler

using Aspose::Email::ConversionProgressEventHandler = typedef System::MulticastDelegate<void(System::SharedPtr<ProgressEventHandlerInfo>)>

MessageAcceptanceCallback

using Aspose::Email::MessageAcceptanceCallback = typedef System::MulticastDelegate<bool(System::SharedPtr<Mapi::MapiMessage>)>

SmtpException

using Aspose::Email::SmtpException = typedef System::ExceptionWrapper<Details_SmtpException>

Enumeration Type Documentation

AttachmentPermissionType

enum Aspose::Email::AttachmentPermissionType

strong

The permission type data associated with a web reference attachment.

Enumerator
None	User has no permissions to share.
RecipientsCanView	User can only read the web reference attachment.
RecipientsCanEdit	User can edit the web reference attachment.
AnyoneCanView	Anyone can only read the web reference attachment.
AnyoneCanEdit	Anyone can edit the web reference attachment.
OrganizationCanView	Only users belonging to the same organization can only read the web reference attachment.
OrganizationCanEdit	Only users belonging to the same organization can edit the web reference attachment.

AttachmentProviderType

enum Aspose::Email::AttachmentProviderType

strong

The type of web service manipulating the attachment.

Enumerator
OneDrivePro	The web reference attachment belongs to a OneDrive for Business service.
OneDriveConsumer	The web reference attachment belongs to a OneDrive Consumer service.

ContactFieldsSet

enum Aspose::Email::ContactFieldsSet

strong

Enumerates the groups of Contact fields that will be included in resultant mhtml file.

Enumerator
None	Indicates that none fields will be included in resultant mhtml file. Only NOTE of contact will be displayed in html body.
NameInfo	Indicates that NameInfo fields will be included in resultant mhtml file.
PersonalInfo	Indicates that PersonalInfo fields will be included in resultant mhtml file.
ProfessionalInfo	Indicates that ProfessionalInfo fields will be included in resultant mhtml file.
PhysicalAddresses	Indicates that PhysicalAddresses fields will be included in resultant mhtml file.
Telephones	Indicates that Telephones fields will be included in resultant mhtml file.
ElectronicAddresses	Indicates that ElectronicAddresses fields will be included in resultant mhtml file.
Events	Indicates that Events fields will be included in resultant mhtml file.
OtherFields	Indicates that OtherFields fields will be included in resultant mhtml file.
AllExisting	Indicates that all existing fields will be included in resultant mhtml file.

DeliveryNotificationOptions

enum Aspose::Email::DeliveryNotificationOptions

strong

Specifies delivery notifications.

Enumerator
None	No notification information will be sent. The mail server will utilize its configured behavior to determine whether it should generate a delivery notification.
OnSuccess	Notify if the delivery is successful.
OnFailure	Notify if the delivery is unsuccessful.
Delay	Notify if the delivery is delayed.
Never	A notification should not be generated under any circumstances.

EmlValidationErrorType

enum Aspose::Email::EmlValidationErrorType

strong

Enumerates the types of the eml validation errors.

Enumerator
MessageStructureError	Indicates that the message structure is incorrect.
EmailAddressError	Indicates that email address is invalid.
TransferEncodingError	Indicates that message contains unexpected unencoded non-ASCII data.

FileCompatibilityMode

enum Aspose::Email::FileCompatibilityMode

strong

Defines inner conversions, that are necessarily to be done when loading or saving a message. By default CR is not replaces by CRLF, Tnef-attachment is not saved.

Enumerator
None	No values are set.
AllowCROnly	Shows the necessity of the forced replace of line separators by CRLF.
PreserveTnefAttachments	Controls TNEF attachment saving behaviour. This option affects messages whose winmail.dat TNEF attachment (if present) was decoded at loading. If the option is set, the previously decoded and extracted TNEF will be encoded and packaged again into the winmail.dat attachment during message saving. By default the option isn't set.

FileFormatType

enum Aspose::Email::FileFormatType

strong

Enumerates file format types.

Enumerator
Unknown	Unknown file format.
Msg	Outlook MSG file format.
Eml	File in the MIME standard.
Mht	File is a Single File Web Page, also known as a Web Archive file.
Emlx	Apple's Mail.app program file format.
Ics	iCalendar file format.
Vcf	vCard file format.
Ost	Outlook Data Files format for for offline mode.
Pst	Outlook Data Files format.
Tnef	Transport Neutral Encapsulation Format.
Mbox	File format used for holding collections of electronic mail messages.
Oft	Outlook MSG file format for message template.
Olm	Outlook for Mac File Format.
Tgz	TAR archive file format. Zimbra mail client utilizes TGZ to export mailbox data.
Nsf	The Notes Storage Facility (NSF) database file is used by (IBM) Lotus Notes and Domino.

HtmlFormatOptions

enum Aspose::Email::HtmlFormatOptions

strong

Enumerates the Html format options.

Enumerator
None	No specific settings are specified.
WriteHeader	Indicates that header information should be written.
WriteCompleteEmailAddress	Indicates that complete e-mail address should be written in all email headers.
WriteCompleteToEmailAddress	Indicates that complete e-mail address should be written in 'To' header.
WriteCompleteFromEmailAddress	Indicates that complete e-mail address should be written in 'From' header.
WriteCompleteCcEmailAddress	Indicates that complete e-mail address should be written in 'Cc' header.
WriteCompleteBccEmailAddress	Indicates that complete e-mail address should be written in 'Bcc' header.
DisplayAsOutlook	Indicates that From header will be displayed as in Outlook.
RenderCalendarEvent	Indicates that text from calendar event should be written in output mhtml.
RenderVCardInfo	Indicates that text from VCard AlternativeView should be written in output html.
RenderTaskFields	Indicates that the specific Task fields should be written in output html.

MailPriority

enum Aspose::Email::MailPriority

strong

Represents the mail priopity

Enumerator
Normal	Normal priority
Low	Low priority
High	High priority

MailSensitivity

enum Aspose::Email::MailSensitivity

strong

Specifies the sensitivity of a MailMessage.

Enumerator
None	No Sensitivity set.
Normal	The normal sensitivity.
Personal	Sets the sensitivity to Personal.
Private	Sets the sensitivity to Private.
CompanyConfidential	Sets the sensitivity to CompanyConfidential.

MhtFormatOptions

enum Aspose::Email::MhtFormatOptions

strong

Enumerates the Mht format options

Enumerator
None	No specific settings are specified.
WriteHeader	Indicates that header information should be written.
WriteOutlineAttachments	Indicates that outline attachments should be written.
WriteCompleteEmailAddress	Indicates that complete e-mail address should be written in all email headers.
NoEncodeCharacters	Indicates that no transfer encoding of characters should be used.
HideExtraPrintHeader	Indicates that PageHeader will be unvisible.
WriteCompleteToEmailAddress	Indicates that complete e-mail address should be written in 'To' header.
WriteCompleteFromEmailAddress	Indicates that complete e-mail address should be written in 'From' header.
WriteCompleteCcEmailAddress	Indicates that complete e-mail address should be written in 'Cc' header.
WriteCompleteBccEmailAddress	Indicates that complete e-mail address should be written in 'Bcc' header.
RenderCalendarEvent	Indicates that text from calendar event should be written in output mhtml.
SkipByteOrderMarkInBody	Indicates that Byte Order Mark(BOM) bytes should be written to body.
RenderVCardInfo	Indicates that text from VCard AlternativeView should be written in output mhtml.
DisplayAsOutlook	Indicates that From header will be displayed as in Outlook.
RenderTaskFields	Indicates that the specific Task fields should be written in output mhtml.

ParticipationStatus

enum Aspose::Email::ParticipationStatus

strong

Identifies the participation status for the calendar user.

Enumerator
NeedsAction	Event needs action
Accepted	Event accepted
Declined	Event declined
Tentative	Event tentatively accepted
Delegated	Event delegated

ProgressEventType

enum Aspose::Email::ProgressEventType

strong

Type of progress event that occured.

Enumerator
MimeStructureCreated	Mean that occurred event informs about mime structure is created.
MimePartSaved	Mean that occurred event informs about finished saving of one mime part.
SavedToStream	Mean that occurred event informs that all mime parts are saved to stream.

ResourceRenderingMode

enum Aspose::Email::ResourceRenderingMode

strong

Provides set various modes of rendering resources in html.

Enumerator
None	Not rendering resources in html.
EmbedIntoHtml	Embeding resources in html as base64 string.
SaveToFile	Saving resources to file and inserting in html src tag with path to this file.
SubstituteFromFile	Using custom file as icon and inserting in html src tag with path to this file.