Aspose::Email Namespace Reference

Namespaces

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

Classes

class  ActiveSyncException
 Represents errors that occur during ActiveSync protocol execution. More...
 
class  ActiveSyncNotSupportedException
 Represents errors that occur during ActiveSync protocol execution. More...
 
class  AlternateView
 Represents the format to view a message. More...
 
class  AlternateViewCollection
 Represents a collection of AlternateView objects. More...
 
class  AlternateViewRemovedEventArgs
 
class  AsposeArgumentException
 The exception that is thrown when one of the arguments provided to a method is not valid. More...
 
class  AsposeArgumentNullException
 The ArgumentException is thrown when an argument is null when it shouldn't be. More...
 
class  AsposeArgumentOutOfRangeException
 The exception that is thrown when one of the arguments provided to a method is out of range. More...
 
class  AsposeException
 Base exception type for Aspose.Email Represents errors that occur during application execution. More...
 
class  AsposeInvalidDataException
 The exception that is thrown when one of the arguments provided to a method is not valid. More...
 
class  AsposeInvalidEnumArgumentException
 Base exceptioon type for Aspose.Email Represents errors that occur during application execution. More...
 
class  AsposeInvalidOperationException
 Exception class for denoting an object was in a state that made calling a method illegal. More...
 
class  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. 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  ElementProcessingException
 The exception that is thrown when one of many elements failed with exception. 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  ExchangeException
 Thrown if there is a MS Exchange communication failure. More...
 
class  FileCorruptedException
 Exception that is thrown during file reading, when the file appears to be corrupted and impossible to read. More...
 
class  FileFormatInfo
 Contains data returned by FileFormatUtil file format detection methods. More...
 
class  FormatNotSupportedException
 Exception that is thrown during document load, when the document format is not recognized or not supported by the component. 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  MailException
 Represents the exception that is thrown when the mail message processing. 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  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  Metered
 Provides methods to set metered key. 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  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  SSPIException
 Represents errors that occur during SSPI execution. More...
 
class  TimeoutException
 Represents the exception that is thrown when the time for operation has expired. More...
 
class  TnefLoadOptions
 Allows to specify additional options when loading MailMessage from Tnef format. More...
 

Typedefs

using SaveResourceHandlerDelegate = System::MulticastDelegate< void(System::SharedPtr< AttachmentBase >, System::String)>
 
using MessageAcceptanceCallback = System::MulticastDelegate< bool(System::SharedPtr< Mapi::MapiMessage >)>
 

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  FileFormatType {
  FileFormatType::Unknown, FileFormatType::Msg, FileFormatType::Eml, FileFormatType::Emlx,
  FileFormatType::Ics, FileFormatType::Vcf, FileFormatType::Ost, FileFormatType::Pst,
  FileFormatType::Tnef, FileFormatType::Mbox, FileFormatType::Oft
}
 Enumerates file format types. More...
 

Functions

 DECLARE_ENUM_OPERATORS (Aspose::Email::ContactFieldsSet)
 
 DECLARE_ENUM_OPERATORS (Aspose::Email::DeliveryNotificationOptions)
 
 DECLARE_ENUM_OPERATORS (Aspose::Email::FileCompatibilityMode)
 
 DECLARE_ENUM_OPERATORS (Aspose::Email::HtmlFormatOptions)
 
 DECLARE_ENUM_OPERATORS (Aspose::Email::MhtFormatOptions)
 

Typedef Documentation

◆ MessageAcceptanceCallback

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

◆ SaveResourceHandlerDelegate

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

Enumeration Type Documentation

◆ ContactFieldsSet

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

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

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

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

Enumerates file format types.

Enumerator
Unknown 

Unknown file format.

Msg 

Outlook MSG file format.

Eml 

File in the MIME standard.

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

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

Represents the mail priopity

Enumerator
Normal 

Normal priority

Low 

Low priority

High 

High priority

◆ MailSensitivity

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

Represents possible metered states.

Enumerator
Evaluation 

The metered is evaluation

Paid 

The metered is a paid customer.

◆ MhtFormatOptions

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

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

Function Documentation

◆ DECLARE_ENUM_OPERATORS() [1/5]

Aspose::Email::DECLARE_ENUM_OPERATORS ( Aspose::Email::FileCompatibilityMode  )

◆ DECLARE_ENUM_OPERATORS() [2/5]

Aspose::Email::DECLARE_ENUM_OPERATORS ( Aspose::Email::DeliveryNotificationOptions  )

◆ DECLARE_ENUM_OPERATORS() [3/5]

Aspose::Email::DECLARE_ENUM_OPERATORS ( Aspose::Email::HtmlFormatOptions  )

◆ DECLARE_ENUM_OPERATORS() [4/5]

Aspose::Email::DECLARE_ENUM_OPERATORS ( Aspose::Email::ContactFieldsSet  )

◆ DECLARE_ENUM_OPERATORS() [5/5]

Aspose::Email::DECLARE_ENUM_OPERATORS ( Aspose::Email::MhtFormatOptions  )