SendClassification

SendClassification groups a sender profile and delivery profile for use when creating sends and send definitions. Updates must include both SenderProfileKey and DeliveryProfileKey in the properties object.

Requires Platform.Load("core", "1.1.5") before use.

Methods

Method	Returns	Description
`SendClassification.Init(key)`	SendClassificationInstance	Bind by external key
`SendClassification.Add(properties)`	object	Create a send classification
`SendClassification.Retrieve(filter)`	object[]	Query classifications
`<SendClassificationInstance>.Update(properties)`	string	Update (requires sender + delivery keys)
`<SendClassificationInstance>.Remove()`	string	Delete the classification

SendClassification.Init

Verified

Initializes a SendClassification instance for the given external key.

Syntax

SendClassification.Init(key)

Parameters

Name	Type	Required	Description
`key`	string	Yes	External key

Return value

SendClassificationInstance

Examples

Platform.Load("core", "1");
var sc = SendClassification.Init("mySendClassification");

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: SendClassification.Init(key)
 *
 * CloudPage GET context. Proves:
 *   1. SendClassification requires the Core load and exposes statics Init,
 *      Add, and Retrieve; Update/Remove are instance-only.
 *   2. Init(key) returns a SendClassificationInstance whose members are
 *      Update and Remove (both typeof "function").
 *   3. Init binds a key; it does not fetch readable fields (CustomerKey /
 *      Name / Description undefined on the stub).
 *   4. A nonsense key still returns an indistinguishable stub.
 *   5. The exact page example shape runs (Init returns an object).
 *
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function typeOf(fn) {
    try { return "" + fn(); } catch (ex) { return "THREW"; }
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

assert("typeof SendClassification is object", typeOf(function () { return typeof SendClassification; }), "object");
assert("typeof SendClassification.Init is function", typeOf(function () { return typeof SendClassification.Init; }), "function");
assert("typeof SendClassification.Add is function", typeOf(function () { return typeof SendClassification.Add; }), "function");
assert("typeof SendClassification.Retrieve is function", typeOf(function () { return typeof SendClassification.Retrieve; }), "function");
assert("SendClassification.Update is not a static", typeOf(function () { return typeof SendClassification.Update; }), "undefined");
assert("SendClassification.Remove is not a static", typeOf(function () { return typeof SendClassification.Remove; }), "undefined");

var sc = SendClassification.Init("ssjs-guide-ts-sc-init");
assert("typeof SendClassification.Init(key) is object", typeof sc, "object");
assert("typeof instance.Update is function", typeof sc.Update, "function");
assert("typeof instance.Remove is function", typeof sc.Remove, "function");
assert("instance has no Add", typeof sc.Add, "undefined");
assert("instance has no Retrieve", typeof sc.Retrieve, "undefined");
assert("instance exposes exactly Remove + Update", "" + Stringify(sc), '{"Remove":"function","Update":"function"}');
assert("instance.CustomerKey is undefined (Init does not fetch)", typeof sc.CustomerKey, "undefined");
assert("instance.Name is undefined (Init does not fetch)", typeof sc.Name, "undefined");
assert("instance.Description is undefined (Init does not fetch)", typeof sc.Description, "undefined");

var bogus = SendClassification.Init("ssjs-guide-no-such-sc-zzz");
assert("Init(nonsense key) still returns an object", typeof bogus, "object");
assert("Init(nonsense key) stub matches Init(fixture key)", ("" + Stringify(bogus)) === ("" + Stringify(sc)) ? "true" : "false", "true");
assert("page example: Init('mySendClassification') returns an instance", invocationResult(function () { return SendClassification.Init("mySendClassification"); }), "returned");
</script>

SendClassification.Add

Creates a new send classification with the specified properties.

Syntax

SendClassification.Add(properties)

Parameters

Name	Type	Required	Description
`properties`	object	Yes	`CustomerKey`, `Name`, `Description`, `SenderProfileKey`, `DeliveryProfileKey`

The SenderProfileKey and DeliveryProfileKey must reference existing profiles by external key; an unresolvable profile key makes the Add fail.

Return value

object — a CLR object on success. Its properties are not readable from SSJS; treat a non-throwing return as success and read the created record back with SendClassification.Retrieve.

Differs from official Salesforce docs

Runtime-verified on a live CloudPage against real, owned ssjs-senderprofile + ssjs-deliveryprofile keys: Add() creates the record and returns a CLR object (typeof is clr; it stringifies to ExactTarget.Integration.WSDL.SenderProfile), not the string "OK" the docs imply. Enumerating its keys with for..in yields none and reading a property throws “Use of Common Language Runtime (CLR) is not allowed”. Treat any non-throwing return as success; a SendClassification.Retrieve immediately after Add returned the new record. This mirrors DeliveryProfile.Add and SenderProfile.Add.

Examples

Platform.Load("core", "1.1.5");
var newSC = {
    CustomerKey: "mySCKey",
    Name: "SSJS Test SC",
    Description: "Test SSJS description",
    SenderProfileKey: "mySPKey",
    DeliveryProfileKey: "myDPKey"
};
SendClassification.Add(newSC);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: SendClassification.Add(properties)
 *
 * CloudPage GET context. Proves:
 *   1. Add is a function taking one properties object.
 *   2. Add with CustomerKey / Name / Description / SenderProfileKey /
 *      DeliveryProfileKey (resolvable owned keys) does not throw.
 *   3. DEVIATION "DEV": return is a CLR object, NOT the string "OK"
 *      (docs imply "OK"). typeof is "clr"; it stringifies to
 *      ExactTarget.Integration.WSDL.SenderProfile.
 *   4. DEVIATION "DEV": for..in yields no keys; reading a property throws
 *      "Use of Common Language Runtime (CLR) is not allowed".
 *   5. Workaround: non-throwing return + Retrieve immediately after Add
 *      returns the new record.
 *   6. Negatives: Add() / Add({}) / unresolvable profile key / duplicate
 *      CustomerKey throw.
 *
 * FIXTURE: ssjs-guide-ts-sc-add + owned ssjs-senderprofile /
 * ssjs-deliveryprofile. EXPECTED OUTPUT: every line PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}
