Package com.mypurecloud.sdk.v2.model

Class InboundRoute

java.lang.Object

com.mypurecloud.sdk.v2.model.InboundRoute

All Implemented Interfaces:

Serializable

public class InboundRoute
extends Object
implements Serializable

InboundRoute

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InboundRoute.HistoryInclusionEnum	The configuration to indicate how the history of a conversation has to be included in a draft
static enum	InboundRoute.StatusEnum	The status of the route.

Constructor Summary

Constructors

Constructor	Description
InboundRoute()
InboundRoute(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
InboundRoute	allowMultipleActions(Boolean allowMultipleActions)	Control if multiple actions are allowed on this route.
InboundRoute	autoBcc(List<EmailAddress> autoBcc)	The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.
boolean	equals(Object o)
InboundRoute	flow(DomainEntityRef flow)	The flow to use for processing the email.
InboundRoute	fromEmail(String fromEmail)	The sender email to use for outgoing replies.
InboundRoute	fromName(String fromName)	The sender name to use for outgoing replies.
Boolean	getAllowMultipleActions()
List<EmailAddress>	getAutoBcc()
DomainEntityRef	getFlow()
String	getFromEmail()
String	getFromName()
InboundRoute.HistoryInclusionEnum	getHistoryInclusion()
String	getId()
DomainEntityRef	getLanguage()
List<String>	getMailboxFolders()
String	getName()
String	getPattern()
Integer	getPriority()
DomainEntityRef	getQueue()
QueueEmailAddress	getReplyEmailAddress()
String	getSelfUri()
Signature	getSignature()
List<DomainEntityRef>	getSkills()
DomainEntityRef	getSpamFlow()
InboundRoute.StatusEnum	getStatus()
int	hashCode()
InboundRoute	historyInclusion(InboundRoute.HistoryInclusionEnum historyInclusion)	The configuration to indicate how the history of a conversation has to be included in a draft
InboundRoute	language(DomainEntityRef language)	The language to use for routing.
InboundRoute	mailboxFolders(List<String> mailboxFolders)	Integration Folder routed to this route
InboundRoute	name(String name)
InboundRoute	pattern(String pattern)	The search pattern that the mailbox name should match.
InboundRoute	priority(Integer priority)	The priority to use for routing.
InboundRoute	queue(DomainEntityRef queue)	The queue to route the emails to.
InboundRoute	replyEmailAddress(QueueEmailAddress replyEmailAddress)	The route to use for email replies.
void	setAllowMultipleActions(Boolean allowMultipleActions)
void	setAutoBcc(List<EmailAddress> autoBcc)
void	setFlow(DomainEntityRef flow)
void	setFromEmail(String fromEmail)
void	setFromName(String fromName)
void	setHistoryInclusion(InboundRoute.HistoryInclusionEnum historyInclusion)
void	setLanguage(DomainEntityRef language)
void	setMailboxFolders(List<String> mailboxFolders)
void	setName(String name)
void	setPattern(String pattern)
void	setPriority(Integer priority)
void	setQueue(DomainEntityRef queue)
void	setReplyEmailAddress(QueueEmailAddress replyEmailAddress)
void	setSignature(Signature signature)
void	setSkills(List<DomainEntityRef> skills)
void	setSpamFlow(DomainEntityRef spamFlow)
InboundRoute	signature(Signature signature)	The configuration for the canned response signature that will be appended to outbound emails sent via this route
InboundRoute	skills(List<DomainEntityRef> skills)	The skills to use for routing.
InboundRoute	spamFlow(DomainEntityRef spamFlow)	The flow to use for processing inbound emails that have been marked as spam.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

InboundRoute

public InboundRoute()

InboundRoute

public InboundRoute(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public InboundRoute name(String name)

getName

public String getName()

setName

public void setName(String name)

pattern

public InboundRoute pattern(String pattern)

The search pattern that the mailbox name should match.

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

queue

public InboundRoute queue(DomainEntityRef queue)

The queue to route the emails to.

getQueue

public DomainEntityRef getQueue()

setQueue

public void setQueue(DomainEntityRef queue)

priority

public InboundRoute priority(Integer priority)

The priority to use for routing.

getPriority

public Integer getPriority()

setPriority

public void setPriority(Integer priority)

skills

public InboundRoute skills(List<DomainEntityRef> skills)

The skills to use for routing.

getSkills

public List<DomainEntityRef> getSkills()

setSkills

public void setSkills(List<DomainEntityRef> skills)

language

public InboundRoute language(DomainEntityRef language)

The language to use for routing.

getLanguage

public DomainEntityRef getLanguage()

setLanguage

public void setLanguage(DomainEntityRef language)

fromName

public InboundRoute fromName(String fromName)

The sender name to use for outgoing replies.

getFromName

public String getFromName()

setFromName

public void setFromName(String fromName)

fromEmail

public InboundRoute fromEmail(String fromEmail)

The sender email to use for outgoing replies.

getFromEmail

public String getFromEmail()

setFromEmail

public void setFromEmail(String fromEmail)

flow

public InboundRoute flow(DomainEntityRef flow)

The flow to use for processing the email.

getFlow

public DomainEntityRef getFlow()

setFlow

public void setFlow(DomainEntityRef flow)

replyEmailAddress

public InboundRoute replyEmailAddress(QueueEmailAddress replyEmailAddress)

The route to use for email replies.

getReplyEmailAddress

public QueueEmailAddress getReplyEmailAddress()

setReplyEmailAddress

public void setReplyEmailAddress(QueueEmailAddress replyEmailAddress)

autoBcc

public InboundRoute autoBcc(List<EmailAddress> autoBcc)

The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.

getAutoBcc

public List<EmailAddress> getAutoBcc()

setAutoBcc

public void setAutoBcc(List<EmailAddress> autoBcc)

spamFlow

public InboundRoute spamFlow(DomainEntityRef spamFlow)

The flow to use for processing inbound emails that have been marked as spam.

getSpamFlow

public DomainEntityRef getSpamFlow()

setSpamFlow

public void setSpamFlow(DomainEntityRef spamFlow)

signature

public InboundRoute signature(Signature signature)

The configuration for the canned response signature that will be appended to outbound emails sent via this route

getSignature

public Signature getSignature()

setSignature

public void setSignature(Signature signature)

historyInclusion

public InboundRoute historyInclusion(InboundRoute.HistoryInclusionEnum historyInclusion)

The configuration to indicate how the history of a conversation has to be included in a draft

getHistoryInclusion

public InboundRoute.HistoryInclusionEnum getHistoryInclusion()

setHistoryInclusion

public void setHistoryInclusion(InboundRoute.HistoryInclusionEnum historyInclusion)

allowMultipleActions

public InboundRoute allowMultipleActions(Boolean allowMultipleActions)

Control if multiple actions are allowed on this route. When true the disconnect has to be done manually. When false a conversation will be disconnected by the system after every action

getAllowMultipleActions

public Boolean getAllowMultipleActions()

setAllowMultipleActions

public void setAllowMultipleActions(Boolean allowMultipleActions)

mailboxFolders

public InboundRoute mailboxFolders(List<String> mailboxFolders)

Integration Folder routed to this route

getMailboxFolders

public List<String> getMailboxFolders()

setMailboxFolders

public void setMailboxFolders(List<String> mailboxFolders)

getStatus

public InboundRoute.StatusEnum getStatus()

getSelfUri

public String getSelfUri()

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