UpdateEmailCampaign (sib-api-v3-sdk 5.3.0 API)

java.lang.Object
- sibModel.UpdateEmailCampaign

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2021-03-12T11:46:32.800+05:30")
public class UpdateEmailCampaign
extends Object

UpdateEmailCampaign

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UpdateEmailCampaign.WinnerCriteriaEnum
Choose the metrics that will determinate the winning version.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateEmailCampaign.WinnerCriteriaEnum` Choose the metrics that will determinate the winning version.

Constructor Summary

Constructors
Constructor and Description

UpdateEmailCampaign()

Constructors
Constructor and Description
`UpdateEmailCampaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateEmailCampaign`	`abTesting(Boolean abTesting)`
`UpdateEmailCampaign`	`attachmentUrl(String attachmentUrl)`
`boolean`	`equals(Object o)`
`UpdateEmailCampaign`	`footer(String footer)`
`String`	`getAttachmentUrl()` Absolute url of the attachment (no local file).
`String`	`getFooter()` Footer of the email campaign
`String`	`getHeader()` Header of the email campaign
`String`	`getHtmlContent()` Body of the message (HTML version).
`String`	`getHtmlUrl()` Url which contents the body of the email message.
`Long`	`getIncreaseRate()` Set a percentage increase rate for warming up your ip.
`Long`	`getInitialQuota()` Set an initial quota greater than 1 for warming up your ip.
`String`	`getName()` Name of the campaign
`Object`	`getParams()` Pass the set of attributes to customize the type 'classic' campaign.
`UpdateEmailCampaignRecipients`	`getRecipients()` Get recipients
`String`	`getReplyTo()` Email on which campaign recipients will be able to reply to
`String`	`getScheduledAt()` UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ).
`UpdateEmailCampaignSender`	`getSender()` Get sender
`Long`	`getSplitRule()` Add the size of your test groups.
`String`	`getSubject()` Subject of the campaign
`String`	`getSubjectA()` Subject A of the campaign.
`String`	`getSubjectB()` Subject B of the campaign.
`String`	`getTag()` Tag of the campaign
`String`	`getToField()` To personalize the «To» Field.
`String`	`getUtmCampaign()` Customize the utm_campaign value.
`UpdateEmailCampaign.WinnerCriteriaEnum`	`getWinnerCriteria()` Choose the metrics that will determinate the winning version.
`Long`	`getWinnerDelay()` Choose the duration of the test in hours.
`int`	`hashCode()`
`UpdateEmailCampaign`	`header(String header)`
`UpdateEmailCampaign`	`htmlContent(String htmlContent)`
`UpdateEmailCampaign`	`htmlUrl(String htmlUrl)`
`UpdateEmailCampaign`	`increaseRate(Long increaseRate)`
`UpdateEmailCampaign`	`initialQuota(Long initialQuota)`
`UpdateEmailCampaign`	`inlineImageActivation(Boolean inlineImageActivation)`
`UpdateEmailCampaign`	`ipWarmupEnable(Boolean ipWarmupEnable)`
`Boolean`	`isAbTesting()` Status of A/B Test.
`Boolean`	`isInlineImageActivation()` Status of inline image.
`Boolean`	`isIpWarmupEnable()` Available for dedicated ip clients.
`Boolean`	`isMirrorActive()` Status of mirror links in campaign.
`Boolean`	`isRecurring()` FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
`Boolean`	`isSendAtBestTime()` Set this to true if you want to send your campaign at best time.
`UpdateEmailCampaign`	`mirrorActive(Boolean mirrorActive)`
`UpdateEmailCampaign`	`name(String name)`
`UpdateEmailCampaign`	`params(Object params)`
`UpdateEmailCampaign`	`recipients(UpdateEmailCampaignRecipients recipients)`
`UpdateEmailCampaign`	`recurring(Boolean recurring)`
`UpdateEmailCampaign`	`replyTo(String replyTo)`
`UpdateEmailCampaign`	`scheduledAt(String scheduledAt)`
`UpdateEmailCampaign`	`sendAtBestTime(Boolean sendAtBestTime)`
`UpdateEmailCampaign`	`sender(UpdateEmailCampaignSender sender)`
`void`	`setAbTesting(Boolean abTesting)`
`void`	`setAttachmentUrl(String attachmentUrl)`
`void`	`setFooter(String footer)`
`void`	`setHeader(String header)`
`void`	`setHtmlContent(String htmlContent)`
`void`	`setHtmlUrl(String htmlUrl)`
`void`	`setIncreaseRate(Long increaseRate)`
`void`	`setInitialQuota(Long initialQuota)`
`void`	`setInlineImageActivation(Boolean inlineImageActivation)`
`void`	`setIpWarmupEnable(Boolean ipWarmupEnable)`
`void`	`setMirrorActive(Boolean mirrorActive)`
`void`	`setName(String name)`
`void`	`setParams(Object params)`
`void`	`setRecipients(UpdateEmailCampaignRecipients recipients)`
`void`	`setRecurring(Boolean recurring)`
`void`	`setReplyTo(String replyTo)`
`void`	`setScheduledAt(String scheduledAt)`
`void`	`setSendAtBestTime(Boolean sendAtBestTime)`
`void`	`setSender(UpdateEmailCampaignSender sender)`
`void`	`setSplitRule(Long splitRule)`
`void`	`setSubject(String subject)`
`void`	`setSubjectA(String subjectA)`
`void`	`setSubjectB(String subjectB)`
`void`	`setTag(String tag)`
`void`	`setToField(String toField)`
`void`	`setUtmCampaign(String utmCampaign)`
`void`	`setWinnerCriteria(UpdateEmailCampaign.WinnerCriteriaEnum winnerCriteria)`
`void`	`setWinnerDelay(Long winnerDelay)`
`UpdateEmailCampaign`	`splitRule(Long splitRule)`
`UpdateEmailCampaign`	`subject(String subject)`
`UpdateEmailCampaign`	`subjectA(String subjectA)`
`UpdateEmailCampaign`	`subjectB(String subjectB)`
`UpdateEmailCampaign`	`tag(String tag)`
`UpdateEmailCampaign`	`toField(String toField)`
`String`	`toString()`
`UpdateEmailCampaign`	`utmCampaign(String utmCampaign)`
`UpdateEmailCampaign`	`winnerCriteria(UpdateEmailCampaign.WinnerCriteriaEnum winnerCriteria)`
`UpdateEmailCampaign`	`winnerDelay(Long winnerDelay)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateEmailCampaign
```
public UpdateEmailCampaign()
```
- Method Detail
  - tag
