Jump to: navigation, search

E-Mails

DevGuide2.png Purpose: To provide information about customizable commands for the e-mail interactions.

Learn about E-Mail Commands

The e-mail commands presented in this page are restricted to e-mail interactions. However, e-mail interactions are extended open media interactions and can be used as such in open media commands. In addition to the e-mail commands, you can use:

Important
Read Use Customizable Commands to see code snippets which demonstrate the usage of the commands.

Managing E-Mail Interactions

The commands presented in this section are specific to e-mail interactions and cover the following features (this list is not exhaustive):

  • Accept or decline a given e-mail;
  • Load, send, reply, and save a given e-mail;
  • Pull and place in queue;
  • Close or stop the interactions.
Chains of Commands to Manage E-Mail Interactions
Default Commands Parameters
Chain InteractionEmailActionFromWorkbinDeleteById
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
  • CanPullInteraction
  • CommandParameter: Dictionary<ref name="Dictionary" />
  • DisplayWarningPullNotPossible
  • canPullInteractionresult: String<ref name="String" />
  • Confirm
  • ActionToConfirm: String<ref name="String" />
  • ConfirmParentWindow: Window<ref name="Window" />
  • Delete
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
Chain InteractionEmailActionFromWorkbinMarkDoneById
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
  • CanPullInteraction
  • CommandParameter: Dictionary<ref name="Dictionary" />
  • DisplayWarningPullNotPossible
  • canPullInteractionresult: String<ref name="String" />
  • NoChildrenOpened
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
  • IsDispositionMissing
    Available since: 8.5
  • EsdkOpenMediaInteraction: IIOpenMediaInteraction<ref name="IIOpenMediaInteraction" />
  • Confirm
  • ActionToConfirm: String<ref name="String" />
  • ConfirmParentWindow: Window<ref name="Window" />
  • MarkDone
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
Chain InteractionEmailActionFromWorkbinPullById
  • GetInteractionState
  • CommandParameter: String<ref name="String" />
  • CanPullInteraction
  • CommandParameter: Dictionary<ref name="Dictionary" />
  • DisplayWarningPullNotPossible
  • canPullInteractionresult: String<ref name="String" />
  • NoChildrenOpened
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
  • NoDraftWithSameParentOpened
  • ParentId: String<ref name="String" />
  • PullFromWorkbin
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
  • MoveToWorkbinOpenedParent
  • ParentId: String<ref name="String" />
Chain InteractionEmailActionOnOpenedEmailById
  • IsNotOpened
  • CommandParameter: String<ref name="String" >System.String</ref>
  • OpenedInteractionCommand: String<ref name="String" />
Chain InteractionEmailClose
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToClose
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Email.IInteractionEmail</ref>
  • Close
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailDelete
  • Confirm
  • ActionToConfirm: String<ref name="String" />
  • ConfirmParentWindow: Window<ref name="Window" > System.Window.Window</ref>
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • PullParentInboundEmail
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • DispositionCode: IDispositionCode<ref name="IDispositionCode" > Genesyslab.Desktop.Modules.Core.Model.Interactions.IDispositionCode</ref>
  • Delete
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • CleanConnectionInformation
  • CommandParameter: String<ref name="String" />
Chain InteractionEmailDeleteById
  • Confirm
  • ActionToConfirm: String<ref name="String" />
  • ConfirmParentWindow: Window<ref name="Window" />
  • Delete
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
Chain InteractionEmailForward
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToForward
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Email.IInteractionInboundEmail</ref>
  • AddForwardData
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" />
  • Destination: String<ref name="String" />
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • SaveAttachedData
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • PlaceInQueue
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reason: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" >Genesyslab.Desktop.Modules.TeamCommunicator.ObjectTC</ref>
Chain InteractionEmailIsPossibleToClose
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToClose
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailLoad
  • Load
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailMarkDoneById
  • NoChildrenOpened
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
  • Confirm
  • ActionToConfirm: String<ref name="String" />
  • ConfirmParentWindow: Window<ref name="Window" />
  • MarkDone
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
Chain InteractionEmailMoveToWorkbin
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsWorkbinDestinationDefined
  • WorkbinId: String<ref name="String" />
  • WorkbinOptionName: String<ref name="String" />
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • IgnoreInteractionFromWorkbinId: System<ref name="String" />
    Available since: 8.5.0
  • SetAttachedDadaInformation
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection">Genesyslab.Enterprise.Commons.Collections.KeyValueCollection</ref>
    Available since: 8.5.0
  • MoveToWorkbin
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
  • IgnoreInteractionFromWorkbinId: String<ref name="String" />
    Available since: 8.5.0
  • UpdateContactInformation
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
Chain InteractionEmailPlaceInQueue
  • UpdateInteractionUCS
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.IInteractionOpenMedia</ref>
  • SaveAttachedData
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • PlaceInQueue
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection"/>
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • UpdateContactInformation
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionEmailPrint
  • Print
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailPullById
  • PullInteraction
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • IW_WebcallbackInteractionId: String<ref name="String" />
Chain InteractionEmailPullFromWorkbinById
  • NoChildrenOpened
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
  • NoDraftWithSameParentOpened
  • ParentId: String<ref name="String" />
  • PullFromWorkbin
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
  • MoveToWorkbinOpenedParent
  • ParentId: String<ref name="String" />
