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

java.lang.Object
- sibModel.CreateEmailCampaign

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

CreateEmailCampaign

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description

CreateEmailCampaign()

Constructors
Constructor and Description
`CreateEmailCampaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateEmailCampaign`	`abTesting(Boolean abTesting)`
`CreateEmailCampaign`	`attachmentUrl(String attachmentUrl)`
`boolean`	`equals(Object o)`
`CreateEmailCampaign`	`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()` Mandatory if htmlUrl and templateId are empty.
`String`	`getHtmlUrl()` Mandatory if htmlContent and templateId are empty.
`Long`	`getIncreaseRate()` Mandatory if ipWarmupEnable is set to true.
`Long`	`getInitialQuota()` Mandatory if ipWarmupEnable is set to true.
`String`	`getName()` Name of the campaign
`Object`	`getParams()` Pass the set of attributes to customize the type classic campaign.
`CreateEmailCampaignRecipients`	`getRecipients()` Get recipients
`String`	`getReplyTo()` Email on which the campaign recipients will be able to reply to
`String`	`getScheduledAt()` Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ).
`CreateEmailCampaignSender`	`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
`Long`	`getTemplateId()` Mandatory if htmlContent and htmlUrl are empty.
`String`	`getToField()` To personalize the «To» Field.
`String`	`getUtmCampaign()` Customize the utm_campaign value.
`CreateEmailCampaign.WinnerCriteriaEnum`	`getWinnerCriteria()` Choose the metrics that will determinate the winning version.
`Long`	`getWinnerDelay()` Choose the duration of the test in hours.
`int`	`hashCode()`
`CreateEmailCampaign`	`header(String header)`
`CreateEmailCampaign`	`htmlContent(String htmlContent)`
`CreateEmailCampaign`	`htmlUrl(String htmlUrl)`
`CreateEmailCampaign`	`increaseRate(Long increaseRate)`
`CreateEmailCampaign`	`initialQuota(Long initialQuota)`
`CreateEmailCampaign`	`inlineImageActivation(Boolean inlineImageActivation)`
`CreateEmailCampaign`	`ipWarmupEnable(Boolean ipWarmupEnable)`
`Boolean`	`isAbTesting()` Status of A/B Test.
`Boolean`	`isInlineImageActivation()` Use true to embedded the images in your email.
`Boolean`	`isIpWarmupEnable()` Available for dedicated ip clients.
`Boolean`	`isMirrorActive()` Use true to enable the mirror link
`Boolean`	`isSendAtBestTime()` Set this to true if you want to send your campaign at best time.
`CreateEmailCampaign`	`mirrorActive(Boolean mirrorActive)`
`CreateEmailCampaign`	`name(String name)`
`CreateEmailCampaign`	`params(Object params)`
`CreateEmailCampaign`	`recipients(CreateEmailCampaignRecipients recipients)`
`CreateEmailCampaign`	`replyTo(String replyTo)`
`CreateEmailCampaign`	`scheduledAt(String scheduledAt)`
`CreateEmailCampaign`	`sendAtBestTime(Boolean sendAtBestTime)`
`CreateEmailCampaign`	`sender(CreateEmailCampaignSender 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(CreateEmailCampaignRecipients recipients)`
`void`	`setReplyTo(String replyTo)`
`void`	`setScheduledAt(String scheduledAt)`
`void`	`setSendAtBestTime(Boolean sendAtBestTime)`
`void`	`setSender(CreateEmailCampaignSender sender)`
`void`	`setSplitRule(Long splitRule)`
`void`	`setSubject(String subject)`
`void`	`setSubjectA(String subjectA)`
`void`	`setSubjectB(String subjectB)`
`void`	`setTag(String tag)`
`void`	`setTemplateId(Long templateId)`
`void`	`setToField(String toField)`
`void`	`setUtmCampaign(String utmCampaign)`
`void`	`setWinnerCriteria(CreateEmailCampaign.WinnerCriteriaEnum winnerCriteria)`
`void`	`setWinnerDelay(Long winnerDelay)`
`CreateEmailCampaign`	`splitRule(Long splitRule)`
`CreateEmailCampaign`	`subject(String subject)`
`CreateEmailCampaign`	`subjectA(String subjectA)`
`CreateEmailCampaign`	`subjectB(String subjectB)`
`CreateEmailCampaign`	`tag(String tag)`
`CreateEmailCampaign`	`templateId(Long templateId)`
`CreateEmailCampaign`	`toField(String toField)`
`String`	`toString()`
`CreateEmailCampaign`	`utmCampaign(String utmCampaign)`
`CreateEmailCampaign`	`winnerCriteria(CreateEmailCampaign.WinnerCriteriaEnum winnerCriteria)`
`CreateEmailCampaign`	`winnerDelay(Long winnerDelay)`

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

- Constructor Detail
  - CreateEmailCampaign
```
public CreateEmailCampaign()
```
- Method Detail
  - tag
```
public CreateEmailCampaign tag(String tag)
```
  - getTag
```
public String getTag()
```
    Tag of the campaign
    
    Returns:
    
    tag
  - setTag
```
public void setTag(String tag)
```
  - sender
```
public CreateEmailCampaign sender(CreateEmailCampaignSender sender)
```
  - getSender
```
public CreateEmailCampaignSender getSender()
```
    Get sender
    
    Returns:
    
    sender
  - setSender
```
public void setSender(CreateEmailCampaignSender sender)
```
  - name
```
public CreateEmailCampaign name(String name)
```
  - getName
```
public String getName()
```
    Name of the campaign
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - htmlContent
```
public CreateEmailCampaign htmlContent(String htmlContent)
```
  - getHtmlContent
```
public String getHtmlContent()
```
    Mandatory if htmlUrl and templateId are empty. Body of the message (HTML)
    
    Returns:
    
    htmlContent
  - setHtmlContent
```
public void setHtmlContent(String htmlContent)
```
  - htmlUrl
```
public CreateEmailCampaign htmlUrl(String htmlUrl)
```
  - getHtmlUrl
```
public String getHtmlUrl()
```
    Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
    
    Returns:
    
    htmlUrl
  - setHtmlUrl
```
public void setHtmlUrl(String htmlUrl)
```
  - templateId
```
public CreateEmailCampaign templateId(Long templateId)
```
  - getTemplateId
```
public Long getTemplateId()
```
    Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
    
    Returns:
    
    templateId
  - setTemplateId
```
public void setTemplateId(Long templateId)
```
  - scheduledAt
```
public CreateEmailCampaign scheduledAt(String scheduledAt)
```
  - getScheduledAt
```
public String getScheduledAt()
```
    Sending UTC date-time (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 CreateEmailCampaign subject(String subject)
```
  - getSubject
```
public String getSubject()
```
    Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - replyTo
```
public CreateEmailCampaign replyTo(String replyTo)
```
  - getReplyTo
```
public String getReplyTo()
```
    Email on which the campaign recipients will be able to reply to
    
    Returns:
    
    replyTo
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
  - toField
```
public CreateEmailCampaign 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 CreateEmailCampaign recipients(CreateEmailCampaignRecipients recipients)
```
  - getRecipients
```
public CreateEmailCampaignRecipients getRecipients()
```
    Get recipients
    
    Returns:
    
    recipients
  - setRecipients
```
public void setRecipients(CreateEmailCampaignRecipients recipients)
```
  - attachmentUrl
```
public CreateEmailCampaign 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 CreateEmailCampaign inlineImageActivation(Boolean inlineImageActivation)
```
  - isInlineImageActivation
```
public Boolean isInlineImageActivation()
```
    Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts
    
    Returns:
    
    inlineImageActivation
  - setInlineImageActivation
```
public void setInlineImageActivation(Boolean inlineImageActivation)
```
  - mirrorActive
```
public CreateEmailCampaign mirrorActive(Boolean mirrorActive)
```
  - isMirrorActive
```
public Boolean isMirrorActive()
```
    Use true to enable the mirror link
    
    Returns:
    
    mirrorActive
  - setMirrorActive
```
public void setMirrorActive(Boolean mirrorActive)
```
  - footer
```
public CreateEmailCampaign footer(String footer)
```
  - getFooter
```
public String getFooter()
```
    Footer of the email campaign
    
    Returns:
    
    footer
  - setFooter
```
public void setFooter(String footer)
```
  - header
```
public CreateEmailCampaign header(String header)
```
  - getHeader
```
public String getHeader()
```
    Header of the email campaign
    
    Returns:
    
    header
  - setHeader
```
public void setHeader(String header)
```
  - utmCampaign
```
public CreateEmailCampaign 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 CreateEmailCampaign params(Object params)
```
  - getParams
```
public Object getParams()
```
    Pass the set of attributes to customize the type classic campaign. For example, {"FNAME":"Joe", "LNAME":"Doe"}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. 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 CreateEmailCampaign sendAtBestTime(Boolean sendAtBestTime)
```
  - isSendAtBestTime
```
public Boolean isSendAtBestTime()
```
    Set this to true if you want to send your campaign at best time.
    
    Returns:
    
    sendAtBestTime
  - setSendAtBestTime
```
public void setSendAtBestTime(Boolean sendAtBestTime)
```
  - abTesting
```
public CreateEmailCampaign 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 when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & '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 CreateEmailCampaign subjectA(String subjectA)
```
  - getSubjectA
```
public String getSubjectA()
```
    Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
    
    Returns:
    
    subjectA
  - setSubjectA
```
public void setSubjectA(String subjectA)
```
  - subjectB
```
public CreateEmailCampaign subjectB(String subjectB)
```
  - getSubjectB
```
public String getSubjectB()
```
    Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
    
    Returns:
    
    subjectB
  - setSubjectB
```
public void setSubjectB(String subjectB)
```
  - splitRule
```
public CreateEmailCampaign splitRule(Long splitRule)
```
  - getSplitRule
```
public Long getSplitRule()
```
    Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. 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 CreateEmailCampaign winnerCriteria(CreateEmailCampaign.WinnerCriteriaEnum winnerCriteria)
```
  - getWinnerCriteria
```
public CreateEmailCampaign.WinnerCriteriaEnum getWinnerCriteria()
```
    Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed
    
    Returns:
    
    winnerCriteria
  - setWinnerCriteria
```
public void setWinnerCriteria(CreateEmailCampaign.WinnerCriteriaEnum winnerCriteria)
```
  - winnerDelay
```
public CreateEmailCampaign 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. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed minimum: 1 maximum: 168
    
    Returns:
    
    winnerDelay
  - setWinnerDelay
```
public void setWinnerDelay(Long winnerDelay)
```
  - ipWarmupEnable
```
public CreateEmailCampaign 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 CreateEmailCampaign initialQuota(Long initialQuota)
```
  - getInitialQuota
```
public Long getInitialQuota()
```
    Mandatory if ipWarmupEnable is set to true. 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 CreateEmailCampaign increaseRate(Long increaseRate)
```
  - getIncreaseRate
```
public Long getIncreaseRate()
```
    Mandatory if ipWarmupEnable is set to true. 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 CreateEmailCampaign

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateEmailCampaign

Method Detail

tag

getTag

setTag

sender

getSender

setSender

name

getName

setName

htmlContent

getHtmlContent

setHtmlContent

htmlUrl

getHtmlUrl

setHtmlUrl

templateId

getTemplateId

setTemplateId

scheduledAt

getScheduledAt

setScheduledAt

subject

getSubject

setSubject

replyTo

getReplyTo

setReplyTo

toField

getToField

setToField

recipients

getRecipients

setRecipients

attachmentUrl

getAttachmentUrl

setAttachmentUrl

inlineImageActivation

isInlineImageActivation

setInlineImageActivation

mirrorActive

isMirrorActive

setMirrorActive

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