function threwFragment(fn, fragment) {
    try { fn(); return "did NOT throw"; } catch (ex) { return ("" + ex.message).indexOf(fragment) >= 0 ? "matched" : ("" + ex.message); }
}

var SP_KEY = "ssjs-senderprofile";
var DP_KEY = "ssjs-deliveryprofile";
var SC_KEY = "ssjs-guide-ts-sc-add";

SendClassification.Init(SC_KEY).Remove();
SendClassification.Init("ssjs-guide-ts-sc-add-bad").Remove();

assert("typeof SendClassification.Add is function", typeof SendClassification.Add, "function");

var newSC = {
    CustomerKey: SC_KEY,
    Name: "SSJS Guide TS SC Add",
    Description: "Test SSJS description",
    SenderProfileKey: SP_KEY,
    DeliveryProfileKey: DP_KEY
};
var result = null;
assert("Add(properties) does not throw", invocationResult(function () { result = SendClassification.Add(newSC); }), "returned");

assert("DEV typeof Add() result is clr (docs: string \"OK\")", typeof result, "clr");
assert("DEV Add() result is not the string OK (docs: \"OK\")", ("" + result) === "OK" ? "true" : "false", "false");
assert("DEV Add() result stringifies to ExactTarget.Integration.WSDL.SenderProfile (docs: \"OK\")", "" + result, "ExactTarget.Integration.WSDL.SenderProfile");
assert("DEV Stringify(Add() result) is the .NET type name (docs: \"OK\")", "" + Stringify(result), '"ExactTarget.Integration.WSDL.SenderProfile"');

var enumCount = 0;
for (var k in result) { enumCount++; }
assert("DEV for..in on Add() result yields no keys (docs imply readable)", "" + enumCount, "0");
assert("DEV reading result.CustomerKey throws (docs imply readable)", invocationResult(function () { return result.CustomerKey; }), "threw");
assert("DEV reading result.CustomerKey reports the CLR restriction", threwFragment(function () { return result.CustomerKey; }, "Use of Common Language Runtime (CLR) is not allowed"), "matched");
assert("DEV reading result.Name throws (docs imply readable)", invocationResult(function () { return result.Name; }), "threw");

var created = SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY });
assert("workaround: Retrieve after Add returns the new record", (created && created.length === 1) ? "true" : "false", "true");
assert("workaround: retrieved CustomerKey matches", "" + created[0].CustomerKey, SC_KEY);

assert("Add() with no argument throws", invocationResult(function () { return SendClassification.Add(); }), "threw");
assert("Add({}) with an empty object throws", invocationResult(function () { return SendClassification.Add({}); }), "threw");
assert("Add with unresolvable profile keys throws", invocationResult(function () {
    return SendClassification.Add({
        CustomerKey: "ssjs-guide-ts-sc-add-bad",
        Name: "bad",
        Description: "bad",
        SenderProfileKey: "ssjs-guide-no-such-sp-zzz",
        DeliveryProfileKey: "ssjs-guide-no-such-dp-zzz"
    });
}), "threw");
assert("Add() re-using an existing CustomerKey throws", invocationResult(function () { return SendClassification.Add(newSC); }), "threw");

assert("fixture SC removed", "" + SendClassification.Init(SC_KEY).Remove(), "OK");
assert("SC orphan count 0", "" + SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY }).length, "0");
</script>

SendClassification.Retrieve