```
public UpdateEmailCampaign tag(String tag)
```
  - getTag
```
public String getTag()
```
    Tag of the campaign
    
    Returns:
    
    tag
  - setTag
```
public void setTag(String tag)
```
  - sender
```
public UpdateEmailCampaign sender(UpdateEmailCampaignSender sender)
```
  - getSender
```
public UpdateEmailCampaignSender getSender()
```
    Get sender
    
    Returns:
    
    sender
  - setSender
```
public void setSender(UpdateEmailCampaignSender sender)
```
  - name
```
public UpdateEmailCampaign name(String name)
```
  - getName
```
public String getName()
```
    Name of the campaign
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - htmlContent
```
public UpdateEmailCampaign htmlContent(String htmlContent)
```
  - getHtmlContent
```
public String getHtmlContent()
```
    Body of the message (HTML version). REQUIRED if htmlUrl is empty
    
    Returns:
    
    htmlContent
  - setHtmlContent
```
public void setHtmlContent(String htmlContent)
```
  - htmlUrl
```
public UpdateEmailCampaign htmlUrl(String htmlUrl)
```
  - getHtmlUrl
```
public String getHtmlUrl()
```
    Url which contents the body of the email message. REQUIRED if htmlContent is empty
    
    Returns:
    
    htmlUrl
  - setHtmlUrl
```
public void setHtmlUrl(String htmlUrl)
```
  - scheduledAt
