SoftLayer Ticket::addAttachedAdditionalEmails

From SoftLayer Development Network Wiki

addAttachedAdditionalEmails is a member of the SoftLayer_Ticket service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 5 Parameters 5.1 emails 6 Error Handling 7 Associated Methods

Overview

Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket.

User Access

Users wishing to execute addAttachedAdditionalEmails service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.

Return Type

addAttachedAdditionalEmails returns the boolean data type.

Headers

Required Headers

addAttachedAdditionalEmails requires the following headers:

• authenticate
• SoftLayer_TicketInitParameters

Parameters

addAttachedAdditionalEmails takes the following parameters:

emails

A list of email addresses to notify when a ticket is updated

• Type: array of strings

Error Handling

addAttachedAdditionalEmails throws the following exceptions:

• SoftLayer_Exception_Public

Throw the exception "This ticket does not have an assigned user. Could not add additional emails." if the given ticket is not assigned to a user.

• SoftLayer_Exception_Public

Throw the exception "Unable to attach an invalid email address {email}." if one of the email addresses in the emails array is not a valid email address.

Associated Methods

• SoftLayer_Ticket::removeAttachedAdditionalEmails