public interface EmailMediaI extends MediaI
The EmailMediaI
object represents the 'Media' portion of an email contact.
An Email is composed of an Interaction (which carries various Contact metadata) and Media (which carries email content).
See MediaI
for more details on Media
objects.
Modifier and Type | Method and Description |
---|---|
void |
addNewAttachment(java.io.File file)
Add an outbound attachment to the email media object.
|
void |
completeAttachmentsUpload(com.avaya.ccs.core.OutboundAttachment[] attachments)
After uploading attachments as part of an email Reply or Create, the client must call this to complete the
attachment upload process.
|
void |
create(java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.lang.String subject,
java.lang.String body,
java.lang.String note,
boolean hasAttachments,
java.lang.Integer skillsetId,
boolean isHtml)
Create an ad-hoc or agent-initiated email.
|
java.lang.String |
getArrivalTime()
The time that the contact arrived at the CCS component
|
java.lang.String |
getBcc()
The Bcc party(s) of the email.
|
java.lang.String |
getBody()
The email body
|
java.lang.String |
getCc()
The Cc party(s) of the email.
|
java.lang.String |
getContactId()
The Contact ID for this object.
|
java.lang.String |
getEncoding()
The email character encoding.
|
java.lang.String |
getFrom()
The From party of the email
|
java.util.List<com.avaya.ccs.core.InboundAttachment> |
getInboundAttachments()
The list of
InboundAttachment s attached to the email |
java.lang.String |
getMailboxAddress()
The AACC/ACCS mailbox address that handled this email
|
java.lang.String |
getStatus()
The status of the Email media object.
|
java.lang.String |
getSubject()
The email Subject
|
java.lang.String |
getTo()
The To party(s) of the email.
|
java.lang.String |
getUploadAttachmentUrl()
returns the upload attachment URL.
|
void |
linkOutboundAttachments(com.avaya.ccs.core.OutboundAttachment[] attachments)
Deprecated.
|
void |
reply(java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.lang.String subject,
java.lang.String body,
java.lang.String note,
boolean hasAttachments,
boolean isHtml)
Send a reply to an incoming email.
|
void |
requestSuggestedResponses()
An array of
SuggestedResponse returned by requestSuggestedResponses() }. |
void |
setReplyResponse(com.avaya.ccs.core.EmailReplyResponse emailReplyResponse)
When an email
Reply is sent, if it specifies that the email contains attachments (see reply(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean) ,
the server responds with a RESPONSE object. |
void |
setUploadAttachmentUrl(java.lang.String attachmentUrl)
When an email Reply (or Create) command is sent, CCS replies with a
EmailReplyResponse . |
getContactType, getId, toJsonStringMaskSensitive
java.lang.String getContactId() throws ObjectInvalidException
The Contact ID for this object. The Contact ID is the internal AACC/ACCS contact ID.
This is not the same as the ID. The ID is composed of AgentIdMContactId
(so the Contact ID
can always be determined from the ID).
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getArrivalTime() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getSubject() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getFrom() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getTo() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getCc() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getBcc() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getMailboxAddress() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getEncoding() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getBody() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getStatus() throws ObjectInvalidException
ObjectInvalidException
- if the EmailMediaI
object has been deletedjava.util.List<com.avaya.ccs.core.InboundAttachment> getInboundAttachments() throws ObjectInvalidException
InboundAttachment
s attached to the emailObjectInvalidException
- if the EmailMediaI
object has been deletedvoid addNewAttachment(java.io.File file) throws ObjectInvalidException
Add an outbound attachment to the email media object. Note that this does NOT upload attachments to AACC/ACCS.
Uploading attachments to AACC/ACCS/CCMM is a client implementation and is not done through the CCS API.
When an email Reply (or Create) command is sent, CCS replies with a EmailReplyResponse
.
The EmailReplyResponse contains an upload URL. The client then uses this upload URL to upload the
attachments to the server.
file
- The attachment fileObjectInvalidException
- if the EmailMediaI
object has been deletedvoid setUploadAttachmentUrl(java.lang.String attachmentUrl) throws ObjectInvalidException
When an email Reply (or Create) command is sent, CCS replies with a EmailReplyResponse
.
The EmailReplyResponse contains an upload URL, which the client can use to upload email attachments.
This is the setter for that upload attachment url.
attachmentUrl
- : the location to upload attachments toObjectInvalidException
- if the EmailMediaI
object has been deletedjava.lang.String getUploadAttachmentUrl() throws ObjectInvalidException
returns the upload attachment URL. The attachment URL is the location that the client should upload attachments to, after an email Reply or Create. See "setUploadAttachmentUrl"
ObjectInvalidException
- if the EmailMediaI
object has been deletedvoid reply(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, java.lang.String note, boolean hasAttachments, boolean isHtml)
Send a reply to an incoming email.
'to', 'cc', 'bcc' are single strings, with multiple addresses delimited by ';'
'Agent note' is an optional note from the agent describing this interaction.
'hasAttachments' should be true if this email has outgoing attachments which need to be sent. False otherwise
'isHtml' Emails have two possible encodings: 'HTML' or 'PLAIN' in CCS. If this is a html-encoded email, then isHtml should be true.
to
- multiple addresses delimited by ';'cc
- multiple addresses delimited by ';'bcc
- multiple addresses delimited by ';'subject
- email
- bodyagent
- note -an optional note from the agent on this interactionhasAttachments
- -true if the email has outgoing attachments, false otherwise)isHtml
- - true if the body of the email is 'HTML'; false if the encoding is 'Plain'void create(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, java.lang.String note, boolean hasAttachments, java.lang.Integer skillsetId, boolean isHtml) throws ObjectInvalidException
Create an ad-hoc or agent-initiated email.
The flow for an ad-hoc email is as follows:
UserI.initiateAdhocEmail()
.
create(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.Integer, boolean)
.
Ad-hoc emails are send 'From' a skillset. Skillsets are configured in CCMM with an outbound mailbox.
The skillsetId parameter is the ID of the skillset that the user wants to use as the sender. Typically,
a user will select the sender skillset for an ad-hoc email from a dropdown menu in a client. Available email
skillsets can be requested by calling InteractionI.getSkillsets()
'to', 'cc', 'bcc' are single strings, with multiple addresses delimited by ';'
to
- Multiple addresses delimited by ';'cc
- Multiple addresses delimited by ';'bcc
- Multiple addresses delimited by ';'subject
- body
- note
- Agent notehasAttachments
- Set to True if the email has attachmentsisHtml
- - true if the body of the email is 'HTML'; false if the encoding is 'Plain'skillsetId
- the id of the skillset that is acting as the Sender/Originator of the emailisHtml
- true if the body of the email is 'HTML'; false if the encoding is 'Plain'ObjectInvalidException
- if the EmailMediaI
object has been deletedvoid setReplyResponse(com.avaya.ccs.core.EmailReplyResponse emailReplyResponse) throws ObjectInvalidException
When an email Reply
is sent, if it specifies that the email contains attachments (see reply(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
,
the server responds with a RESPONSE
object. This EmailReplyResponse
contains an upload URL, which a client
can use to start uploading attachments to the CCMM server.
It is the client's responsibility to upload attachments using this link using TCP or whatever mechanism the designer sees fit.
When uploads have completed, the client must use EmailMediaI#completeAttachmentUpload
to complete the
attachment upload process
emailReplyResponse
- - This sets the predefined URL where the attachment will be sentObjectInvalidException
- if the EmailMediaI
object has been deleted@Deprecated void linkOutboundAttachments(com.avaya.ccs.core.OutboundAttachment[] attachments) throws ObjectInvalidException
setReplyResponse(com.avaya.ccs.core.EmailReplyResponse)
and
completeAttachmentsUpload(com.avaya.ccs.core.OutboundAttachment[])
attachments
- - This takes in the attachment model details for outbound emailsObjectInvalidException
- if the EmailMediaI
object has been deletedvoid completeAttachmentsUpload(com.avaya.ccs.core.OutboundAttachment[] attachments) throws ObjectInvalidException
ObjectInvalidException
void requestSuggestedResponses() throws ObjectInvalidException
SuggestedResponse
returned by requestSuggestedResponses()
}.
Agent use these objects to auto-populate an email subject, body, attachments.
SuggestedResponse
must be created in the Contact Center to be visible to agents.ObjectInvalidException
- if the EmailMediaI
object has been deleted