CarbonCopyInfo

Returns the full configuration details for a specific carbon copy rule, including its direction, linked mailboxes, and current status.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

CarbonCopyIDInfo CarbonCopyInfo(string SessionID, int CarbonCopyID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token from Login()
CarbonCopyID	int	Yes	Unique identifier of the carbon copy rule to retrieve

Response Object — CarbonCopyIDInfo

Field	Type	Description
CarbonCopyID	int	Unique identifier for this carbon copy rule
FromMailboxID	int	Source mailbox whose traffic is being copied
ToMailboxID	int	Destination mailbox receiving the duplicate traffic
Direction	Direction	Traffic direction being copied (InBox or OutBox)
Status	Status	Current rule status (Active, Suspended, Terminated)
CreateDate	datetime	Timestamp when the rule was created
ModDate	datetime	Timestamp of the most recent modification

<!-- Example response XML -->
<CarbonCopyIDInfoResult>
  <CarbonCopyID>301</CarbonCopyID>
  <FromMailboxID>100</FromMailboxID>
  <ToMailboxID>200</ToMailboxID>
  <Direction>InBox</Direction>
  <Status>Active</Status>
  <CreateDate>2026-05-01T08:00:00</CreateDate>
  <ModDate>2026-05-07T09:00:00</ModDate>
</CarbonCopyIDInfoResult>

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
// Retrieve current configuration for a carbon copy rule
var ccInfo = await client.CarbonCopyInfoAsync(sessionID, carbonCopyID: 301);

Console.WriteLine($"CarbonCopyID: {ccInfo.CarbonCopyID}");
Console.WriteLine($"From Mailbox: {ccInfo.FromMailboxID}");
Console.WriteLine($"To Mailbox:   {ccInfo.ToMailboxID}");
Console.WriteLine($"Direction:    {ccInfo.Direction}");
Console.WriteLine($"Status:       {ccInfo.Status}");

Java

// JAX-WS generated client
// wsimport -s src https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL

ECGridOS service = new ECGridOS();
ECGridOSPortType port = service.getECGridOSPort();

var result = port.CarbonCopyInfo(sessionID /*, additional params */);
System.out.println(result);

Node.js

// npm install soap
import soap from 'soap';

const WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL';
const client = await soap.createClientAsync(WSDL);

const [result] = await client.CarbonCopyInfoAsync({
  SessionID: sessionId,
  // additional params
});
console.log(result);

Python

# pip install zeep
from zeep import Client

WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL'
client = Client(WSDL)

result = client.service.CarbonCopyInfo(
    SessionID=session_id,
    # additional params
)
print(result)

REST Equivalent

See Get Carbon Copy — GET /v2/carboncopies/{id}.