Message which allows senders to include AMP components inside emails. More...

Inherits Aspose::Email::MailMessage.

Public Member Functions

virtual System::String get_AmpHtmlBody ()
 Gets the AmpHtml representation of message's body. More...
 
virtual void set_AmpHtmlBody (System::String value)
 Gets the AmpHtml representation of message's body. More...
 
 AmpMessage ()
 Initializes a new instance of the MailMessage class More...
 
void AddAmpComponent (System::SharedPtr< AmpComponent > component)
 Add Amp component to this message. More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< SaveOptions > options) override
 Save message as a stream More...
 
- Public Member Functions inherited from Aspose::Email::MailMessage
System::String get_Preamble ()
 Gets a preamble text. It is located before the first boundary and generally includes an explanatory note to non-MIME conformant readers. More...
 
void set_Preamble (System::String value)
 Sets a preamble text. It is located before the first boundary and generally includes an explanatory note to non-MIME conformant readers. More...
 
System::String get_Epilogue ()
 Gets an epilogue text. It is located after the last boundary. More...
 
void set_Epilogue (System::String value)
 Sets an epilogue text. It is located after the last boundary. More...
 
System::SharedPtr< System::Collections::Generic::Dictionary< System::SharedPtr< Mapi::PropertyDescriptor >, System::SharedPtr< System::Object > > > get_ExtendedProperties () const
 Gets extended properties of a message. More...
 
bool get_PreserveTnefAttachment () const
 Controls TNEF attachment load/save behaviour More...
 
void set_PreserveTnefAttachment (bool value)
 Controls TNEF attachment load/save behaviour More...
 
System::SharedPtr< System::Text::Encoding > get_PreferredTextEncoding () override
 Gets preferred encoding for all text properties More...
 
void set_PreferredTextEncoding (System::SharedPtr< System::Text::Encoding > value) override
 Sets preferred encoding for all text properties More...
 
System::ArrayPtr< System::String > get_Categories () const
 Gets exchange message categories More...
 
void set_Categories (System::ArrayPtr< System::String > value)
 Sets exchange message categories More...
 
System::SharedPtr< MailAddressget_From () override
 Gets the from address More...
 
void set_From (System::SharedPtr< MailAddress > value) override
 Sets the from address More...
 
virtual System::SharedPtr< MailAddressget_Sender ()
 Gets sender address More...
 
virtual void set_Sender (System::SharedPtr< MailAddress > value)
 Sets sender address More...
 
virtual System::SharedPtr< MailAddressget_ReversePath ()
 Gets ReversePath address More...
 
virtual void set_ReversePath (System::SharedPtr< MailAddress > value)
 Sets ReversePath address More...
 
virtual System::SharedPtr< MailAddressCollectionget_ReplyToList ()
 Gets the list of addresses to reply to for the mail message More...
 
virtual void set_ReplyToList (System::SharedPtr< MailAddressCollection > value)
 Sets the list of addresses to reply to for the mail message More...
 
System::SharedPtr< MailAddressCollectionget_To () override
 Gets the address collection that contains the recipients of message More...
 
virtual void set_To (System::SharedPtr< MailAddressCollection > value)
 Sets the address collection that contains the recipients of message More...
 
System::SharedPtr< MailAddressCollectionget_Bcc () override
 Gets the address collection that contains the BCC recipients of message More...
 
virtual void set_Bcc (System::SharedPtr< MailAddressCollection > value)
 Sets the address collection that contains the BCC recipients of message More...
 
bool get_SuppressBcc ()
 Indicates whether Bcc header is suppressed in MIME. More...
 
void set_SuppressBcc (bool value)
 Indicates whether Bcc header is suppressed in MIME. More...
 
System::SharedPtr< MailAddressCollectionget_CC () override
 Gets the address collection that contains the CC recipients More...
 
virtual void set_CC (System::SharedPtr< MailAddressCollection > value)
 Sets the address collection that contains the CC recipients More...
 
