Aspose::Email::AlternateView Class Reference

Represents the format to view a message. More...

Inherits Aspose::Email::AttachmentBase.

Public Member Functions
System::SharedPtr< LinkedResourceCollection >	get_LinkedResources ()
	Gets the set of embedded resources referred to by this alternate view. More...
System::SharedPtr< System::Uri >	get_BaseUri ()
	Gets the base URI. More...
void	set_BaseUri (System::SharedPtr< System::Uri > value)
	Sets the base URI. More...
	AlternateView (System::String fileName)
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::String fileName, System::String mediaType)
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::String fileName, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::SharedPtr< System::IO::Stream > contentStream)
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::SharedPtr< System::IO::Stream > contentStream, System::String mediaType)
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::SharedPtr< System::IO::Stream > contentStream, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Initializes a new instance of the AlternateView class. More...
	AlternateView ()
	Initializes a new instance of the AlternateView class. More...
	AlternateView (System::SharedPtr< Aspose::Email::Mime::MimePart > part)
	Initializes a new instance of the AlternateView class. More...
System::SharedPtr< AlternateView >	Clone ()
System::SharedPtr< Mapi::MapiAttachment >	ConvertToMapiAttachment (Mapi::OutlookMessageFormat format, int32_t codePage, int32_t count, bool preserveDates) override
Public Member Functions inherited from Aspose::Email::AttachmentBase
System::SharedPtr< System::IO::Stream >	get_ContentStream ()
	Gets the content stream. More...
void	set_ContentStream (System::SharedPtr< System::IO::Stream > value)
	Sets the content stream. More...
System::String	get_ContentId ()
	Gets the content id. More...
void	set_ContentId (System::String value)
	Sets the content id. More...
virtual System::SharedPtr< Mime::HeaderCollection >	get_Headers ()
	Gets headers collection of attachment. More...
System::SharedPtr< Aspose::Email::Mime::ContentType >	get_ContentType ()
	Gets the type of the content. More...
void	set_ContentType (System::SharedPtr< Aspose::Email::Mime::ContentType > value)
	Sets the type of the content. More...
Aspose::Email::Mime::TransferEncoding	get_TransferEncoding ()
	Gets the transfer encoding. More...
void	set_TransferEncoding (Aspose::Email::Mime::TransferEncoding value)
	Sets the transfer encoding. More...
System::SharedPtr< System::Uri >	get_ContentLocation () const
	Gets the content location. More...
void	set_ContentLocation (System::SharedPtr< System::Uri > value)
	Sets the content location. More...
System::String	get_ItemId () const
void	set_ItemId (System::String value)
System::SharedPtr< Aspose::Email::Mime::MimePart >	get_MimePart () const
	Gets the MIME part. More...
void	set_MimePart (System::SharedPtr< Aspose::Email::Mime::MimePart > value)
	Sets the MIME part. More...
bool	get_Hidden ()
void	set_Hidden (bool value)
virtual void	SaveInternal (System::SharedPtr< System::IO::Stream > stream)
	Saves the specified stream. More...
virtual void	Save (System::SharedPtr< System::IO::Stream > stream)
	Saves the specified stream. More...
virtual void	Save (System::String fileName)
	Saves the specified file name. More...