Verified

Queries send classifications matching the given filter criteria.

Syntax

SendClassification.Retrieve(filter)

Parameters

Name	Type	Required	Description
`filter`	object	Yes	WSProxy-style filter

Return value

object[]

Examples

Platform.Load("core", "1.1.5");
var results = SendClassification.Retrieve({
    Property: "CustomerKey",
    SimpleOperator: "equals",
    Value: "mySendClassification"
});

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: SendClassification.Retrieve(filter)
 *
 * CloudPage GET context. Proves:
 *   1. Retrieve is a function taking one PascalCase WSProxy-style filter.
 *   2. A matched filter returns an array with length 1 and readable
 *      CustomerKey / Name.
 *   3. An empty / nonsense filter returns an empty array (length 0).
 *   4. The page example shape (Property CustomerKey equals) works.
 *
 * FIXTURE: ssjs-guide-ts-sc-ret + owned profile keys.
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}

var SP_KEY = "ssjs-senderprofile";
var DP_KEY = "ssjs-deliveryprofile";
var SC_KEY = "ssjs-guide-ts-sc-ret";

SendClassification.Init(SC_KEY).Remove();

SendClassification.Add({
    CustomerKey: SC_KEY,
    Name: "SSJS Guide TS SC Ret",
    Description: "retrieve fixture",
    SenderProfileKey: SP_KEY,
    DeliveryProfileKey: DP_KEY
});

assert("typeof SendClassification.Retrieve is function", typeof SendClassification.Retrieve, "function");

var results = SendClassification.Retrieve({
    Property: "CustomerKey",
    SimpleOperator: "equals",
    Value: SC_KEY
});
assert("matched Retrieve reports as object", typeof results, "object");
assert("matched Retrieve has length", typeof results.length, "number");
assert("matched Retrieve length is 1", "" + results.length, "1");
assert("matched row CustomerKey", "" + results[0].CustomerKey, SC_KEY);
assert("matched row Name", "" + results[0].Name, "SSJS Guide TS SC Ret");

var empty = SendClassification.Retrieve({
    Property: "CustomerKey",
    SimpleOperator: "equals",
    Value: "ssjs-guide-no-such-sc-zzz"
});
assert("empty Retrieve length is 0", "" + empty.length, "0");

assert("fixture SC removed", "" + SendClassification.Init(SC_KEY).Remove(), "OK");
assert("SC orphan count 0", "" + SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY }).length, "0");
</script>

<SendClassificationInstance>.Update

Updates the initialized send classification. You must include both SenderProfileKey and DeliveryProfileKey for the update to succeed.

Runtime-verified on a live CloudPage against a real, owned send classification with both SenderProfileKey and DeliveryProfileKey supplied: Update() returned "OK" and a follow-up SendClassification.Retrieve confirmed the changed Description persisted. Both profile keys must resolve; calling Update() with no arguments or with unresolvable profile keys returns the string "Error" (not a throw).

Syntax

<SendClassificationInstance>.Update(properties)

Parameters

Name	Type	Required	Description
`properties`	object	Yes	Includes `SenderProfileKey` and `DeliveryProfileKey`

Return value

"OK" on success; the string "Error" (not a throw) on failure.

Examples

Platform.Load("core", "1.1.5");
var sc = SendClassification.Init("mySendClassification");
var updatedSC = {
    Name: "Updated Send Classification",
    SenderProfileKey: "mySPKey",
    DeliveryProfileKey: "myDPKey"
};
var status = sc.Update(updatedSC);

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: <SendClassificationInstance>.Update(properties)
 *
 * CloudPage GET context. Proves:
 *   1. Update is an instance method (typeof "function").
 *   2. Update with Name + SenderProfileKey + DeliveryProfileKey returns
 *      "OK" (typeof string) and Description change persists via Retrieve.
 *   3. Update() with no arguments returns "Error" (not a throw).
 *   4. Update with unresolvable profile keys returns "Error" (not a throw).
 *   5. Both profile keys are required for success (page claim).
 *
 * FIXTURE: ssjs-guide-ts-sc-upd + owned profile keys.
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

var SP_KEY = "ssjs-senderprofile";
var DP_KEY = "ssjs-deliveryprofile";
var SC_KEY = "ssjs-guide-ts-sc-upd";

SendClassification.Init(SC_KEY).Remove();

SendClassification.Add({
    CustomerKey: SC_KEY,
    Name: "SSJS Guide TS SC Upd",
    Description: "before update",
    SenderProfileKey: SP_KEY,
    DeliveryProfileKey: DP_KEY
});

var sc = SendClassification.Init(SC_KEY);
assert("typeof instance.Update is function", typeof sc.Update, "function");