virtual MailPriority get_Priority ()
 Gets the priority of message More...
 
virtual void set_Priority (MailPriority value)
 Sets the priority of message More...
 
virtual MailSensitivity get_Sensitivity ()
 Gets the sensitivity of message More...
 
virtual void set_Sensitivity (MailSensitivity value)
 Sets the sensitivity of message More...
 
virtual Aspose::Email::DeliveryNotificationOptions get_DeliveryNotificationOptions ()
 Gets the delivery notifications More...
 
virtual void set_DeliveryNotificationOptions (Aspose::Email::DeliveryNotificationOptions value)
 Sets the delivery notifications More...
 
System::String get_Subject () override
 Gets the subject line More...
 
void set_Subject (System::String value) override
 Sets the subject line More...
 
System::String get_ListUnsubscribe ()
 The List-Unsubscribe field describes the command (preferably using mail) to directly unsubscribe the user(removing them from the list). For more details please see https://tools.ietf.org/html/rfc2369 More...
 
void set_ListUnsubscribe (System::String value)
 The List-Unsubscribe field describes the command (preferably using mail) to directly unsubscribe the user(removing them from the list). For more details please see https://tools.ietf.org/html/rfc2369 More...
 
System::TimeSpan get_TimeZoneOffset ()
 Gets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC. More...
 
void set_TimeZoneOffset (System::TimeSpan value)
 Sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the local time and UTC. More...
 
System::DateTime get_Date () override
 Gets the date of message More...
 
virtual void set_Date (System::DateTime value)
 Sets the date of message More...
 
virtual System::String get_MessageId ()
 Gets the message id More...
 
virtual void set_MessageId (System::String value)
 Sets the message id More...
 
virtual System::String get_XMailer ()
 Gets the X-Mailer the software that created the e-mail message More...
 
virtual void set_XMailer (System::String value)
 Sets the X-Mailer the software that created the e-mail message More...
 
virtual System::SharedPtr< System::Text::Encoding > get_SubjectEncoding ()
 Gets the encoding of subject More...
 
virtual void set_SubjectEncoding (System::SharedPtr< System::Text::Encoding > value)
 Sets the encoding of subject More...
 
virtual System::SharedPtr< Mime::HeaderCollectionget_Headers ()
 Gets headers collection of message More...
 
System::String get_HtmlBody () override
 Gets html body More...
 
void set_HtmlBody (System::String value) override
 Sets html body More...
 
System::String get_Body () override
 Gets the plain text representation of message's body. If the text/plain part is present in a message, the propery returns its text data. Otherwise, property returns the text content of the HtmlBody property without html markup.
More...
 
void set_Body (System::String value) override
 Sets the plain text representation of message's body. If the text/plain part is present in a message, the propery returns its text data. Otherwise, property returns the text content of the HtmlBody property without html markup.
More...
 
virtual System::SharedPtr< System::Text::Encoding > get_BodyEncoding ()
 Gets encoding of body More...
 
virtual void set_BodyEncoding (System::SharedPtr< System::Text::Encoding > value)
 Sets encoding of body More...
 
virtual bool get_IsBodyHtml ()
 Gets a value indicating whether the message body is in Html More...
 
virtual void set_IsBodyHtml (bool value)
 Sets a value indicating whether the message body is in Html More...
 
virtual bool get_IsSigned ()
 Gets a value indicating whether the message is signed. More...
 
virtual bool get_IsEncrypted ()
 Gets a value indicating whether the message is encrypted. More...
 
virtual bool get_IsReadOnly ()
 Gets a value indicating whether the message is read only More...
 
virtual System::SharedPtr< MailboxInfoget_ItemId ()
 Represents identification information about message in a mailbox. More...
 
virtual void set_ItemId (System::SharedPtr< MailboxInfo > value)
 Represents identification information about message in a mailbox. More...
 
bool get_IsRead ()
 