void	SetContentFromString (System::String contentString, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Sets the content from string. More...
void	SetContentFromString (System::String contentString, System::SharedPtr< System::Text::Encoding > encoding, System::String mediaType)
	Sets the content from string. More...
void	SetContentFromString (System::String contentString, System::SharedPtr< System::Text::Encoding > encoding, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType, Aspose::Email::Mime::TransferEncoding te)
	Sets the content from string. More...
void	SetSTnefContent (System::ArrayPtr< uint8_t > data)
	Sets the S/TNEF content. More...
virtual void	PrepareForSending ()
	Prepares for sending. More...
void	Dispose () override
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Static Public Member Functions
static System::SharedPtr< AlternateView >	CreateAlternateViewFromString (System::String content)
	Creates a AlternateView of using the content specified in a string. More...
static System::SharedPtr< AlternateView >	CreateAlternateViewFromString (System::String content, System::SharedPtr< System::Text::Encoding > contentEncoding, System::String mediaType)
	Creates a AlternateView of using the content specified in a string. More...
static System::SharedPtr< AlternateView >	CreateAlternateViewFromString (System::String content, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Creates a AlternateView of using the content specified in a string. More...
static System::SharedPtr< AlternateView >	CreateAlternateViewFromString (System::String content, System::SharedPtr< System::Text::Encoding > contentEncoding, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
static System::SharedPtr< AlternateView >	CreateAlternateViewFromString (System::String content, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType, Aspose::Email::Mime::TransferEncoding transferencoding)
	Creates a AlternateView of using the content specified in a string. More...

Public Attributes
System::SharedPtr< System::Object >	baseObject
	Reference to the base object More...
Public Attributes inherited from Aspose::Email::AttachmentBase
bool	Disposed
	Is disposed. More...
int32_t	TnefAttachIndex

Protected Member Functions
void	Dispose (bool disposing) override
	Releases unmanaged and - optionally - managed resources. More...
Protected Member Functions inherited from Aspose::Email::AttachmentBase
	AttachmentBase ()
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::SharedPtr< System::IO::Stream > contentStream, System::String name, System::String mediaType)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::String fileName)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::String fileName, System::String mediaType)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::String fileName, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::SharedPtr< System::IO::Stream > contentStream)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::SharedPtr< System::IO::Stream > contentStream, System::String mediaType)
	Initializes a new instance of the AttachmentBase class. More...
	AttachmentBase (System::SharedPtr< System::IO::Stream > contentStream, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Initializes a new instance of the AttachmentBase class. More...
virtual System::String	GenerateContentId ()
	Generates the content id value. More...
virtual	~AttachmentBase ()

Friends
class	Aspose::Email::MailMessage
class	Aspose::Email::Calendar::Appointment
class	Aspose::Email::Calendar::Task
class	Aspose::Email::Clients::Exchange::WebService::Implementation::Messages::Send::EwsClientMessageSend
class	Aspose::Email::Mapi::ContactMailMessageInterpretor

Additional Inherited Members
Static Protected Member Functions inherited from Aspose::Email::AttachmentBase
static System::SharedPtr< System::Text::Encoding >	GetEncodingFromContent (System::String contentString, System::SharedPtr< Aspose::Email::Mime::ContentType > contentType)
	Defines Encoding from content. More...

Detailed Description

Represents the format to view a message.

The following example shows how to create and add AlternateView to MailMessage.

[C#]

var eml = new MailMessage
{
    From = "AndrewIrwin@from.com",
    To = "SusanMarc@to.com",
    Subject = "This is an email"
};
 
// Create the plain text part It is viewable by those clients that don't support HTML
var plainView = AlternateView.CreateAlternateViewFromString("This is my plain text content", null, "text/plain");
 
// Create the HTML part.To embed images, we need to use the prefix 'cid' in the img src value.
// The cid value will map to the Content-Id of a Linked resource. Thus <img src='cid:barcode'>
// will map to a LinkedResource with a ContentId of 'barcode'.
var htmlView = AlternateView.CreateAlternateViewFromString("Here is an embedded image. <img src=cid:barcode>", null, "text/html");
 
// Create the LinkedResource (embedded image) and Add the LinkedResource to the appropriate view
var barcode = new LinkedResource("1.jpg", MediaTypeNames.Image.Jpeg)
{
    ContentId = "barcode"
};
 
eml.LinkedResources.Add(barcode);
eml.AlternateViews.Add(plainView);
eml.AlternateViews.Add(htmlView);
 
eml.Save("EmbeddedImage_out.msg", SaveOptions.DefaultMsgUnicode);

[Visual Basic]

Dim eml = New MailMessage With {
.From = "AndrewIrwin@from.com",
.[To] = "SusanMarc@to.com",
.Subject = "This is an email"
}
 
' Create the plain text part It is viewable by those clients that don't support HTML
Dim plainView = AlternateView.CreateAlternateViewFromString("This is my plain text content", Nothing, "text/plain")
 
' Create the HTML part.To embed images, we need to use the prefix 'cid' in the img src value.
' The cid value will map to the Content-Id of a Linked resource. Thus <img src='cid:barcode'>
' will map to a LinkedResource with a ContentId of 'barcode'.
Dim htmlView = AlternateView.CreateAlternateViewFromString("Here is an embedded image.<img src=cid:barcode>", Nothing, "text/html")
 
' Create the LinkedResource (embedded image) and Add the LinkedResource to the appropriate view
Dim barcode = New LinkedResource("1.jpg", MediaTypeNames.Image.Jpeg) With {
  .ContentId = "barcode"
    }
 
eml.LinkedResources.Add(barcode)
eml.AlternateViews.Add(plainView)
eml.AlternateViews.Add(htmlView)
eml.Save("EmbeddedImage_out.msg", SaveOptions.DefaultMsgUnicode)

Constructor & Destructor Documentation

AlternateView() [1/8]

Aspose::Email::AlternateView::AlternateView

(

System::String

fileName

)

Initializes a new instance of the AlternateView class.

Parameters

fileName

Name of the file.

AlternateView() [2/8]

Aspose::Email::AlternateView::AlternateView	(	System::String	fileName,
		System::String	mediaType
	)

Initializes a new instance of the AlternateView class.

Parameters

fileName	Name of the file.
mediaType	Internet media type.

AlternateView() [3/8]

Aspose::Email::AlternateView::AlternateView	(	System::String	fileName,
		System::SharedPtr< Aspose::Email::Mime::ContentType >	contentType
	)

Initializes a new instance of the AlternateView class.

Parameters

fileName	Name of the file.
contentType	Content type.

AlternateView() [4/8]

Aspose::Email::AlternateView::AlternateView

(

System::SharedPtr< System::IO::Stream >

contentStream

)

Initializes a new instance of the AlternateView class.

Parameters

contentStream

The content stream.

AlternateView() [5/8]

Aspose::Email::AlternateView::AlternateView	(	System::SharedPtr< System::IO::Stream >	contentStream,
		System::String	mediaType
	)

Initializes a new instance of the AlternateView class.

Parameters

contentStream	The content stream.
mediaType	Internet media type.

AlternateView() [6/8]

Aspose::Email::AlternateView::AlternateView	(	System::SharedPtr< System::IO::Stream >	contentStream,
		System::SharedPtr< Aspose::Email::Mime::ContentType >	contentType
	)

Initializes a new instance of the AlternateView class.

Parameters

contentStream	The content stream.
contentType	Content type.

AlternateView() [7/8]

Aspose::Email::AlternateView::AlternateView

(

)

Initializes a new instance of the AlternateView class.

AlternateView() [8/8]

Aspose::Email::AlternateView::AlternateView

(

System::SharedPtr< Aspose::Email::Mime::MimePart >

part

)

Initializes a new instance of the AlternateView class.

Parameters

part	An attachment mime part

Exceptions

ArgumentNullException

part is null

Member Function Documentation

Clone()

System::SharedPtr<AlternateView> Aspose::Email::AlternateView::Clone

(

)

ConvertToMapiAttachment()

System::SharedPtr<Mapi::MapiAttachment> Aspose::Email::AlternateView::ConvertToMapiAttachment ( Mapi::OutlookMessageFormat  format, int32_t  codePage, int32_t  count, bool  preserveDates  )

overridevirtual

Implements Aspose::Email::AttachmentBase.

CreateAlternateViewFromString() [1/5]

static System::SharedPtr<AlternateView> Aspose::Email::AlternateView::CreateAlternateViewFromString ( System::String  content )

static

Creates a AlternateView of using the content specified in a string.

Parameters

content

The string that contains the content.

Returns

An AlternateView object that represents an alternate view.

CreateAlternateViewFromString() [2/5]

static System::SharedPtr<AlternateView> Aspose::Email::AlternateView::CreateAlternateViewFromString ( System::String  content, System::SharedPtr< Aspose::Email::Mime::ContentType >  contentType  )

static

Creates a AlternateView of using the content specified in a string.

Parameters

content	The string that contains the content.
contentType	Content type.

Returns

An AlternateView object that represents an alternate view.

CreateAlternateViewFromString() [3/5]

static System::SharedPtr<AlternateView> Aspose::Email::AlternateView::CreateAlternateViewFromString ( System::String  content, System::SharedPtr< Aspose::Email::Mime::ContentType >  contentType, Aspose::Email::Mime::TransferEncoding  transferencoding  )

static

Creates a AlternateView of using the content specified in a string.

Parameters

content	The string that contains the content.
contentType	Content type.
transferencoding	The transfer encoding.

Returns

An AlternateView object that represents an alternate view.

CreateAlternateViewFromString() [4/5]

static System::SharedPtr<AlternateView> Aspose::Email::AlternateView::CreateAlternateViewFromString ( System::String  content, System::SharedPtr< System::Text::Encoding >  contentEncoding, System::SharedPtr< Aspose::Email::Mime::ContentType >  contentType  )

static

CreateAlternateViewFromString() [5/5]

static System::SharedPtr<AlternateView> Aspose::Email::AlternateView::CreateAlternateViewFromString ( System::String  content, System::SharedPtr< System::Text::Encoding >  contentEncoding, System::String  mediaType  )

static

Creates a AlternateView of using the content specified in a string.

Parameters

content	The string that contains the content.
contentEncoding	The content encoding.
mediaType	Internet media type.

Returns

An AlternateView object that represents an alternate view.

Dispose()

void Aspose::Email::AlternateView::Dispose ( bool  disposing )

overrideprotectedvirtual

Releases unmanaged and - optionally - managed resources.

Parameters

disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Reimplemented from Aspose::Email::AttachmentBase.

get_BaseUri()

System::SharedPtr<System::Uri> Aspose::Email::AlternateView::get_BaseUri

(

)

Gets the base URI.

The base URI.

get_LinkedResources()

System::SharedPtr<LinkedResourceCollection> Aspose::Email::AlternateView::get_LinkedResources

(

)

Gets the set of embedded resources referred to by this alternate view.

The linked resources.

set_BaseUri()

void Aspose::Email::AlternateView::set_BaseUri

(

System::SharedPtr< System::Uri >

value

)

Sets the base URI.

The base URI.

Friends And Related Function Documentation

Aspose::Email::Calendar::Appointment

friend class Aspose::Email::Calendar::Appointment

friend

Aspose::Email::Calendar::Task

friend class Aspose::Email::Calendar::Task

friend

Aspose::Email::Clients::Exchange::WebService::Implementation::Messages::Send::EwsClientMessageSend

friend class Aspose::Email::Clients::Exchange::WebService::Implementation::Messages::Send::EwsClientMessageSend

friend

Aspose::Email::MailMessage

friend class Aspose::Email::MailMessage

friend

Aspose::Email::Mapi::ContactMailMessageInterpretor

friend class Aspose::Email::Mapi::ContactMailMessageInterpretor

friend

Member Data Documentation

baseObject

System::SharedPtr<System::Object> Aspose::Email::AlternateView::baseObject

Reference to the base object