Aspose::Email Namespace Reference

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

Classes
class	AlternateView
	Represents the format to view a message. 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	Details_AsposeArgumentException
	The exception that is thrown when one of the arguments provided to a method is not valid.
class	Details_AsposeArgumentNullException
	The ArgumentException is thrown when an argument is null when it shouldn't be.
class	Details_AsposeArgumentOutOfRangeException
	The exception that is thrown when one of the arguments provided to a method is out of range.
class	Details_AsposeBadServerResponceException
	Represents errors that occur during server operation execution.
class	Details_AsposeException
	Base exception type for Aspose.Email Represents errors that occur during application execution.
class	Details_AsposeInvalidDataException
	The exception that is thrown when one of the arguments provided to a method is not valid.
class	Details_AsposeInvalidEnumArgumentException
	Base exceptioon type for Aspose.Email Represents errors that occur during application execution.
class	Details_AsposeInvalidOperationException
	Exception class for denoting an object was in a state that made calling a method illegal.
class	Details_AsposeNotSupportedException
	The exception that is thrown when an invoked method or parameter is not supported, or when there is an attempt to read, seek, or write to a stream that does not support the invoked functionality.
class	Details_ElementProcessingException
	The exception that is thrown when one of many elements failed with exception.
class	Details_ExchangeException
	Thrown if there is a MS Exchange communication failure.
class	Details_FileCorruptedException
	Exception that is thrown during file reading, when the file appears to be corrupted and impossible to read.
class	Details_FormatNotSupportedException
	Exception that is thrown during document load, when the document format is not recognized or not supported by the component.
class	Details_GoogleClientException
	Represents errors that occur during ActiveSync protocol execution.
class	Details_ImapException
	Represents the exception that is thrown when the ImapClient is not able to complete an operation.
class	Details_MailException
	Represents the exception that is thrown when the mail message processing.
class	Details_Pop3Exception
	Represents the exception that is thrown when the Pop3Client is not able to complete an operation.
class	Details_SmtpException
	Represents the exception that is thrown when the SmtpClient is not able to complete an operation.
class	Details_SSPIException
	Represents errors that occur during SSPI execution.
class	Details_TimeoutException
	Represents the exception that is thrown when the time for operation has expired.
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	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	FINAL
	Represents a collection of AlternateView objects.
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	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	MailMessage
	Represents an e-mail message. It allows to access message properties, ex. subject, body, sender and recipients addreses, etc. Also it can be sent and delivered by means of supported mail protocols. More...
class	MailMessageCollection
	Represents a collection of MailMessage objects. More...
class	Metered
	Provides methods to set metered key. More...
class	MeteredBillingService
	This internal class is used to handle customer's matered state 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	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	AsposeArgumentException = System::ExceptionWrapper< Details_AsposeArgumentException >
using	AsposeArgumentNullException = System::ExceptionWrapper< Details_AsposeArgumentNullException >
using	AsposeArgumentOutOfRangeException = System::ExceptionWrapper< Details_AsposeArgumentOutOfRangeException >
using	AsposeBadServerResponceException = System::ExceptionWrapper< Details_AsposeBadServerResponceException >
using	AsposeException = System::ExceptionWrapper< Details_AsposeException >
using	AsposeInvalidDataException = System::ExceptionWrapper< Details_AsposeInvalidDataException >
using	AsposeInvalidEnumArgumentException = System::ExceptionWrapper< Details_AsposeInvalidEnumArgumentException >
using	AsposeInvalidOperationException = System::ExceptionWrapper< Details_AsposeInvalidOperationException >
using	AsposeNotSupportedException = System::ExceptionWrapper< Details_AsposeNotSupportedException >
using	ElementProcessingException = System::ExceptionWrapper< Details_ElementProcessingException >
using	ExchangeException = System::ExceptionWrapper< Details_ExchangeException >
using	FileCorruptedException = System::ExceptionWrapper< Details_FileCorruptedException >
using	FormatNotSupportedException = System::ExceptionWrapper< Details_FormatNotSupportedException >
using	GoogleClientException = System::ExceptionWrapper< Details_GoogleClientException >
using	ImapException = System::ExceptionWrapper< Details_ImapException >
using	Pop3Exception = System::ExceptionWrapper< Details_Pop3Exception >
using	SmtpException = System::ExceptionWrapper< Details_SmtpException >
using	SSPIException = System::ExceptionWrapper< Details_SSPIException >
using	TimeoutException = System::ExceptionWrapper< Details_TimeoutException >
using	SaveResourceHandlerDelegate = System::MulticastDelegate< void(System::SharedPtr< AttachmentBase >, System::String)>
using	MailException = System::ExceptionWrapper< Details_MailException >
using	HyperlinkRenderingCallback = System::MulticastDelegate< System::String(System::String)>
using	MessageAcceptanceCallback = System::MulticastDelegate< bool(System::SharedPtr< Mapi::MapiMessage >)>
using	ConversionProgressEventHandler = System::MulticastDelegate< void(System::SharedPtr< ProgressEventHandlerInfo >)>