virtual bool get_IsDraft ()
 Gets value that indicates whether or not a message has been sent. More...
 
virtual void set_IsDraft (bool value)
 Sets value that indicates whether or not a message has been sent. More...
 
System::SharedPtr< AttachmentCollectionget_Attachments () override
 Gets the collection of attachments of message More...
 
virtual System::SharedPtr< LinkedResourceCollectionget_LinkedResources ()
 Gets the collection of linked resources of message More...
 
virtual System::SharedPtr< AlternateViewCollectionget_AlternateViews ()
 Gets the collection of alternate views of message More...
 
Mapi::BodyContentType get_BodyType () override
 Gets the type of the body. More...
 
virtual bool get_OriginalIsTnef ()
 Gets a value indicating whether original EML message is in TNEF format. More...
 
System::SharedPtr< Aspose::Email::Message > get_Message () const
 
System::SharedPtr< Aspose::Email::Tnef::TnefAttachment > get_TnefAttachment () const
 Gets the tnef attachment. More...
 
void set_TnefAttachment (System::SharedPtr< Aspose::Email::Tnef::TnefAttachment > value)
 Gets the tnef attachment. More...
 
System::SharedPtr< MailAddressCollectionget_ReadReceiptTo ()
 Gets the read receipt address. More...
 
void set_ReadReceiptTo (System::SharedPtr< MailAddressCollection > value)
 Sets the read receipt address. More...
 
bool get_ReadReceiptRequested () const
 
void set_ReadReceiptRequested (bool value)
 
System::SharedPtr< System::Object > get_VentLicense () const
 This stores the venture licensing state instead of 2 obvious fields such as string value for watermark and some value indicating license is set or not. More...
 
bool get_IsEmpty ()
 
 MailMessage (System::String from, System::String to)
 Initializes a new instance of the MailMessage class More...
 
 MailMessage ()
 Initializes a new instance of the MailMessage class More...
 
 MailMessage (bool increaseCredit)
 Initializes a new instance of the MailMessage class More...
 
 MailMessage (System::String from, System::String to, System::String subject, System::String body)
 Initializes a new instance of the MailMessage class More...
 
 MailMessage (System::SharedPtr< MailAddress > from, System::SharedPtr< MailAddress > to)
 Initializes a new instance of the MailMessage class More...
 
virtual void set_From (System::String value)
 
virtual void set_Sender (System::String value)
 
virtual void set_ReplyToList (System::String value)
 
virtual void set_ReplyToList (System::SharedPtr< MailAddress > value)
 
virtual void set_To (System::String value)
 
virtual void set_To (System::SharedPtr< MailAddress > value)
 
System::String GetAlternateViewContent (System::String mediaType)
 Gets the content as a string from the specified AlternateView. More...
 
virtual void Import (System::SharedPtr< System::IO::Stream > stream)
 Populates a T:System::Runtime::Serialization::SerializationInfo with the data needed to serialize the target object. More...
 
virtual System::SharedPtr< MailMessageClone ()
 Clones this instance More...
 
void RecomposeTnefContent ()
 Composes the TNEF content. Note, that tnef attachment is composed if a message initially contained TNEF and was loaded without FileCompatibilityMode.PreserveTnefAttachments flag, That is this method doesn't create tnef message out of the regular one. More...
 
virtual void SetHtmlBody (System::String value, bool detectEncoding)
 Sets html body. More...
 
virtual System::String GetHtmlBodyText (bool showUrl)
 Gets the message html body as plain text. This method parses the HtmlBody property and returns plain text content ignoring the html markup. More...
 
virtual System::String GetHtmlBodyText (Common::Transform::HyperlinkRenderingCallback hyperlinkRenderingCallback)
 Gets the message htmlbody as plain text. More...
 
void Save (System::String fileName) override
 Save message as a file More...
 
virtual void Save (System::String fileName, System::SharedPtr< SaveOptions > options)
 Save message as a file with additional options. More...
 
