Skip to content

List Queue Email Addresses

connect_list_queue_email_addresses R Documentation

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts

Description

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.

Important things to know

  • The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email.

  • Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue.

  • The list includes both explicitly associated email addresses and any default outbound email address configured for the queue.

  • Results are paginated to handle queues with many associated email addresses (up to 50 per queue).

Usage

connect_list_queue_email_addresses(InstanceId, QueueId, NextToken,
  MaxResults)

Arguments

InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
QueueId

[required] The identifier for the queue.
NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
MaxResults

The maximum number of results to return per page.

Value

A list with the following syntax:

list(
  NextToken = "string",
  EmailAddressMetadataList = list(
    list(
      Id = "string",
      Arn = "string",
      IsDefaultOutboundEmail = TRUE|FALSE
    )
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedRegion = "string"
)

Request syntax

svc$list_queue_email_addresses(
  InstanceId = "string",
  QueueId = "string",
  NextToken = "string",
  MaxResults = 123
)