Class Email

java.lang.Object
com.mypurecloud.sdk.v2.model.Email
All Implemented Interfaces:
Serializable

public class Email extends Object implements Serializable
Email
See Also:
  • Constructor Details

    • Email

      public Email()
    • Email

      public Email(Boolean initWithEmptyList)
  • Method Details

    • state

      public Email state(Email.StateEnum state)
      The connection state of this communication.
    • getState

      public Email.StateEnum getState()
    • setState

      public void setState(Email.StateEnum state)
    • initialState

      public Email initialState(Email.InitialStateEnum initialState)
      The initial connection state of this communication.
    • getInitialState

      public Email.InitialStateEnum getInitialState()
    • setInitialState

      public void setInitialState(Email.InitialStateEnum initialState)
    • id

      public Email id(String id)
      A globally unique identifier for this communication.
    • getId

      public String getId()
    • setId

      public void setId(String id)
    • held

      public Email held(Boolean held)
      True if this call is held and the person on this side hears silence.
    • getHeld

      public Boolean getHeld()
    • setHeld

      public void setHeld(Boolean held)
    • subject

      public Email subject(String subject)
      The subject for the initial email that started this conversation.
    • getSubject

      public String getSubject()
    • setSubject

      public void setSubject(String subject)
    • messagesSent

      public Email messagesSent(Integer messagesSent)
      The number of email messages sent by this participant.
    • getMessagesSent

      public Integer getMessagesSent()
    • setMessagesSent

      public void setMessagesSent(Integer messagesSent)
    • segments

      public Email segments(List<Segment> segments)
      The time line of the participant's email, divided into activity segments.
    • getSegments

      public List<Segment> getSegments()
    • setSegments

      public void setSegments(List<Segment> segments)
    • direction

      public Email direction(Email.DirectionEnum direction)
      The direction of the email
    • getDirection

      public Email.DirectionEnum getDirection()
    • setDirection

      public void setDirection(Email.DirectionEnum direction)
    • recordingId

      public Email recordingId(String recordingId)
      A globally unique identifier for the recording associated with this call.
    • getRecordingId

      public String getRecordingId()
    • setRecordingId

      public void setRecordingId(String recordingId)
    • errorInfo

      public Email errorInfo(ErrorBody errorInfo)
    • getErrorInfo

      public ErrorBody getErrorInfo()
    • setErrorInfo

      public void setErrorInfo(ErrorBody errorInfo)
    • disconnectType

      public Email disconnectType(Email.DisconnectTypeEnum disconnectType)
      System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
    • getDisconnectType

      public Email.DisconnectTypeEnum getDisconnectType()
    • setDisconnectType

      public void setDisconnectType(Email.DisconnectTypeEnum disconnectType)
    • startHoldTime

      public Email startHoldTime(Date startHoldTime)
      The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getStartHoldTime

      public Date getStartHoldTime()
    • setStartHoldTime

      public void setStartHoldTime(Date startHoldTime)
    • startAlertingTime

      public Email startAlertingTime(Date startAlertingTime)
      The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getStartAlertingTime

      public Date getStartAlertingTime()
    • setStartAlertingTime

      public void setStartAlertingTime(Date startAlertingTime)
    • connectedTime

      public Email connectedTime(Date connectedTime)
      The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getConnectedTime

      public Date getConnectedTime()
    • setConnectedTime

      public void setConnectedTime(Date connectedTime)
    • disconnectedTime

      public Email disconnectedTime(Date disconnectedTime)
      The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getDisconnectedTime

      public Date getDisconnectedTime()
    • setDisconnectedTime

      public void setDisconnectedTime(Date disconnectedTime)
    • autoGenerated

      public Email autoGenerated(Boolean autoGenerated)
      Indicates that the email was auto-generated like an Out of Office reply.
    • getAutoGenerated

      public Boolean getAutoGenerated()
    • setAutoGenerated

      public void setAutoGenerated(Boolean autoGenerated)
    • provider

      public Email provider(String provider)
      The source provider for the email.
    • getProvider

      public String getProvider()
    • setProvider

      public void setProvider(String provider)
    • scriptId

      public Email scriptId(String scriptId)
      The UUID of the script to use.
    • getScriptId

      public String getScriptId()
    • setScriptId

      public void setScriptId(String scriptId)
    • peerId

      public Email peerId(String peerId)
      The id of the peer communication corresponding to a matching leg for this communication.
    • getPeerId

      public String getPeerId()
    • setPeerId

      public void setPeerId(String peerId)
    • messageId

      public Email messageId(String messageId)
      A globally unique identifier for the stored content of this communication.
    • getMessageId

      public String getMessageId()
    • setMessageId

      public void setMessageId(String messageId)
    • draftAttachments

      public Email draftAttachments(List<Attachment> draftAttachments)
      A list of uploaded attachments on the email draft.
    • getDraftAttachments

      public List<Attachment> getDraftAttachments()
    • setDraftAttachments

      public void setDraftAttachments(List<Attachment> draftAttachments)
    • spam

      public Email spam(Boolean spam)
      Indicates if the inbound email was marked as spam.
    • getSpam

      public Boolean getSpam()
    • setSpam

      public void setSpam(Boolean spam)
    • wrapup

      public Email wrapup(Wrapup wrapup)
      Call wrap up or disposition data.
    • getWrapup

      public Wrapup getWrapup()
    • setWrapup

      public void setWrapup(Wrapup wrapup)
    • afterCallWork

      public Email afterCallWork(AfterCallWork afterCallWork)
      After-call work for the communication.
    • getAfterCallWork

      public AfterCallWork getAfterCallWork()
    • setAfterCallWork

      public void setAfterCallWork(AfterCallWork afterCallWork)
    • afterCallWorkRequired

      public Email afterCallWorkRequired(Boolean afterCallWorkRequired)
      Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.
    • getAfterCallWorkRequired

      public Boolean getAfterCallWorkRequired()
    • setAfterCallWorkRequired

      public void setAfterCallWorkRequired(Boolean afterCallWorkRequired)
    • queueMediaSettings

      public Email queueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)
      Represents the queue settings for this media type.
    • getQueueMediaSettings

      public ConversationQueueMediaSettings getQueueMediaSettings()
    • setQueueMediaSettings

      public void setQueueMediaSettings(ConversationQueueMediaSettings queueMediaSettings)
    • parkTime

      public Email parkTime(Date parkTime)
      Represents the time when an email was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getParkTime

      public Date getParkTime()
    • setParkTime

      public void setParkTime(Date parkTime)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object