UserEmail

1 minute readReference

createUserEmail

Creates a new alternative user/email address mapping.

Arguments

Argument Name Type Description

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

Deletes a new user/email address mapping.

Arguments

Argument Name Type Description

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

Retrieves the specified user/email mapping.

Arguments

Argument Name Type Description

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

Retrieves all user/email mappings for the specified user.

Arguments

Argument Name Type Description

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

Modifies a user/email mapping.

Arguments

Argument Name Type Description

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 Name Type Description

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 */)