Groovy API reference

UserEmail

1 minute readReference

createUserEmail

Create a new user email.

Arguments

Argument NameTypeDescription

userName

String

User that contains this email. (Required)

email

String

The email address. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createUserEmail(
                userName: 'test-userName',
                email: 'test-email')

deleteUserEmail

Delete an user email.

Arguments

Argument NameTypeDescription

userName

String

User that contains this email. (Required)

email

String

The email address. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteUserEmail(
                userName: 'test-userName',
                email: 'test-email')

getUserEmail

Retrieve an user email.

Arguments

Argument NameTypeDescription

userName

String

User that contains this email. (Required)

email

String

The email address. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getUserEmail(
                userName: 'test-userName',
                email: 'test-email')

getUserEmails

all emails for the pointed user

Arguments

Argument NameTypeDescription

userName

String

User that contains this email. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getUserEmails(
                userName: 'test-userName')

modifyUserEmail

Modify an user email.

Arguments

Argument NameTypeDescription

userName

String

User that contains this email. (Required)

email

String

The email address. (Required)

newEmail

String

The new email address.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyUserEmail(
                userName: 'test-userName',
                email: 'test-email'
                /* optional arguments */)

verifyUserEmail

Email address verification process.

Arguments

Argument NameTypeDescription

email

String

The email address for verification. (Required)

signature

String

Signature for verification email address.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.verifyUserEmail(
                email: 'test-email'
                /* optional arguments */)