var status = sc.Update({
    Name: "Updated Send Classification",
    Description: "after update",
    SenderProfileKey: SP_KEY,
    DeliveryProfileKey: DP_KEY
});
assert("Update with both profile keys returns \"OK\"", "" + status, "OK");
assert("Update returns a string", typeof status, "string");

var after = SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY });
assert("Retrieve after Update finds the record", (after && after.length === 1) ? "true" : "false", "true");
assert("Description persisted after Update", "" + after[0].Description, "after update");
assert("Name persisted after Update", "" + after[0].Name, "Updated Send Classification");

assert("Update() with no arguments returns \"Error\"", "" + sc.Update(), "Error");
assert("Update() with no arguments does NOT throw", invocationResult(function () { return sc.Update(); }), "returned");
assert("Update with unresolvable profile keys returns \"Error\"", "" + sc.Update({
    Name: "x",
    SenderProfileKey: "ssjs-guide-no-such-sp-zzz",
    DeliveryProfileKey: "ssjs-guide-no-such-dp-zzz"
}), "Error");
assert("Update with unresolvable keys does NOT throw", invocationResult(function () {
    return sc.Update({
        Name: "x",
        SenderProfileKey: "ssjs-guide-no-such-sp-zzz",
        DeliveryProfileKey: "ssjs-guide-no-such-dp-zzz"
    });
}), "returned");

assert("fixture SC removed", "" + SendClassification.Init(SC_KEY).Remove(), "OK");
assert("SC orphan count 0", "" + SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY }).length, "0");
</script>

<SendClassificationInstance>.Remove

Removes the initialized send classification.

Runtime-verified on a live CloudPage: a throwaway send classification was created with SendClassification.Add, then Remove() returned "OK" and a follow-up SendClassification.Retrieve returned an empty array, confirming the record was deleted. Against a non-existent init’d key, Remove() returns the string "Error" (not a throw).

Syntax

<SendClassificationInstance>.Remove()

Return value

"OK" on success; the string "Error" (not a throw) on failure.

Examples

Platform.Load("core", "1.1.5");
var sc = SendClassification.Init("mySendClassification");
var status = sc.Remove();

Show test script

<script runat="server">
Platform.Load("core", "1.1.5");

/*
 * Chapter: <SendClassificationInstance>.Remove()
 *
 * CloudPage GET context. Proves:
 *   1. Remove is an instance method (typeof "function") taking no args.
 *   2. Remove() returns "OK" (typeof string) on success.
 *   3. Follow-up Retrieve returns an empty array (hard delete, not soft).
 *   4. Remove on a nonexistent init'd key returns "Error" (not a throw).
 *
 * FIXTURE: ssjs-guide-ts-sc-rm + owned profile keys.
 * EXPECTED OUTPUT: every line starts with PASS.
 */

function assert(id, actual, expected) {
    Platform.Response.Write((actual === expected ? "PASS " : "FAIL ") + id + " -> [" + actual + "]\n");
}
function invocationResult(fn) {
    try { fn(); return "returned"; } catch (ex) { return "threw"; }
}

var SP_KEY = "ssjs-senderprofile";
var DP_KEY = "ssjs-deliveryprofile";
var SC_KEY = "ssjs-guide-ts-sc-rm";

SendClassification.Init(SC_KEY).Remove();

SendClassification.Add({
    CustomerKey: SC_KEY,
    Name: "SSJS Guide TS SC Rm",
    Description: "about to be removed",
    SenderProfileKey: SP_KEY,
    DeliveryProfileKey: DP_KEY
});

var sc = SendClassification.Init(SC_KEY);
assert("typeof instance.Remove is function", typeof sc.Remove, "function");
assert("control: fixture is Retrievable before Remove", "" + SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY }).length, "1");

var status = sc.Remove();
assert("Remove() returns \"OK\"", "" + status, "OK");
assert("Remove returns a string", typeof status, "string");
assert("Retrieve after Remove is empty", "" + SendClassification.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: SC_KEY }).length, "0");
assert("second Remove on same key returns \"Error\"", "" + SendClassification.Init(SC_KEY).Remove(), "Error");

assert("Remove on nonexistent key returns \"Error\"", "" + SendClassification.Init("ssjs-guide-no-such-sc-zzz").Remove(), "Error");
assert("Remove on nonexistent key does NOT throw", invocationResult(function () { return SendClassification.Init("ssjs-guide-no-such-sc-zzz").Remove(); }), "returned");
</script>

SendClassification

Methods

SendClassification.Init

Syntax

Parameters

Return value

Examples

SendClassification.Add

Syntax

Parameters

Return value

Examples

SendClassification.Retrieve

Syntax

Parameters

Return value

Examples

<SendClassificationInstance>.Update

Syntax

Parameters

Return value

Examples

<SendClassificationInstance>.Remove

Syntax

Return value

Examples

See also

See Also