com.groupdocs.viewer.options

Class EmailOptions

java.lang.Object

com.groupdocs.viewer.options.EmailOptions

public class EmailOptions
extends Object

Provides options for rendering email messages.

The EmailOptions class encapsulates various settings and parameters that can be used to control the rendering of email messages in the GroupDocs.Viewer component.

For details, see the documentation.

Example usage:

 EmailOptions options = new EmailOptions();
 options.setDateTimeFormat("MM d yyyy HH:mm tt");
 options.setPageSize(PageSize.A4);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setEmailOptions(options);

 try (Viewer viewer = new Viewer("email.msg")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 

See Also:

PdfViewOptions, Viewer

Constructor Summary

Constructors

Constructor and Description
EmailOptions() Initializes a new instance of the EmailOptions class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Overrides the equals() method of the Object class.
String	getDateTimeFormat() Gets the time format for the date and time values.
Map<Field,String>	getFieldTextMap() Retrieves the mapping between email message fields and their text representations.
PageSize	getPageSize() Gets the size of the output page.
TimeZone	getTimeZoneOffset() Gets the time zone offset for the message.
int	getTimeZoneOffsetMinutes() Gets the time zone minutes offset minutes for the message.
int	hashCode()
void	setDateTimeFormat(String dateTimeFormat) Gets the time format for the date and time values.
void	setFieldTextMap(Map<Field,String> value) Sets the mapping between email message fields and their text representations.
void	setPageSize(PageSize value) Gets the size of the output page.
void	setTimeZoneOffset(int offsetMinutes) Gets the time zone offset minutes offset for the message.
void	setTimeZoneOffset(TimeZone timeZoneOffset) Gets the time zone offset for the message.
String	toString() Overrides the toString() method of the Object class.
String	toString(org.apache.commons.lang3.builder.ToStringStyle style)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EmailOptions

public EmailOptions()

Initializes a new instance of the EmailOptions class. This constructor is used to create a new instance of the EmailOptions class with default settings.

Method Detail

equals

public boolean equals(Object o)

Overrides the equals() method of the Object class.

Overrides:

equals in class Object

Parameters:

o - The object to compare with.

Returns:

true if the objects are equal, false otherwise.

getDateTimeFormat

public String getDateTimeFormat()

Gets the time format for the date and time values.

Note: The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the documentation.

Returns:

the time format for date and time values.

getFieldTextMap

public final Map<Field,String> getFieldTextMap()

Retrieves the mapping between email message fields and their text representations.

Returns:

the mapping between email message fields and their text representations.

getPageSize

public final PageSize getPageSize()

Gets the size of the output page.

Returns:

the page size.

getTimeZoneOffset

public TimeZone getTimeZoneOffset()

Gets the time zone offset for the message.

Note: The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC). For details, see the documentation.

Returns:

the time zone offset.

getTimeZoneOffsetMinutes

public int getTimeZoneOffsetMinutes()

Gets the time zone minutes offset minutes for the message.

Note: The time zone offset minutes represents the minutes difference between the message's time and Coordinated Universal Time (UTC). For details, see the documentation.

Returns:

the time zone offset.

hashCode

public int hashCode()

Computes the hash code value for this object. The hash code is based on the internal state of the object and is used in hash-based data structures such as hash maps and hash sets.

Note: This method overrides the default implementation of the hashCode() method defined in the Object class.

Overrides:

hashCode in class Object

Returns:

the hash code value for this object.

setDateTimeFormat

public void setDateTimeFormat(String dateTimeFormat)

Gets the time format for the date and time values.

Note: The time format is specified using a pattern, such as 'MM d yyyy HH:mm tt'. If the time format is not set, the current system format will be used. For details, see the documentation.

Parameters:

dateTimeFormat - The time format for date and time values.

setFieldTextMap

public final void setFieldTextMap(Map<Field,String> value)

Sets the mapping between email message fields and their text representations.

Parameters:

value - The mapping between email message fields and their text representations.

setPageSize

public final void setPageSize(PageSize value)

Gets the size of the output page.

Parameters:

value - The page size.

setTimeZoneOffset

public void setTimeZoneOffset(int offsetMinutes)

Gets the time zone offset minutes offset for the message.

Note: The time zone minutes offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

Parameters:

offsetMinutes - The time zone offset.

setTimeZoneOffset

public void setTimeZoneOffset(TimeZone timeZoneOffset)

Gets the time zone offset for the message.

Note: The time zone offset represents the time difference between the message's time and Coordinated Universal Time (UTC).

Parameters:

timeZoneOffset - The time zone offset.

toString

public String toString()

Overrides the toString() method of the Object class.

Overrides:

toString in class Object

Returns:

a string representation of the object.

toString

public String toString(org.apache.commons.lang3.builder.ToStringStyle style)

Returns a string representation of this object.

Note: This method overrides the default implementation of the toString() method defined in the Object class.

Parameters:

style - The ToStringStyle to use for generating the string representation.

Returns:

a string representation of this object using the specified ToStringStyle.