Parameters

An array of personalization instances representing the various recipients of the email.

The content sections of the email.

The subject of the email. If the personalizations in the email contain subjects, those will override this subject.

The sending address on the email.

The reply to address on the email.

Attachments to add to the email.

The ID of a template from the Template Engine to use with the email.

Additional headers that should be added to the email.

Categories to associate with the email.

A dictionary of key/value pairs that define large blocks of content that can be inserted into your emails using substitution tags. An example of this might look like the following:

let bob = Personalization(recipients: "bob@example.com")
bob.substitutions = [
    ":salutation": ":male",
    ":name": "Bob",
    ":event_details": ":event2",
    ":event_date": "Feb 14"
]

let alice = Personalization(recipients: "alice@example.com")
alice.substitutions = [
    ":salutation": ":female",
    ":name": "Alice",
    ":event_details": ":event1",
    ":event_date": "Jan 1"
]

let casey = Personalization(recipients: "casey@example.com")
casey.substitutions = [
    ":salutation": ":neutral",
    ":name": "Casey",
    ":event_details": ":event1",
    ":event_date": "Aug 11"
]

let personalization = [
    bob,
    alice,
    casey
]
let plainText = ":salutation,\n\nPlease join us for the :event_details."
let htmlText = "<p>:salutation,</p><p>Please join us for the :event_details.</p>"
let content = Content.emailBody(plain: plainText, html: htmlText)
let email = Email(
    personalizations: personalization,
    from: "from@example.com",
    content: content
)
email.parameters?.subject = "Hello World"
email.parameters?.sections = [
    ":male": "Mr. :name",
    ":female": "Ms. :name",
    ":neutral": ":name",
    ":event1": "New User Event on :event_date",
    ":event2": "Veteran User Appreciation on :event_date"
]

A set of custom arguments to add to the email. The keys of the dictionary should be the names of the custom arguments, while the values should represent the value of each custom argument. If personalizations in the email also contain custom arguments, they will be merged with these custom arguments, taking a preference to the personalization’s custom arguments in the case of a conflict.

An ASM instance representing the unsubscribe group settings to apply to the email.

An optional time to send the email at.

This ID represents a batch of emails (AKA multiple sends of the same email) to be associated to each other for scheduling. Including a batch_id in your request allows you to include this email in that batch, and also enables you to cancel or pause the delivery of that entire batch. For more information, please read about Cancel Scheduled Sends.

The IP Pool that you would like to send this email from. See the docs page for more information about creating IP Pools.

An optional array of mail settings to configure the email with.

An optional array of tracking settings to configure the email with.

Initializes the parameters with a list of personalizations, a from address, content, and a subject.