int32_t GetHashCode () const override
 Returns a hash code for object More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Determines whether the specified Object is equal to the current Object. More...
 
void Save (System::SharedPtr< System::IO::Stream > stream) override
 Save message as a stream More...
 
virtual void set_ReadReceiptTo (System::String value)
 
System::SharedPtr< MailMessageCreateReadReceipt (System::String from, System::String bodyText)
 Creates the read receipt. More...
 
virtual void AddAlternateView (System::SharedPtr< AlternateView > view)
 Add an alternate view to message More...
 
virtual void AddAttachment (System::SharedPtr< Attachment > attachment)
 Add an attachment to message More...
 
void Dispose () override
 Releases all resources used by the MailMessage More...
 
virtual System::SharedPtr< Bounce::BounceResultCheckBounced ()
 Checks whether this message can be treated as a bounce message. More...
 
void OnConversionProgress (System::SharedPtr< ProgressEventHandlerInfo > info)
 
void ImportHeaders (System::SharedPtr< Aspose::Email::Message > message)
 
void ImportHeaders (System::SharedPtr< System::IO::Stream > stream)
 
System::String GetHeadersAsString ()
 
void ForceTextContentType ()
 
void SetMessageId (System::String value)
 
void Send (System::SharedPtr< Mime::BaseWriter > writer, System::SharedPtr< ProgressEventHandlerInfo > progressInfo)
 
System::String BuildDeliveryStatusNotificationString ()
 
int32_t GetLinkedResourceCount ()
 Gets the count of message linked resources and alternative view linked resourced. More...
 
void SetVentureLicense (System::SharedPtr< System::Object > ventureLicense)
 All Aspose products should implement this method. It is called by a GroupDocs product to indicate whether GroupDocs itself is licensed or not and specify a custom watermark. When GroupDocs is licensed, this document instance should behave as licensed too even if the Aspose product is not licensed. More...
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > SetContent ()
 
System::ArrayPtr< uint8_t > CreateContentData (System::SharedPtr< System::Collections::Generic::ListExt< System::String >> &signedBoundaries)
 
System::ArrayPtr< uint8_t > CreateDKIMContentData (System::SharedPtr< System::Collections::Generic::ListExt< System::String >> &signedBoundaries)
 
void Replace (System::String mediaType, System::SharedPtr< AlternateView > view)
 
void LoadMessageStructure (System::SharedPtr< Clients::Imap::Commands::BodyStructureMultiPart > bodyStructure, System::SharedPtr< Clients::Imap::Commands::BodyStructurePart > &textBodyPart, System::SharedPtr< Clients::Imap::Commands::BodyStructurePart > &htmlBodyPart)
 Loads the message structure and search text body and html body parts' indexes More...
 
System::SharedPtr< AlternateViewGetHtmlView ()
 
System::SharedPtr< AlternateViewGetTextPlainView ()
 
System::SharedPtr< System::Collections::Generic::ListExt< System::SharedPtr< AttachmentBase > > > ListAttachmentBase ()
 
System::String ToString () const override
 Returns a string that represents the current object. More...
 

Public Attributes

System::String ampHtmlBody
 
- Public Attributes inherited from Aspose::Email::MailMessage
System::SharedPtr< AlternateViewCollectionviews
 
System::SharedPtr< AttachmentCollectionattachments
 
System::SharedPtr< LinkedResourceCollectionlinkedResources
 
System::String body
 
System::String bodyHtml
 
System::SharedPtr< System::Text::Encoding > bodyEncoding
 
bool isBodyHtml
 
bool disposed
 
System::SharedPtr< Aspose::Email::Message > message
 
Aspose::Email::DeliveryNotificationOptions deliveryStatusNotification
 
System::SharedPtr< System::Collections::Generic::ListExt< System::String > > boundaries
 
bool isProcessedByMboxrdStorageWriter
 The property is true, if the current message is processed by a MboxrdStorageWriter. See EMAILNET-38895 and EMAILNET-39005 More...
 
