This library provides easy access to the Transmissions Resource.
Note: All methods return promises and accept an optional last argument callback. Read about how we handle callbacks and promises.
- list(options[, callback])
List an overview of all transmissions in the accountoptions.campaign_id- id of the campaign used by the transmissionoptions.template_id- id of the template used by the transmission
- get(id[, callback])
Retrieve the details about a transmission by its IDid- id of the transmission you want to look up required
- send(transmission[, options, callback])
Sends a message by creating a new transmissiontransmission- an object of transmission attributestransmission.cc- Recipients to receive a carbon copy of the transmissiontransmission.bcc- Recipients to discreetly receive a carbon copy of the transmissionoptions.num_rcpt_errors- maximum number of recipient errors returned
Visit our examples section to see all of our transmissions resource examples.
- If you specify a stored recipient list and inline recipients in a Transmission, you will receive an error.
- If you specify HTML and/or Plain Text content and then provide RFC-822 encoded content, you will receive an error.
- RFC-822 content is not valid with any other content type.
- If you specify a stored template and also provide inline content, you will receive an error.
- By default, open and click tracking are enabled for a transmission.
- By default, a transmission will use the published version of a stored template.