```
public UpdateEmailCampaign scheduledAt(String scheduledAt)
```
  - getScheduledAt
```
public String getScheduledAt()
```
    UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
    
    Returns:
    
    scheduledAt
  - setScheduledAt
```
public void setScheduledAt(String scheduledAt)
```
  - subject
```
public UpdateEmailCampaign subject(String subject)
```
  - getSubject
```
public String getSubject()
```
    Subject of the campaign
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - replyTo
```
public UpdateEmailCampaign replyTo(String replyTo)
```
  - getReplyTo
```
public String getReplyTo()
```
    Email on which campaign recipients will be able to reply to
    
    Returns:
    
    replyTo
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
  - toField
```
public UpdateEmailCampaign toField(String toField)
```
  - getToField
```
public String getToField()
```
    To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization
    
    Returns:
    
    toField
  - setToField
```
public void setToField(String toField)
```
  - recipients
```
public UpdateEmailCampaign recipients(UpdateEmailCampaignRecipients recipients)
```
  - getRecipients
```
public UpdateEmailCampaignRecipients getRecipients()
```
    Get recipients
    
    Returns:
    
    recipients
  - setRecipients
```
public void setRecipients(UpdateEmailCampaignRecipients recipients)
```
  - attachmentUrl
```
public UpdateEmailCampaign attachmentUrl(String attachmentUrl)
```
  - getAttachmentUrl
```
public String getAttachmentUrl()
```
    Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
    
    Returns:
    
    attachmentUrl
  - setAttachmentUrl
```
public void setAttachmentUrl(String attachmentUrl)
```
  - inlineImageActivation
```
public UpdateEmailCampaign inlineImageActivation(Boolean inlineImageActivation)
```
  - isInlineImageActivation
```
public Boolean isInlineImageActivation()
```
    Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts.
    
    Returns:
    
    inlineImageActivation
  - setInlineImageActivation
```
public void setInlineImageActivation(Boolean inlineImageActivation)
```
  - mirrorActive
```
public UpdateEmailCampaign mirrorActive(Boolean mirrorActive)
```
  - isMirrorActive
```
public Boolean isMirrorActive()
```
    Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
    
    Returns:
    
    mirrorActive
  - setMirrorActive
```
public void setMirrorActive(Boolean mirrorActive)
```
  - recurring
```
public UpdateEmailCampaign recurring(Boolean recurring)
```
  - isRecurring
```
public Boolean isRecurring()
```
    FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Boolean recurring)