Chain InteractionEmailReply
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • IsContactModified
  • CaseId: String<ref name="String" > System.String</ref>
  • IsPossibleToCreate
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Email.IInteractionInboundEmail</ref>
  • IsWorkbinDestinationDefined
  • WorkbinId: String<ref name="String" />
  • WorkbinOptionName: String<ref name="String" />
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • IgnoreInteractionFromWorkbinId: String<ref name="String" />
    Available since: 8.5.0
  • AddSignatureParameters
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" />
  • AddResponseSignatureParameters
  • SignatureOptionValue: String<ref name="String" />
  • ESDKInboundEmail: IInteraction<ref name="IInteraction" > Genesyslab.Enterprise.Model.Interaction.IInteraction</ref>
  • Reply
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" />
  • ReplyAll: String<ref name="String" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • SignatureParameters: Dictionary<ref name="Dictionary" >System.Collections.Generic.Dictionary<string, object></ref>
  • InboundEmailSearchAndMoveToWorkbin
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailReplyById
  • IsPossibleToCreate
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" />
  • NoChildrenOpened
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
Available since: 8.1.3
  • IsNotOpened
  • CommandParameter: String<ref name="String" />
  • OpenedInteractionCommand: String<ref name="String" />
  • AddSignatureParameters
  • CommandParameter: String<ref name="String" />
  • AddResponseSignatureParameters
  • SignatureOptionValue: String<ref name="String" />
  • ESDKInboundEmail: IInteraction<ref name="IInteraction" />
  • Reply
  • CommandParameter: String<ref name="String" />
  • WorkbinId: String<ref name="String" />
  • ReplyAll: String<ref name="String" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • SignatureParameters: Dictionary<ref name="Dictionary" />
  • ESDKInboundEmail: IEmailInteraction<ref name="IEmailInteraction" > Genesyslab.Enterprise.Model.IEmailInteraction</ref>
  • InboundEmailSearchAndMoveToWorkbin<ref name="String" />
    Available since: 8.5
  • CommandParameter: System.String
Chain InteractionEmailResend
  • IsPossibleToCreate
  • CommandParameter: IInteractionInboundEmail<ref name="IInteractionInboundEmail" />
  • NoChildrenOpened
    Deprecated since: 8.5
  • CommandParameter: String<ref name="String" />
  • WarningMessageTarget: String<ref name="String" />
  • DoNotCheckForParentId: String<ref name="String" />
  • AddSignatureParameters
  • CommandParameter: String<ref name="String" />
  • AddResponseSignatureParameters
  • SignatureOptionValue: String<ref name="String" />
  • ESDKInboundEmail: IInteraction<ref name="IInteraction" />
  • Create
  • CommandParameter: String<ref name="String" />
  • ParentInteractionId: String<ref name="String" />
  • InitialEmail: IMediaOpenMedia<ref name="IMediaOpenMedia" > Genesyslab.Desktop.Modules.OpenMedia.Model.Agents.IMediaOpenMedia</ref>
  • InitialEmailId: String<ref name="String" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • SignatureParameters: Dictionary<string, object><ref name="DictionaryStringObject">Dictionary<string, object> </ref>
