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

java.lang.Object
- sibModel.SendSmtpEmail

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

SendSmtpEmail

Constructor Summary

Constructors
Constructor and Description

SendSmtpEmail()

Constructors
Constructor and Description
`SendSmtpEmail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendSmtpEmail`	`addAttachmentItem(SendSmtpEmailAttachment attachmentItem)`
`SendSmtpEmail`	`addBccItem(SendSmtpEmailBcc bccItem)`
`SendSmtpEmail`	`addCcItem(SendSmtpEmailCc ccItem)`
`SendSmtpEmail`	`addMessageVersionsItem(SendSmtpEmailMessageVersions messageVersionsItem)`
`SendSmtpEmail`	`addTagsItem(String tagsItem)`
`SendSmtpEmail`	`addToItem(SendSmtpEmailTo toItem)`
`SendSmtpEmail`	`attachment(List<SendSmtpEmailAttachment> attachment)`
`SendSmtpEmail`	`bcc(List<SendSmtpEmailBcc> bcc)`
`SendSmtpEmail`	`cc(List<SendSmtpEmailCc> cc)`
`boolean`	`equals(Object o)`
`List<SendSmtpEmailAttachment>`	`getAttachment()` Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed).
`List<SendSmtpEmailBcc>`	`getBcc()` List of email addresses and names (optional) of the recipients in bcc
`List<SendSmtpEmailCc>`	`getCc()` List of email addresses and names (optional) of the recipients in cc
`Object`	`getHeaders()` Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email.
`String`	`getHtmlContent()` HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed )
`List<SendSmtpEmailMessageVersions>`	`getMessageVersions()` You can customize and send out multiple versions of a templateId.
`Object`	`getParams()` Pass the set of attributes to customize the template.
`SendSmtpEmailReplyTo`	`getReplyTo()` Get replyTo
`SendSmtpEmailSender`	`getSender()` Get sender
`String`	`getSubject()` Subject of the message.
`List<String>`	`getTags()` Tag your emails to find them more easily
`Long`	`getTemplateId()` Id of the template.
`String`	`getTextContent()` Plain Text body of the message ( Ignored if 'templateId' is passed )
`List<SendSmtpEmailTo>`	`getTo()` Mandatory if messageVersions are not passed, ignored if messageVersions are passed.
`int`	`hashCode()`
`SendSmtpEmail`	`headers(Object headers)`
`SendSmtpEmail`	`htmlContent(String htmlContent)`
`SendSmtpEmail`	`messageVersions(List<SendSmtpEmailMessageVersions> messageVersions)`
`SendSmtpEmail`	`params(Object params)`
`SendSmtpEmail`	`replyTo(SendSmtpEmailReplyTo replyTo)`
`SendSmtpEmail`	`sender(SendSmtpEmailSender sender)`
`void`	`setAttachment(List<SendSmtpEmailAttachment> attachment)`
`void`	`setBcc(List<SendSmtpEmailBcc> bcc)`
`void`	`setCc(List<SendSmtpEmailCc> cc)`
`void`	`setHeaders(Object headers)`
`void`	`setHtmlContent(String htmlContent)`
`void`	`setMessageVersions(List<SendSmtpEmailMessageVersions> messageVersions)`
`void`	`setParams(Object params)`
`void`	`setReplyTo(SendSmtpEmailReplyTo replyTo)`
`void`	`setSender(SendSmtpEmailSender sender)`
`void`	`setSubject(String subject)`
`void`	`setTags(List<String> tags)`
`void`	`setTemplateId(Long templateId)`
`void`	`setTextContent(String textContent)`
`void`	`setTo(List<SendSmtpEmailTo> to)`
`SendSmtpEmail`	`subject(String subject)`
`SendSmtpEmail`	`tags(List<String> tags)`
`SendSmtpEmail`	`templateId(Long templateId)`
`SendSmtpEmail`	`textContent(String textContent)`
`SendSmtpEmail`	`to(List<SendSmtpEmailTo> to)`
`String`	`toString()`

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

- Constructor Detail
  - SendSmtpEmail
```
public SendSmtpEmail()
```
- Method Detail
  - sender
```
public SendSmtpEmail sender(SendSmtpEmailSender sender)
```
  - getSender
```
public SendSmtpEmailSender getSender()
```
    Get sender
    
    Returns:
    
    sender
  - setSender
```
public void setSender(SendSmtpEmailSender sender)
```
  - to
```
public SendSmtpEmail to(List<SendSmtpEmailTo> to)
```
  - addToItem
```
public SendSmtpEmail addToItem(SendSmtpEmailTo toItem)
```
  - getTo
```
public List<SendSmtpEmailTo> getTo()
```
    Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{"name":"Jimmy", "email":"jimmy98@example.com"}, {"name":"Joe", "email":"joe@example.com"}]
    
    Returns:
    
    to
  - setTo
```
public void setTo(List<SendSmtpEmailTo> to)
```
  - bcc
```
public SendSmtpEmail bcc(List<SendSmtpEmailBcc> bcc)
```
  - addBccItem
