Interface IEmailMedia

All Superinterfaces:

IDisposable, IEntity, IInteractionMedia

public interface IEmailMedia
extends IInteractionMedia

Represents an email media.

Method Summary

Modifier and Type	Method	Description
void	addEmailErrorListener(EmailErrorListener listener)	Registers the EmailErrorListener.
void	addEmailListener(EmailListener listener)	Registers the EmailListener.
void	addEmailProgressListener(EmailProgressListener listener)	Registers the EmailProgressListener.
void	blindTransfer(String agentName, String campaignName, String remoteEmailAddress, Attribute[] attributes, int priority, String skillProfileName, SkillInProfile[] skills, int directoryId, int contactProfileId, boolean synchronous)	Makes a blind transfer.
void	clear(boolean synchronous)	Clears the data transaction.
void	endReservation(boolean synchronous)	Ends the reservation.
EmailMediaCanDo	getAllowedOperations()	Allowed email media operations.
boolean	getAutoReplySent()	True if the auto reply was sent.
EmailInteractionData	getData()	Data of the email interaction.
GregorianCalendar	getDateOfArrival()	Date of arrival of the email.
boolean	getDelivered()	Returns true if the email was delivered.
int	getEmailId()	Identifier of the email.
EmailMessage	getEmailMessage()	Returns the email message.
byte[]	getEmailMime()	Returns the email in MIME format.
String	getFrom()	Email senders.
boolean	getIsSuspended()	True if the interaction is suspended.
String	getReplyTo()	Reply to address.
EmailInteractionState	getState()	State of the email interaction.
String	getSubject()	Subject of the email.
String	getTo()	Email receivers.
boolean	getWasRecovered()	True if the email was recovered.
void	removeEmailErrorListener(EmailErrorListener listener)	Unregisters the EmailErrorListener.
void	removeEmailListener(EmailListener listener)	Unregisters the EmailListener.
void	removeEmailProgressListener(EmailProgressListener listener)	Unregisters the EmailProgressListener.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Methods inherited from interface IInteractionMedia

answer, getInteractionId, getMediaId, getMediaType, getSession, getStartTime

Method Details

addEmailErrorListener

void addEmailErrorListener(EmailErrorListener listener)

Registers the EmailErrorListener.

Parameters:

listener - Event listener to add.

removeEmailErrorListener

void removeEmailErrorListener(EmailErrorListener listener)

Unregisters the EmailErrorListener.

Parameters:

listener - Event listener to remove.

addEmailListener

void addEmailListener(EmailListener listener)

Registers the EmailListener.

Parameters:

listener - Event listener to add.

removeEmailListener

void removeEmailListener(EmailListener listener)

Unregisters the EmailListener.

Parameters:

listener - Event listener to remove.

addEmailProgressListener

void addEmailProgressListener(EmailProgressListener listener)

Registers the EmailProgressListener.

Parameters:

listener - Event listener to add.

removeEmailProgressListener

void removeEmailProgressListener(EmailProgressListener listener)

Unregisters the EmailProgressListener.

Parameters:

listener - Event listener to remove.

blindTransfer

void blindTransfer(String agentName,
 String campaignName,
 String remoteEmailAddress,
 Attribute[] attributes,
 int priority,
 String skillProfileName,
 SkillInProfile[] skills,
 int directoryId,
 int contactProfileId,
 boolean synchronous)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Makes a blind transfer.

Parameters:

agentName - Name of the agent.

campaignName - Name of the campaign.

remoteEmailAddress - Email address of the remote instance.

attributes - Attributes to send with the transferred email.

priority - Relative priority.

skillProfileName - Name of the skill profile.

skills - Optional agent skills required to handle the email. This parameter will be ignored if the skillProfileName is specified.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

clear

void clear(boolean synchronous)
    throws Exception,
altitude.integrationServer.exceptions.ISException

Clears the data transaction.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

endReservation

void endReservation(boolean synchronous)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Ends the reservation.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

EmailMediaCanDo getAllowedOperations()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Allowed email media operations.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAutoReplySent

boolean getAutoReplySent()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

True if the auto reply was sent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getData

EmailInteractionData getData()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Data of the email interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDateOfArrival

GregorianCalendar getDateOfArrival()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Date of arrival of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDelivered

boolean getDelivered()
              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns true if the email was delivered.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailId

int getEmailId()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailMessage

EmailMessage getEmailMessage()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the email message.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailMime

byte[] getEmailMime()
             throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the email in MIME format.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getFrom

String getFrom()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Email senders.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsSuspended

boolean getIsSuspended()
                throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is suspended.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getReplyTo

String getReplyTo()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Reply to address.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

EmailInteractionState getState()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

State of the email interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSubject

String getSubject()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Subject of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTo

String getTo()
      throws Exception,
altitude.integrationServer.exceptions.ISException

Email receivers.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWasRecovered

boolean getWasRecovered()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

True if the email was recovered.

Throws:

Exception

altitude.integrationServer.exceptions.ISException