Field (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- java.lang.Enum<Field>
- - com.groupdocs.viewer.options.Field

All Implemented Interfaces:

Serializable, Comparable<Field>
```
public enum Field
extends Enum<Field>
```
Represents email message fields e.g. From, To, Subject etc.
The Field enum represents common email message fields in the GroupDocs.Viewer component. It provides a set of predefined fields that can be used to identify and access specific information in email messages, such as the sender, recipient, subject, and more.

For details, see the documentation.

Example usage:
```
 HtmlViewOptions htmlViewOptions = HtmlViewOptions.forEmbeddedResources();
 EmailOptions emailOptions = htmlViewOptions.getEmailOptions();
 emailOptions.getFieldTextMap().put(Field.FROM, "Sender");

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(htmlViewOptions);
     // Use the viewer object for further operations
 }
 
```
See Also:

HtmlViewOptions, EmailOptions, Viewer

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANNIVERSARY` Represents the "Anniversary" field.
`ATTACHMENTS` Represents the "Attachments" field.
`BCC` Represents the "Bcc" field.
`BIRTHDAY` Represents the "Birthday" field.
`BUSINESS` Represents the "Business" field.
`BUSINESS_ADDRESS` Represents the "Business Address" field.
`BUSINESS_FAX` Represents the "Business Fax" field.
`BUSINESS_HOMEPAGE` Represents the "BusinessHomepage" field.
`CC` Represents the "Cc" field.
`COMPANY` Represents the "Company" field.
`DEPARTMENT` Represents the "Department" field.
`EMAIL` Represents the "Email" field.
`EMAIL_2` Represents the "Email2" field.
`EMAIL_2_DISPLAY_AS` Represents the "Email2 Display As" field.
`EMAIL_3` Represents the "Email3" field.
`EMAIL_3_DISPLAY_AS` Represents the "Email3 Display As" field.
`EMAIL_DISPLAY_AS` Represents the "Email Display As" field.
`END` Represents the "End" field.
`FIRST_NAME` Represents the "First Name" field.
`FROM` Represents the "From" field.
`FULL_NAME` Represents the "Full Name" field.
`GENDER` Represents the "Gender" field.
`HOBBIES` Represents the "Hobbies" field.
`HOME` Represents the "Home" field.
`HOME_ADDRESS` Represents the "Home Address" field.
`IMPORTANCE` Represents the "Importance" field.
`JOB_TITLE` Represents the "Job Title" field.
`LAST_NAME` Represents the "Last Name" field.
`LOCATION` Represents the "Location" field.
`MIDDLE_NAME` Represents the "Middle Name" field.
`MOBILE` Represents the "Mobile" field.
`ORGANIZER` Represents the "Organizer" field.
`OTHER_ADDRESS` Represents the "Other Address" field.
`PERSONAL_HOMEPAGE` Represents the "Personal Homepage" field.
`PROFESSION` Represents the "Profession" field.
`RECURRENCE` Represents the "Recurrence" field.
`RECURRENCE_PATTERN` Represents the "Recurrence Pattern" field.
`REQUIRED_ATTENDEES` Represents the "Required Attendees" field.
`SENT` Represents the "Sent" field.
`SHOW_TIME_AS` Represents the "Show Time As" field.
`SPOUSE_PARTNER` Represents the "Spouse/Partner" field.
`START` Represents the "Start" field.
`SUBJECT` Represents the "Subject" field.
`TO` Represents the "To" field.
`USER_FIELD_1` Represents the "User Field 1" field.
`USER_FIELD_2` Represents the "User Field 2" field.
`USER_FIELD_3` Represents the "User Field 3" field.
`USER_FIELD_4` Represents the "User Field 4" field.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Field name.
`String`	`toString()` Returns a string that represents the current object.
`static Field`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Field[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ANNIVERSARY
```
public static final Field ANNIVERSARY
```
    Represents the "Anniversary" field.
  - ATTACHMENTS
```
public static final Field ATTACHMENTS
```
    Represents the "Attachments" field.
  - BCC
```
public static final Field BCC
```
    Represents the "Bcc" field.
  - BIRTHDAY
```
public static final Field BIRTHDAY
```
    Represents the "Birthday" field.
  - BUSINESS
```
public static final Field BUSINESS
```
    Represents the "Business" field.
  - BUSINESS_ADDRESS
```
public static final Field BUSINESS_ADDRESS
```
    Represents the "Business Address" field.
  - BUSINESS_FAX
```
public static final Field BUSINESS_FAX
```
    Represents the "Business Fax" field.
  - BUSINESS_HOMEPAGE
```
public static final Field BUSINESS_HOMEPAGE
```
    Represents the "BusinessHomepage" field.
  - CC
```
public static final Field CC
```
    Represents the "Cc" field.
  - COMPANY
```
public static final Field COMPANY
```
    Represents the "Company" field.
  - DEPARTMENT
```
public static final Field DEPARTMENT
```
    Represents the "Department" field.
  - EMAIL
```
public static final Field EMAIL
```
    Represents the "Email" field.
  - EMAIL_2
```
public static final Field EMAIL_2
```
    Represents the "Email2" field.
  - EMAIL_2_DISPLAY_AS
```
public static final Field EMAIL_2_DISPLAY_AS
```
    Represents the "Email2 Display As" field.
  - EMAIL_3
```
public static final Field EMAIL_3
```
    Represents the "Email3" field.
  - EMAIL_3_DISPLAY_AS
```
public static final Field EMAIL_3_DISPLAY_AS
```
    Represents the "Email3 Display As" field.
  - EMAIL_DISPLAY_AS
```
public static final Field EMAIL_DISPLAY_AS
```
    Represents the "Email Display As" field.
  - END
```
public static final Field END
```
    Represents the "End" field.
  - FIRST_NAME
```
public static final Field FIRST_NAME
```
    Represents the "First Name" field.
  - FROM
```
public static final Field FROM
```
    Represents the "From" field.
  - FULL_NAME
```
public static final Field FULL_NAME
```
    Represents the "Full Name" field.
  - GENDER
```
public static final Field GENDER
```
    Represents the "Gender" field.
  - HOBBIES
```
public static final Field HOBBIES
```
    Represents the "Hobbies" field.
  - HOME
```
public static final Field HOME
```
    Represents the "Home" field.
  - HOME_ADDRESS
```
public static final Field HOME_ADDRESS
```
    Represents the "Home Address" field.
  - IMPORTANCE
```
public static final Field IMPORTANCE
```
    Represents the "Importance" field.
  - JOB_TITLE
```
public static final Field JOB_TITLE
```
    Represents the "Job Title" field.
  - LAST_NAME
```
public static final Field LAST_NAME
```
    Represents the "Last Name" field.
  - LOCATION
```
public static final Field LOCATION
```
    Represents the "Location" field.
  - MIDDLE_NAME
```
public static final Field MIDDLE_NAME
```
    Represents the "Middle Name" field.
  - MOBILE
```
public static final Field MOBILE
```
    Represents the "Mobile" field.
  - ORGANIZER
```
public static final Field ORGANIZER
```
    Represents the "Organizer" field.
  - OTHER_ADDRESS
```
public static final Field OTHER_ADDRESS
```
    Represents the "Other Address" field.
  - PERSONAL_HOMEPAGE
```
public static final Field PERSONAL_HOMEPAGE
```
    Represents the "Personal Homepage" field.
  - PROFESSION
```
public static final Field PROFESSION
```
    Represents the "Profession" field.
  - RECURRENCE
```
public static final Field RECURRENCE
```
    Represents the "Recurrence" field.
  - RECURRENCE_PATTERN
```
public static final Field RECURRENCE_PATTERN
```
    Represents the "Recurrence Pattern" field.
  - REQUIRED_ATTENDEES
```
public static final Field REQUIRED_ATTENDEES
```
    Represents the "Required Attendees" field.
  - SENT
```
public static final Field SENT
```
    Represents the "Sent" field.
  - SHOW_TIME_AS
```
public static final Field SHOW_TIME_AS
```
    Represents the "Show Time As" field.
  - SPOUSE_PARTNER
```
public static final Field SPOUSE_PARTNER
```
    Represents the "Spouse/Partner" field.
  - START
```
public static final Field START
```
    Represents the "Start" field.
  - SUBJECT
```
public static final Field SUBJECT
```
    Represents the "Subject" field.
  - TO
```
public static final Field TO
```
    Represents the "To" field.
  - USER_FIELD_1
```
public static final Field USER_FIELD_1
```
    Represents the "User Field 1" field.
  - USER_FIELD_2
```
public static final Field USER_FIELD_2
```
    Represents the "User Field 2" field.
  - USER_FIELD_3
```
public static final Field USER_FIELD_3
```
    Represents the "User Field 3" field.
  - USER_FIELD_4
```
public static final Field USER_FIELD_4
```
    Represents the "User Field 4" field.
- Method Detail
  - getName
```
public final String getName()
```
    Field name.
    
    This method retrieves the name of the field.
    
    Returns:
    
    the name of the field.
  - toString
```
public String toString()
```
    Returns a string that represents the current object.
    
    Overrides:
    
    toString in class Enum<Field>
    
    Returns:
    
    a string that represents the current object.
  - valueOf
```
public static Field valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - values
```
public static Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Field c : Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ANNIVERSARY

ATTACHMENTS

BCC

BIRTHDAY

BUSINESS

BUSINESS_ADDRESS

BUSINESS_FAX

BUSINESS_HOMEPAGE

CC

COMPANY

DEPARTMENT

EMAIL

EMAIL_2

EMAIL_2_DISPLAY_AS

EMAIL_3

EMAIL_3_DISPLAY_AS

EMAIL_DISPLAY_AS

END

FIRST_NAME

FROM

FULL_NAME

GENDER

HOBBIES

HOME

HOME_ADDRESS

IMPORTANCE

JOB_TITLE

LAST_NAME

LOCATION

MIDDLE_NAME

MOBILE

ORGANIZER

OTHER_ADDRESS

PERSONAL_HOMEPAGE

PROFESSION

RECURRENCE

RECURRENCE_PATTERN

REQUIRED_ATTENDEES

SENT

SHOW_TIME_AS

SPOUSE_PARTNER

START

SUBJECT

TO

USER_FIELD_1

USER_FIELD_2

USER_FIELD_3

USER_FIELD_4

Method Detail

getName

toString

valueOf

values