System::Event< void(System::SharedPtr< ProgressEventHandlerInfo >)> ConversionProgressEvent
 Event to notify user about progress of conversion/saving. More...
 

Static Public Attributes

static const System::String AmpMediaType
 

Protected Member Functions

virtual ~AmpMessage ()
 
- Protected Member Functions inherited from Aspose::Email::MailMessage
virtual void Dispose (bool disposing)
 Releases unmanaged and - optionally - managed resources More...
 
virtual ~MailMessage ()
 

Friends

class Aspose::Email::MailMessage
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::MailMessage
static System::SharedPtr< MailMessageLoad (System::String fileName)
 Load message from file More...
 
static System::SharedPtr< MailMessageLoad (System::SharedPtr< System::IO::Stream > stream)
 Load message from stream More...
 
static System::SharedPtr< MailMessageLoadInternal (System::SharedPtr< System::IO::Stream > stream)
 Load message from stream. NOTE!!! Call this method if you don't need to increase customer consumption credit for Dynabic.Metered. More...
 
static System::SharedPtr< MailMessageLoad (System::String fileName, System::SharedPtr< LoadOptions > options)
 Load message from file with additional options. More...
 
static System::SharedPtr< MailMessageLoad (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< LoadOptions > options)
 Load message from stream with additional options. More...
 
static System::SharedPtr< MailMessageLoadInternal (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< LoadOptions > options)
 Load message from stream with additional options. NOTE!!! Call this method if you don't need to increase customer consumption credit for Dynabic.Metered. More...
 
static System::SharedPtr< System::IO::MemoryStream > GetEmlStream (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< System::Collections::Generic::ListExt< uint8_t >> &headerBytes)
 
static System::SharedPtr< EmlValidationErrorCollectionValidateMessage (System::String fileName)
 Validate eml message for corresponding to mime specification. More...
 
static System::SharedPtr< EmlValidationErrorCollectionValidateMessage (System::SharedPtr< System::IO::Stream > stream)
 Validate eml message for corresponding to mime specification. More...
 
static System::SharedPtr< System::Text::Encoding > TryGetEncodingFromHtmlBody (System::String htmlBody)
 

Detailed Description

Message which allows senders to include AMP components inside emails.

Constructor & Destructor Documentation

◆ AmpMessage()

Aspose::Email::Amp::AmpMessage::AmpMessage ( )

Initializes a new instance of the MailMessage class

◆ ~AmpMessage()

virtual Aspose::Email::Amp::AmpMessage::~AmpMessage ( )
protectedvirtual

Member Function Documentation

◆ AddAmpComponent()

void Aspose::Email::Amp::AmpMessage::AddAmpComponent ( System::SharedPtr< AmpComponent component)

Add Amp component to this message.

Parameters
component

◆ get_AmpHtmlBody()

virtual System::String Aspose::Email::Amp::AmpMessage::get_AmpHtmlBody ( )
virtual

Gets the AmpHtml representation of message's body.

◆ Save()

void Aspose::Email::Amp::AmpMessage::Save ( System::SharedPtr< System::IO::Stream >  stream,
System::SharedPtr< SaveOptions options 
)
overridevirtual

Save message as a stream

Parameters
streamStream into which message is saved
optionsAdditional options for savingSaveOptions.

Reimplemented from Aspose::Email::MailMessage.

◆ set_AmpHtmlBody()

virtual void Aspose::Email::Amp::AmpMessage::set_AmpHtmlBody ( System::String  value)
virtual

Gets the AmpHtml representation of message's body.

Friends And Related Function Documentation

◆ Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage
friend

Member Data Documentation

◆ ampHtmlBody

System::String Aspose::Email::Amp::AmpMessage::ampHtmlBody

◆ AmpMediaType

const System::String Aspose::Email::Amp::AmpMessage::AmpMediaType
static