Chain InteractionEmailSave
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailSaveNewOutbound
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionEmailSend
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction">Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteraction</ref>
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" >Genesyslab.Desktop.Modules.Windows.Interactions.INotepadViewModel</ref>
  • IsPossibleToSend
  • CommandParameter: IInteractionOutboundEmail<ref name="IInteractionOutboundEmail" > Genesyslab.Desktop.Modules.OpenMedia.Model.Interactions.Email.IInteractionOutboundEmail</ref>
  • IsPossibleToClose
  • CommandParameter: CommandParameter<ref name=" CommandParameter" > CommandParameter</ref>
  • AddQAReviewData
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
    Available since: 8.5
  • CheckEmailFieldsBeforeSend
    Available since: 8.5
  • CommandParameter: <ref name="IInteractionOutboundEmail" />
  • Send
  • CommandParameter: IInteractionOutboundEmail<ref name="IInteractionOutboundEmail" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionEmailSendInterimReply
  • IsPossibleToSend
  • CommandParameter: IInteractionOutboundEmail<ref name="IInteractionOutboundEmail" />
  • IsPossibleToClose
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • AddQAReviewData
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • SetAttachedDadaInformation
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • UserData: KeyValueCollection<ref name="KeyValueCollection" />
    Available since: 8.5
  • CheckEmailFieldsBeforeSend
    Available since: 8.5
  • CommandParameter: <ref name="IInteractionOutboundEmail" />
  • PullParentInboundEmail
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • DispositionCode: IDispositionCode<ref name="IDispositionCode" />
  • Send
  • CommandParameter: IInteractionOutboundEmail<ref name="IInteractionOutboundEmail" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionEmailTransferAgent
  • Save
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
  • SetAutoClose
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • RequestSaveNotepad
  • CommandParameter: IInteraction<ref name="IInteraction" />
  • NotepadViewModel: INotepadViewModel<ref name="INotepadViewModel" />
  • TransferAgent
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Destination: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AddRecentCall
  • RecentIndex: ObjectTC<ref name="ObjectTC" />
Chain InteractionEmailWorkflow
  • PromptDone
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • ConfirmParentWindow: Window<ref name="Window" >System.Window.Window</ref>
  • Workflow
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • Workflow: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionEmailWorkflowFromInteractionESDK
  • ESDKWorkflow
  • CommandParameter: IIOpenMediaInteraction<ref name="IIOpenMediaInteraction" > Genesyslab.Enterprise.Model.Interaction.IIOpenMediaInteraction</ref>
  • Workflow: String<ref name="String" />
  • Reasons: KeyValueCollection<ref name="KeyValueCollection" />
  • Extensions: KeyValueCollection<ref name="KeyValueCollection" />
  • AttachedDataInformation: IDispositionCode<ref name="IDispositionCode" />
  • DispositionCode: KeyValueCollection<ref name="KeyValueCollection" />
Chain InteractionInboundEmailPossibleToMoveToWorkbin
  • IsWorkbinDestinationDefined
  • WorkbinId: String<ref name="String" />
  • WorkbinOptionName: String<ref name="String" />
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • IgnoreInteractionFromWorkbinId: String<ref name="String" />
    Available since: 8.5
Chain InteractionInboundEmailSearchAndMoveToWorkbin
  • IsContactModified
  • CaseId: String<ref name="String" />
  • InboundEmailSearchAndMoveToWorkbin
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />
Chain InteractionOutboundEmailPossibleToMoveToWorkbin
  • IsWorkbinDestinationDefined
  • WorkbinId: String<ref name="String" />
  • WorkbinOptionName: String<ref name="String" />
  • CommandParameter: IInteractionOpenMedia<ref name="IInteractionOpenMedia" />
  • IgnoreInteractionFromWorkbinId: <ref name="String" />
    Added in 8.5.0
Chain InteractionOutboundEmailSearchAndMoveToWorkbin
  • IsContactModified
  • CaseId: String<ref name="String" />
  • OutboundEmailSearchAndMoveToWorkbin
  • CommandParameter: IInteractionEmail<ref name="IInteractionEmail" />


Commands common to all interactions
Chain InteractionSetAttachedDataWithDelay

SetAttachedData

  • CommandParameter: IInteraction
  • AttachedData: KeyValueCollection
Chain BundleClose

GetAttachedDataInformationUCS

CommandParameter: IInteractionsBundle - Genesyslab.Desktop.Modules.Core.Model.Interactions.IInteractionsBundle

UpdateNotePadForVoice

  • CommandParameter: IInteractionsBundle

ResetInteractionChatConsultation

CommandParameter: IInteractionsBundle

IsContactModified

  • CaseId: String

IsPossibleToClose

CommandParameter: IInteractionsBundle

CompleteDispositionCodeOnBundle

CommandParameter: IInteractionsBundle

Close

CommandParameter: IInteractionsBundle

StopInteractionVoiceUCS

  • CommandParameter: IInteractionsBundle

GetOutboundPreviewRecord

CommandParameter: ICampaign - Genesyslab.Enterprise.Model.Interaction.ICampaign

<references />

This page was last modified on April 16, 2014, at 12:47.

Feedback

Comment on this article:

blog comments powered by Disqus