AlternateView

Inheritance: java.lang.Object, com.aspose.email.AttachmentBase

public class AlternateView extends AttachmentBase

Represents the format to view a message.

---

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

[Java]

MailMessage eml = new MailMessage();
 eml.setFrom(MailAddress.to_MailAddress("[e-mail]"));
 eml.setTo(MailAddressCollection.to_MailAddressCollection("[e-mail]"));
 eml.setSubject("This is an email");

 // Create the plain text part It is viewable by those clients that don't support HTML
 AlternateView 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'.
 AlternateView 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
 LinkedResource barcode = new LinkedResource("1.jpg", Image.JPEG);
 barcode.setContentId("barcode");

 eml.getLinkedResources().addItem(barcode);
 eml.getAlternateViews().addItem(plainView);
 eml.getAlternateViews().addItem(htmlView);

 eml.save("EmbeddedImage_out.msg", SaveOptions.getDefaultMsgUnicode());

---

Constructors

Constructor	Description
AlternateView(String fileName)	Initializes a new instance of the AlternateView class.
AlternateView(String fileName, String mediaType)	Initializes a new instance of the AlternateView class.
AlternateView(String fileName, ContentType contentType)	Initializes a new instance of the AlternateView class.
AlternateView(InputStream contentStream)	Initializes a new instance of the AlternateView class.
AlternateView(InputStream contentStream, String mediaType)	Initializes a new instance of the AlternateView class.
AlternateView(InputStream contentStream, ContentType contentType)	Initializes a new instance of the AlternateView class.

Methods

Method	Description
close()
createAlternateViewFromString(String content)	Creates a AlternateView of using the content specified in a string.
createAlternateViewFromString(String content, ContentType contentType)	Creates a AlternateView of using the content specified in a string.
createAlternateViewFromString(String content, ContentType contentType, int transferencoding)	Creates a AlternateView of using the content specified in a string.
createAlternateViewFromString(String content, Charset contentEncoding, String mediaType)	Creates a AlternateView of using the content specified in a string.
dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
equals(Object arg0)
getBaseUri()	Gets or sets the base URI.
getClass()
getContentId()	Gets or sets the content id.
getContentStream()	Gets or sets the content stream.
getContentType()	Gets or sets the type of the content.
getHeaders()	Gets headers collection of attachment.
getLinkedResources()	Gets the set of embedded resources referred to by this alternate view.
getTransferEncoding()	Gets or sets the transfer encoding.
hashCode()
notify()
notifyAll()
save(OutputStream stream)	Saves the specified stream.
save(String fileName)	Saves the specified file name.
setBaseUri(URI value)	Gets or sets the base URI.
setContentId(String value)	Gets or sets the content id.
setContentStream(InputStream value)	Gets or sets the content stream.
setContentType(ContentType value)	Gets or sets the type of the content.
setTransferEncoding(int value)	Gets or sets the transfer encoding.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

AlternateView(String fileName)

public AlternateView(String fileName)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	Name of the file.

AlternateView(String fileName, String mediaType)

public AlternateView(String fileName, String mediaType)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	Name of the file.
mediaType	java.lang.String	Internet media type.

AlternateView(String fileName, ContentType contentType)

public AlternateView(String fileName, ContentType contentType)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	Name of the file.
contentType	ContentType	Content type.

AlternateView(InputStream contentStream)

public AlternateView(InputStream contentStream)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
contentStream	java.io.InputStream	The content stream.

AlternateView(InputStream contentStream, String mediaType)

public AlternateView(InputStream contentStream, String mediaType)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
contentStream	java.io.InputStream	The content stream.
mediaType	java.lang.String	Internet media type.

AlternateView(InputStream contentStream, ContentType contentType)

public AlternateView(InputStream contentStream, ContentType contentType)

Initializes a new instance of the AlternateView class.

Parameters:

Parameter	Type	Description
contentStream	java.io.InputStream	The content stream.
contentType	ContentType	Content type.

close()

public void close()

createAlternateViewFromString(String content)

public static AlternateView createAlternateViewFromString(String content)

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

Parameters:

Parameter	Type	Description
content	java.lang.String	The string that contains the content.

Returns: AlternateView - An AlternateView object that represents an alternate view.

createAlternateViewFromString(String content, ContentType contentType)

public static AlternateView createAlternateViewFromString(String content, ContentType contentType)

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

Parameters:

Parameter	Type	Description
content	java.lang.String	The string that contains the content.
contentType	ContentType	Content type.

Returns: AlternateView - An AlternateView object that represents an alternate view.

createAlternateViewFromString(String content, ContentType contentType, int transferencoding)

public static AlternateView createAlternateViewFromString(String content, ContentType contentType, int transferencoding)

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

Parameters:

Parameter	Type	Description
content	java.lang.String	The string that contains the content.
contentType	ContentType	Content type.
transferencoding	int	The transfer encoding.

Returns: AlternateView - An AlternateView object that represents an alternate view.

createAlternateViewFromString(String content, Charset contentEncoding, String mediaType)

public static AlternateView createAlternateViewFromString(String content, Charset contentEncoding, String mediaType)

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

Parameters:

Parameter	Type	Description
content	java.lang.String	The string that contains the content.
contentEncoding	java.nio.charset.Charset	The content encoding.
mediaType	java.lang.String	Internet media type.

Returns: AlternateView - An AlternateView object that represents an alternate view.

dispose()

public final void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getBaseUri()

public final URI getBaseUri()

Gets or sets the base URI.

Value: The base URI.

Returns: java.net.URI

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getContentId()

public final String getContentId()

Gets or sets the content id.

Value: The content id.

Returns: java.lang.String

getContentStream()

public final InputStream getContentStream()

Gets or sets the content stream.

Value: The content stream.

Returns: java.io.InputStream

getContentType()

public final ContentType getContentType()

Gets or sets the type of the content.

Value: The type of the content.

Returns: ContentType

getHeaders()

public HeaderCollection getHeaders()

Gets headers collection of attachment.

Returns: HeaderCollection

getLinkedResources()

public final LinkedResourceCollection getLinkedResources()

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

Value: The linked resources.

Returns: LinkedResourceCollection

getTransferEncoding()

public final int getTransferEncoding()

Gets or sets the transfer encoding.

Value: The transfer encoding.

Returns: int

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

save(OutputStream stream)

public void save(OutputStream stream)

Saves the specified stream.

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	The stream.

save(String fileName)

public void save(String fileName)

Saves the specified file name.

Parameters:

Parameter	Type	Description
fileName	java.lang.String	Name of the file.

setBaseUri(URI value)

public final void setBaseUri(URI value)

Gets or sets the base URI.

Value: The base URI.

Parameters:

Parameter	Type	Description
value	java.net.URI

setContentId(String value)

public final void setContentId(String value)

Gets or sets the content id.

Value: The content id.

Parameters:

Parameter	Type	Description
value	java.lang.String

setContentStream(InputStream value)

public final void setContentStream(InputStream value)

Gets or sets the content stream.

Value: The content stream.

Parameters:

Parameter	Type	Description
value	java.io.InputStream

setContentType(ContentType value)

public final void setContentType(ContentType value)

Gets or sets the type of the content.

Value: The type of the content.

Parameters:

Parameter	Type	Description
value	ContentType

setTransferEncoding(int value)

public final void setTransferEncoding(int value)

Gets or sets the transfer encoding.

Value: The transfer encoding.

Parameters:

Parameter	Type	Description
value	int

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int