```
  - footer
```
public UpdateEmailCampaign footer(String footer)
```
  - getFooter
```
public String getFooter()
```
    Footer of the email campaign
    
    Returns:
    
    footer
  - setFooter
```
public void setFooter(String footer)
```
  - header
```
public UpdateEmailCampaign header(String header)
```
  - getHeader
```
public String getHeader()
```
    Header of the email campaign
    
    Returns:
    
    header
  - setHeader
```
public void setHeader(String header)
```
  - utmCampaign
```
public UpdateEmailCampaign utmCampaign(String utmCampaign)
```
  - getUtmCampaign
```
public String getUtmCampaign()
```
    Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
    
    Returns:
    
    utmCampaign
  - setUtmCampaign
```
public void setUtmCampaign(String utmCampaign)
```
  - params
```
public UpdateEmailCampaign params(Object params)
```
  - getParams
```
public Object getParams()
```
    Pass the set of attributes to customize the type 'classic' campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'
    
    Returns:
    
    params
  - setParams
```
public void setParams(Object params)
```
  - sendAtBestTime
```
public UpdateEmailCampaign sendAtBestTime(Boolean sendAtBestTime)
```
  - isSendAtBestTime
```
public Boolean isSendAtBestTime()
```
    Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
    
    Returns:
    
    sendAtBestTime
  - setSendAtBestTime
```
public void setSendAtBestTime(Boolean sendAtBestTime)
```
  - abTesting
```
public UpdateEmailCampaign abTesting(Boolean abTesting)
```
  - isAbTesting
```
public Boolean isAbTesting()
```
    Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
    
    Returns:
    
    abTesting
  - setAbTesting
```
public void setAbTesting(Boolean abTesting)
```
  - subjectA
```
public UpdateEmailCampaign subjectA(String subjectA)
```
  - getSubjectA
```
public String getSubjectA()
```
    Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
    
    Returns:
    
    subjectA
  - setSubjectA
```
public void setSubjectA(String subjectA)
```
  - subjectB
```
public UpdateEmailCampaign subjectB(String subjectB)
```
  - getSubjectB
```
public String getSubjectB()
```
    Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value
    
    Returns:
    
    subjectB
  - setSubjectB
```
public void setSubjectB(String subjectB)
```
  - splitRule
```
public UpdateEmailCampaign splitRule(Long splitRule)
```
  - getSplitRule
```
public Long getSplitRule()
```
    Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else minimum: 1 maximum: 50
    
    Returns:
    
    splitRule
  - setSplitRule
```
public void setSplitRule(Long splitRule)
```
  - winnerCriteria
```
public UpdateEmailCampaign winnerCriteria(UpdateEmailCampaign.WinnerCriteriaEnum winnerCriteria)
```
  - getWinnerCriteria
```
public UpdateEmailCampaign.WinnerCriteriaEnum getWinnerCriteria()
```
    Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record
    
    Returns:
    
    winnerCriteria
  - setWinnerCriteria
```
public void setWinnerCriteria(UpdateEmailCampaign.WinnerCriteriaEnum winnerCriteria)
```
  - winnerDelay
```
public UpdateEmailCampaign winnerDelay(Long winnerDelay)
```
  - getWinnerDelay
```
public Long getWinnerDelay()
```
    Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record minimum: 1 maximum: 168
    
    Returns:
    
    winnerDelay
  - setWinnerDelay
```
public void setWinnerDelay(Long winnerDelay)
```
  - ipWarmupEnable
```
public UpdateEmailCampaign ipWarmupEnable(Boolean ipWarmupEnable)
```
  - isIpWarmupEnable
```
public Boolean isIpWarmupEnable()
```
    Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
    
    Returns:
    
    ipWarmupEnable
  - setIpWarmupEnable
```
public void setIpWarmupEnable(Boolean ipWarmupEnable)
```
  - initialQuota
```
public UpdateEmailCampaign initialQuota(Long initialQuota)
```
  - getInitialQuota
```
public Long getInitialQuota()
```
    Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
    
    Returns:
    
    initialQuota
  - setInitialQuota
```
public void setInitialQuota(Long initialQuota)
```
  - increaseRate
```
public UpdateEmailCampaign increaseRate(Long increaseRate)
```
  - getIncreaseRate
```
public Long getIncreaseRate()
```
    Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%. minimum: 0 maximum: 100
    
    Returns:
    
    increaseRate
  - setIncreaseRate
```
public void setIncreaseRate(Long increaseRate)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UpdateEmailCampaign

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateEmailCampaign

Method Detail

tag

getTag

setTag

sender

getSender

setSender

name

getName

setName

htmlContent

getHtmlContent

setHtmlContent

htmlUrl

getHtmlUrl

setHtmlUrl

scheduledAt

getScheduledAt

setScheduledAt

subject

getSubject

setSubject

replyTo

getReplyTo

setReplyTo

toField

getToField

setToField

recipients

getRecipients

setRecipients

attachmentUrl

getAttachmentUrl

setAttachmentUrl

inlineImageActivation

isInlineImageActivation

setInlineImageActivation

mirrorActive

isMirrorActive

setMirrorActive

recurring

isRecurring

setRecurring

footer

getFooter

setFooter

header

getHeader

setHeader

utmCampaign

getUtmCampaign

setUtmCampaign

params

getParams

setParams

sendAtBestTime

isSendAtBestTime

setSendAtBestTime

abTesting

isAbTesting

setAbTesting

subjectA

getSubjectA

setSubjectA

subjectB

getSubjectB

setSubjectB

splitRule

getSplitRule

setSplitRule

winnerCriteria

getWinnerCriteria

setWinnerCriteria