Enumerations
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 }
	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	MeteredState { MeteredState::Evaluation, MeteredState::Paid }
	Represents possible metered states. 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	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 }
	Enumerates file format types. More...

Typedef Documentation

AsposeArgumentException

using Aspose::Email::AsposeArgumentException = typedef System::ExceptionWrapper<Details_AsposeArgumentException>

AsposeArgumentNullException

using Aspose::Email::AsposeArgumentNullException = typedef System::ExceptionWrapper<Details_AsposeArgumentNullException>

AsposeArgumentOutOfRangeException

using Aspose::Email::AsposeArgumentOutOfRangeException = typedef System::ExceptionWrapper<Details_AsposeArgumentOutOfRangeException>

AsposeBadServerResponceException

using Aspose::Email::AsposeBadServerResponceException = typedef System::ExceptionWrapper<Details_AsposeBadServerResponceException>

AsposeException

using Aspose::Email::AsposeException = typedef System::ExceptionWrapper<Details_AsposeException>

AsposeInvalidDataException

using Aspose::Email::AsposeInvalidDataException = typedef System::ExceptionWrapper<Details_AsposeInvalidDataException>

AsposeInvalidEnumArgumentException

using Aspose::Email::AsposeInvalidEnumArgumentException = typedef System::ExceptionWrapper<Details_AsposeInvalidEnumArgumentException>

AsposeInvalidOperationException

using Aspose::Email::AsposeInvalidOperationException = typedef System::ExceptionWrapper<Details_AsposeInvalidOperationException>

AsposeNotSupportedException

using Aspose::Email::AsposeNotSupportedException = typedef System::ExceptionWrapper<Details_AsposeNotSupportedException>

ConversionProgressEventHandler

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

ElementProcessingException

using Aspose::Email::ElementProcessingException = typedef System::ExceptionWrapper<Details_ElementProcessingException>

ExchangeException

using Aspose::Email::ExchangeException = typedef System::ExceptionWrapper<Details_ExchangeException>

FileCorruptedException

using Aspose::Email::FileCorruptedException = typedef System::ExceptionWrapper<Details_FileCorruptedException>

FormatNotSupportedException

using Aspose::Email::FormatNotSupportedException = typedef System::ExceptionWrapper<Details_FormatNotSupportedException>

GoogleClientException

using Aspose::Email::GoogleClientException = typedef System::ExceptionWrapper<Details_GoogleClientException>

HyperlinkRenderingCallback

using Aspose::Email::HyperlinkRenderingCallback = typedef System::MulticastDelegate<System::String(System::String)>

ImapException

using Aspose::Email::ImapException = typedef System::ExceptionWrapper<Details_ImapException>

MailException

using Aspose::Email::MailException = typedef System::ExceptionWrapper<Details_MailException>

MessageAcceptanceCallback

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

Pop3Exception

using Aspose::Email::Pop3Exception = typedef System::ExceptionWrapper<Details_Pop3Exception>

SaveResourceHandlerDelegate

using Aspose::Email::SaveResourceHandlerDelegate = typedef System::MulticastDelegate<void(System::SharedPtr<AttachmentBase>, System::String)>

SmtpException

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

SSPIException

using Aspose::Email::SSPIException = typedef System::ExceptionWrapper<Details_SSPIException>

TimeoutException

using Aspose::Email::TimeoutException = typedef System::ExceptionWrapper<Details_TimeoutException>

Enumeration Type Documentation

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 load/save behaviour

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.

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.

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.

MeteredState

enum Aspose::Email::MeteredState

strong

Represents possible metered states.

Enumerator
Evaluation	The metered is evaluation
Paid	The metered is a paid customer.

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.