Recent pages

Edit
page

New
page

Print
page
Page last modified 17:45, 6 Jan 2012 by Admin
0
Redirect
Page Notifications Off
Documentation Wiki > Developer Documentation > Web Service Guide > Objects > EmailSendDefinition

EmailSendDefinition

From $1

    Table of contents
    1. 1. Definition
    2. 2. Properties
    3. 3. Description
    4. 4. Methods
    5. 5. Use Cases
    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    Definition

    Record that contains the message information, sender profile, delivery profile, and audience information.

    Properties

    This object has following properties.

    NameData TypeDescription
    Additionalxsd:stringThe ID for a send that customers use as a campaign ID.
    AutoBccEmailxsd:stringDefines blind carbon copy email address to which to send a message as part of an email send definition.
    BccEmailxsd:stringIndicates email addresses to receive blind carbon copy of a message.
    CategoryIDxsd:intSpecifies the identifier of the folder.
    CCEmailxsd:stringCarbon copy email address.
    ClientClientIDSpecifies the account ownership and context of an object.
    CorrelationIDxsd:stringIdentifies correlation of objects across several requests.
    CreatedDatexsd:dateTimeRead-only date and time of the object's creation.
    CustomerKeyxsd:stringUser-supplied unique identifier for an object within an object type (corresponds to the external key assigned to an object in the user interface).
    DeduplicateByEmailxsd:booleanIndicates whether a send definition should de-duplicate multiple emails sent to the same email address.
    DeliveryProfileDeliveryProfileIdentifies the delivery profile included in a send classification.
    DeliveryScheduledTimexsd:dateTimeDefines scheduled data and time for a send related to an email send definition.
    Descriptionxsd:stringDescribes and provides information regarding the object.
    DomainTypeDeliveryProfileDomainTypeEnumDefines the type of domain (DefaultDomain or CustomDomain) associated with a delivery profile or send definition.
    DynamicEmailSubjectxsd:stringContains content to be used in a dynamic subject line.
    EmailEmailDefault email address for object. Indicates if subscriber information can be used for email sends.
    EmailSubjectxsd:stringSubject for an email send
    ExclusionFilterxsd:stringContains a string of AMPscript used to exclude email addresses from a send definition.
    FooterContentAreaContentAreaDefines footer content area to use as part of a delivery profile or send definition.
    FooterSalutationSourceSalutationSourceEnumDefines source of a footer salutation to use as part of a delivery profile or send definition (Default, Content Library, or None)
    FromAddressxsd:stringIndicates From address associated with a object. Deprecated for email send definitions and triggered send definitions.
    FromNamexsd:stringSpecifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
    HeaderContentAreaContentAreaDefines content area to be used in the header of a delivery profile or a send definition.
    HeaderSalutationSourceSalutationSourceEnumDefines source of header salutation for a delivery profile or send definition.
    IDxsd:intRead-only legacy identifier for an object. Not supported on all objects. Some objects use the ObjectID property as the ExactTarget unique ID.
    InteractionObjectIDxsd:stringReturns associated ID for activities within the asynchronous process of the overall conversation or program.
    IsMultipartxsd:booleanIndicates whether the email is sent with Multipart/MIME enabled.
    IsSeedListSendxsd:booleanIndicates whether a email send includes the use of a seed list.
    IsSendLoggingxsd:booleanIndicates whether send logging is enabled for the specified send definition
    IsWrappedxsd:booleanIndicates whether an email send contains the links necessary to process tracking information for clicks.
    Keywordxsd:stringReserved for future use.
    MessageDeliveryTypeMessageDeliveryTypeEnumEnumerates the types of message delivery options available for email send definitions.
    ModifiedDateNullable`1Indicates the last time object information was modified.
    Namexsd:stringName of the object or property.
    ObjectIDxsd:stringSystem-controlled, read-only text string identifier for object.
    ObjectStatexsd:stringReserved for future use.
    OwnerOwnerDescribes account ownership of subscriber in an on-your-behalf account.
    PartnerKeyxsd:stringUnique identifier provided by partner for an object, accessible only via API.
    PartnerPropertiesAPIProperty[]A collection of metadata supplied by client and stored by system - only accessible via API.
    PrivateDomainPrivateDomainDefines private domain to use as part of a delivery profile or send definition.
    PrivateIPPrivateIPContains information on the private IP address associated with a delivery profile.
    SendClassificationSendClassificationIndicates the send classification to use as part of a send definition.
    SendDefinitionListSendDefinitionList[]Indicates the subscriber list to use as part of an email send definition.
    SenderProfileSenderProfileIdentifies the sender profile included in the send classificiation.
    SendLimitxsd:intIndicates limit of messages to send as part of a send definition within a predefined send window.
    SendWindowClosexsd:dateTimeDefines the end of a send window for a send definition.
    SendWindowDeletexsd:booleanIndicates whether an existing send window for a send definition should be deleted.
    SendWindowOpenxsd:dateTimeDefines the beginning of a send window for a send definition.
    SourceAddressTypeDeliveryProfileSourceAddressTypeEnumIndicates the source IP address type used with the delivery profile. Valid values include DefaultPrivateIPAddress and CustomPrivateIPAddress.
    SuppressTrackingxsd:booleanIndicates whether the send definition suppresses tracking results for associated sends.
    TestEmailAddrxsd:stringDefines an email address to which to send a test message as part of an email send definition. Use the Test action when sending a test email to an email send definition.
    TrackingUsersTrackingUser[]Defines account users with access to tracking information for that send definition.

    Description

    When you update a user-initiated send definition via the web service API with the new Email object, you must set the EmailSubject property on the email send definition. If you don't pass the new subject to the email send definition, it will retain the old subject for that definition. You must also specify the send classification to use as part of the send.

    The Additional property contains information that appears in the tracking extract, and there is a personalization string for it.

    You must specify the CCEmail property in an email send definition, as you cannot specify this property at send time. You can create a profile attribute for this property and pass in a value at send time, however.

    The BccEmail property allows access to the BCC feature if enabled on the account. It does not error out if feature is not enabled. The API returns no tracking information for BCC emails. You must specify this property in an email send definition, as you cannot specify this property at send time. You can create a profile attribute for this property and pass in a value at send time, however.

    By including several different lists or data extensions in a send definition, the same email address may show up multiple times. Giving the DeduplicateByEmail property a value of true ensures that only one message is sent to a single email address.

    Valid values for the HeaderSalutationSource and FooterSalutationSource properties includes the following:

    • Default
    • Content Library
    • None

    Valid values for the MessageDeliveryType property include the following:

    • Standard
    • DelayedDeliveryByMTAQueue

    Use Standard as the default value unless your account is configured to handle burst sending.

    Methods

    This object has the following methods.

    NameDescription
    CreateCreates an individual object or a batch of objects.
    DeleteDeletes an individual object or a batch of objects.
    PerformMethod description goes here.
    RetrieveRetrieves an individual object or a batch of objects.
    ScheduleSchedules an individual object or a batch of objects.
    UpdateUpdates an individual object or a batch of objects.

    Use Cases

    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:45:34 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     

    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 5170 backwards:
       
    Tags: (Edit tags)
    • No tags
    Attach file or image
    Files (0)
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin