Package com.vonage.client.verify2

Class EmailWorkflow

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.verify2.Workflow

com.vonage.client.verify2.EmailWorkflow

All Implemented Interfaces:

Jsonable

public final class EmailWorkflow
extends Workflow

Defines properties for sending a verification code to a user via e-mail.

Our email solution supports domain registration, if you plan to scale email verification to high volumes with Verify v2, please contact Sales in order to get your account configured properly.

Nested Class Summary

Nested classes/interfaces inherited from class com.vonage.client.verify2.Workflow

Workflow.Builder<W extends Workflow,B extends Workflow.Builder<? extends W,? extends B>>

Field Summary

Fields inherited from class com.vonage.client.verify2.Workflow

channel, from, to

Constructor Summary

Constructors

Constructor	Description
EmailWorkflow(String to)	Constructs a new e-mail verification workflow.
EmailWorkflow(String to, String from)	Constructs a new e-mail verification workflow with a custom sender address.

Method Summary

Modifier and Type	Method	Description
String	getFrom()	The e-mail address to send the verification request from, if configured.
String	getTo()	The email address to send the verification request to.

Methods inherited from class com.vonage.client.verify2.Workflow

getChannel, validateFrom, validateTo

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

EmailWorkflow

public EmailWorkflow(String to)

Constructs a new e-mail verification workflow.

Parameters:

to - The email address to send the verification request to.

EmailWorkflow

public EmailWorkflow(String to,
 String from)

Constructs a new e-mail verification workflow with a custom sender address.

Parameters:

to - The email address to send the verification request to.

from - The e-mail address to send the verification request from. Note that you will need to get in touch with the Vonage sales team to enable use of the field.

Method Details

getFrom

public String getFrom()

The e-mail address to send the verification request from, if configured.

Returns:

The sender e-mail address, or null if unset.

getTo

public String getTo()

The email address to send the verification request to.

Overrides:

getTo in class Workflow

Returns:

The recipient's e-mail address.