```
public SendSmtpEmail addBccItem(SendSmtpEmailBcc bccItem)
```
  - getBcc
```
public List<SendSmtpEmailBcc> getBcc()
```
    List of email addresses and names (optional) of the recipients in bcc
    
    Returns:
    
    bcc
  - setBcc
```
public void setBcc(List<SendSmtpEmailBcc> bcc)
```
  - cc
```
public SendSmtpEmail cc(List<SendSmtpEmailCc> cc)
```
  - addCcItem
```
public SendSmtpEmail addCcItem(SendSmtpEmailCc ccItem)
```
  - getCc
```
public List<SendSmtpEmailCc> getCc()
```
    List of email addresses and names (optional) of the recipients in cc
    
    Returns:
    
    cc
  - setCc
```
public void setCc(List<SendSmtpEmailCc> cc)
```
  - htmlContent
```
public SendSmtpEmail htmlContent(String htmlContent)
```
  - getHtmlContent
```
public String getHtmlContent()
```
    HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed )
    
    Returns:
    
    htmlContent
  - setHtmlContent
```
public void setHtmlContent(String htmlContent)
```
  - textContent
```
public SendSmtpEmail textContent(String textContent)
```
  - getTextContent
```
public String getTextContent()
```
    Plain Text body of the message ( Ignored if 'templateId' is passed )
    
    Returns:
    
    textContent
  - setTextContent
```
public void setTextContent(String textContent)
```
  - subject
```
public SendSmtpEmail subject(String subject)
```
  - getSubject
```
public String getSubject()
```
    Subject of the message. Mandatory if 'templateId' is not passed
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - replyTo
```
public SendSmtpEmail replyTo(SendSmtpEmailReplyTo replyTo)
```
  - getReplyTo
```
public SendSmtpEmailReplyTo getReplyTo()
```
    Get replyTo
    
    Returns:
    
    replyTo
  - setReplyTo
```
public void setReplyTo(SendSmtpEmailReplyTo replyTo)
```
  - attachment
```
public SendSmtpEmail attachment(List<SendSmtpEmailAttachment> attachment)
```
  - addAttachmentItem
```
public SendSmtpEmail addAttachmentItem(SendSmtpEmailAttachment attachmentItem)
```
  - getAttachment
```
public List<SendSmtpEmailAttachment> getAttachment()
```
    Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{"url":"https://attachment.domain.com/myAttachmentFromUrl.jpg", "name":"myAttachmentFromUrl.jpg"}, {"content":"base64 example content", "name":"myAttachmentFromBase64.jpg"}]`. Allowed extensions for attachment file: 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, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
    
    Returns:
    
    attachment
  - setAttachment
```
public void setAttachment(List<SendSmtpEmailAttachment> attachment)
```
  - headers
```
public SendSmtpEmail headers(Object headers)
```
  - getHeaders
```
public Object getHeaders()
```
    Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_header"}`.
    
    Returns:
    
    headers
  - setHeaders
```
public void setHeaders(Object headers)
```
  - templateId
```
public SendSmtpEmail templateId(Long templateId)
```
  - getTemplateId
```
public Long getTemplateId()
```
    Id of the template. Mandatory if messageVersions are passed
    
    Returns:
    
    templateId
  - setTemplateId
```
public void setTemplateId(Long templateId)
```
  - params
```
public SendSmtpEmail params(Object params)
```
  - getParams
```
public Object getParams()
```
    Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. It's considered only if template is in New Template Language format.
    
    Returns:
    
    params
  - setParams
```
public void setParams(Object params)
```
  - messageVersions
```
public SendSmtpEmail messageVersions(List<SendSmtpEmailMessageVersions> messageVersions)
```
  - addMessageVersionsItem
```
public SendSmtpEmail addMessageVersionsItem(SendSmtpEmailMessageVersions messageVersionsItem)
```
  - getMessageVersions
```
public List<SendSmtpEmailMessageVersions> getMessageVersions()
```
    You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
    
    Returns:
    
    messageVersions
  - setMessageVersions
```
public void setMessageVersions(List<SendSmtpEmailMessageVersions> messageVersions)
```
  - tags
```
public SendSmtpEmail tags(List<String> tags)
```
  - addTagsItem
```
public SendSmtpEmail addTagsItem(String tagsItem)
```
  - getTags
```
public List<String> getTags()
```
    Tag your emails to find them more easily
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - 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 SendSmtpEmail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SendSmtpEmail

Method Detail

sender

getSender

setSender

to

addToItem

getTo

setTo

bcc

addBccItem

getBcc

setBcc

cc

addCcItem

getCc

setCc

htmlContent

getHtmlContent

setHtmlContent

textContent

getTextContent

setTextContent

subject

getSubject

setSubject

replyTo

getReplyTo

setReplyTo

attachment

addAttachmentItem

getAttachment

setAttachment

headers

getHeaders

setHeaders

templateId

getTemplateId

setTemplateId

params

getParams

setParams

messageVersions

addMessageVersionsItem

getMessageVersions

setMessageVersions

tags

addTagsItem

getTags

setTags

equals

hashCode

toString