SendEmailOptions (mailslurp-client-java 11.5.20 API)

java.lang.Object
- com.mailslurp.models.SendEmailOptions

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-04-02T22:56:45.878Z[GMT]")
public class SendEmailOptions
extends Object

Options for sending an email message from an inbox. You must provide one of: `to`, `toGroup`, or `toContacts` to send an email. All other parameters are optional.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SendEmailOptions.SendStrategyEnum
Optional strategy to use when sending the email

Nested Classes
Modifier and Type	Class and Description
`static class`	`SendEmailOptions.SendStrategyEnum` Optional strategy to use when sending the email

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ATTACHMENTS`
`static String`	`SERIALIZED_NAME_BCC`
`static String`	`SERIALIZED_NAME_BODY`
`static String`	`SERIALIZED_NAME_CC`
`static String`	`SERIALIZED_NAME_CHARSET`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_IS_H_T_M_L`
`static String`	`SERIALIZED_NAME_REPLY_TO`
`static String`	`SERIALIZED_NAME_SEND_STRATEGY`
`static String`	`SERIALIZED_NAME_SUBJECT`
`static String`	`SERIALIZED_NAME_TEMPLATE`
`static String`	`SERIALIZED_NAME_TEMPLATE_VARIABLES`
`static String`	`SERIALIZED_NAME_TO`
`static String`	`SERIALIZED_NAME_TO_CONTACTS`
`static String`	`SERIALIZED_NAME_TO_GROUP`

Constructor Summary

Constructors
Constructor and Description

SendEmailOptions()

Constructors
Constructor and Description
`SendEmailOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendEmailOptions`	`addAttachmentsItem(String attachmentsItem)`
`SendEmailOptions`	`addBccItem(String bccItem)`
`SendEmailOptions`	`addCcItem(String ccItem)`
`SendEmailOptions`	`addToContactsItem(UUID toContactsItem)`
`SendEmailOptions`	`addToItem(String toItem)`
`SendEmailOptions`	`attachments(List<String> attachments)`
`SendEmailOptions`	`bcc(List<String> bcc)`
`SendEmailOptions`	`body(String body)`
`SendEmailOptions`	`cc(List<String> cc)`
`SendEmailOptions`	`charset(String charset)`
`boolean`	`equals(Object o)`
`SendEmailOptions`	`from(String from)`
`List<String>`	`getAttachments()` Optional list of attachment IDs to send with this email.
`List<String>`	`getBcc()` Optional list of bcc destination email addresses
`String`	`getBody()` Optional contents of email.
`List<String>`	`getCc()` Optional list of cc destination email addresses
`String`	`getCharset()` Optional charset
`String`	`getFrom()` Optional from address.
`Boolean`	`getIsHTML()` Optional HTML flag.
`String`	`getReplyTo()` Optional replyTo header
`SendEmailOptions.SendStrategyEnum`	`getSendStrategy()` Optional strategy to use when sending the email
`String`	`getSubject()` Optional email subject line
`UUID`	`getTemplate()` Optional template ID to use for body.
`Object`	`getTemplateVariables()` Optional map of template variables.
`List<String>`	`getTo()` List of destination email addresses.
`List<UUID>`	`getToContacts()` Optional list of contact IDs to send email to.
`UUID`	`getToGroup()` Optional contact group ID to send email to.
`int`	`hashCode()`
`SendEmailOptions`	`isHTML(Boolean isHTML)`
`SendEmailOptions`	`replyTo(String replyTo)`
`SendEmailOptions`	`sendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)`
`void`	`setAttachments(List<String> attachments)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setCc(List<String> cc)`
`void`	`setCharset(String charset)`
`void`	`setFrom(String from)`
`void`	`setIsHTML(Boolean isHTML)`
`void`	`setReplyTo(String replyTo)`
`void`	`setSendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)`
`void`	`setSubject(String subject)`
`void`	`setTemplate(UUID template)`
`void`	`setTemplateVariables(Object templateVariables)`
`void`	`setTo(List<String> to)`
`void`	`setToContacts(List<UUID> toContacts)`
`void`	`setToGroup(UUID toGroup)`
`SendEmailOptions`	`subject(String subject)`
`SendEmailOptions`	`template(UUID template)`
`SendEmailOptions`	`templateVariables(Object templateVariables)`
`SendEmailOptions`	`to(List<String> to)`
`SendEmailOptions`	`toContacts(List<UUID> toContacts)`
`SendEmailOptions`	`toGroup(UUID toGroup)`
`String`	`toString()`

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

- Field Detail
  - SERIALIZED_NAME_ATTACHMENTS
```
public static final String SERIALIZED_NAME_ATTACHMENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BCC
```
public static final String SERIALIZED_NAME_BCC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BODY
```
public static final String SERIALIZED_NAME_BODY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CC
```
public static final String SERIALIZED_NAME_CC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CHARSET
```
public static final String SERIALIZED_NAME_CHARSET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FROM
```
public static final String SERIALIZED_NAME_FROM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IS_H_T_M_L
```
public static final String SERIALIZED_NAME_IS_H_T_M_L
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REPLY_TO
```
public static final String SERIALIZED_NAME_REPLY_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEND_STRATEGY
```
public static final String SERIALIZED_NAME_SEND_STRATEGY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUBJECT
```
public static final String SERIALIZED_NAME_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEMPLATE
```
public static final String SERIALIZED_NAME_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEMPLATE_VARIABLES
```
public static final String SERIALIZED_NAME_TEMPLATE_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TO
```
public static final String SERIALIZED_NAME_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TO_CONTACTS
```
public static final String SERIALIZED_NAME_TO_CONTACTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TO_GROUP
```
public static final String SERIALIZED_NAME_TO_GROUP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SendEmailOptions
```
public SendEmailOptions()
```
- Method Detail
  - attachments
```
public SendEmailOptions attachments(List<String> attachments)
```
  - addAttachmentsItem
```
public SendEmailOptions addAttachmentsItem(String attachmentsItem)
```
  - getAttachments
```
@Nullable
public List<String> getAttachments()
```
    Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded.
    
    Returns:
    
    attachments
  - setAttachments
```
public void setAttachments(List<String> attachments)
```
  - bcc
```
public SendEmailOptions bcc(List<String> bcc)
```
  - addBccItem
```
public SendEmailOptions addBccItem(String bccItem)
```
  - getBcc
```
@Nullable
public List<String> getBcc()
```
    Optional list of bcc destination email addresses
    
    Returns:
    
    bcc
  - setBcc
```
public void setBcc(List<String> bcc)
```
  - body
```
public SendEmailOptions body(String body)
```
  - getBody
```
@Nullable
public String getBody()
```
    Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.
    
    Returns:
    
    body
  - setBody
```
public void setBody(String body)
```
  - cc
```
public SendEmailOptions cc(List<String> cc)
```
  - addCcItem
```
public SendEmailOptions addCcItem(String ccItem)
```
  - getCc
```
@Nullable
public List<String> getCc()
```
    Optional list of cc destination email addresses
    
    Returns:
    
    cc
  - setCc
```
public void setCc(List<String> cc)
```
  - charset
```
public SendEmailOptions charset(String charset)
```
  - getCharset
```
@Nullable
public String getCharset()
```
    Optional charset
    
    Returns:
    
    charset
  - setCharset
```
public void setCharset(String charset)
```
  - from
```
public SendEmailOptions from(String from)
```
  - getFrom
```
@Nullable
public String getFrom()
```
    Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain.
    
    Returns:
    
    from
  - setFrom
```
public void setFrom(String from)
```
  - isHTML
```
public SendEmailOptions isHTML(Boolean isHTML)
```
  - getIsHTML
```
@Nullable
public Boolean getIsHTML()
```
    Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients
    
    Returns:
    
    isHTML
  - setIsHTML
```
public void setIsHTML(Boolean isHTML)
```
  - replyTo
```
public SendEmailOptions replyTo(String replyTo)
```
  - getReplyTo
```
@Nullable
public String getReplyTo()
```
    Optional replyTo header
    
    Returns:
    
    replyTo
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
  - sendStrategy
```
public SendEmailOptions sendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)
```
  - getSendStrategy
```
@Nullable
public SendEmailOptions.SendStrategyEnum getSendStrategy()
```
    Optional strategy to use when sending the email
    
    Returns:
    
    sendStrategy
  - setSendStrategy
```
public void setSendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)
```
  - subject
```
public SendEmailOptions subject(String subject)
```
  - getSubject
```
@Nullable
public String getSubject()
```
    Optional email subject line
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - template
```
public SendEmailOptions template(UUID template)
```
  - getTemplate
```
@Nullable
public UUID getTemplate()
```
    Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.
    
    Returns:
    
    template
  - setTemplate
```
public void setTemplate(UUID template)
```
  - templateVariables
```
public SendEmailOptions templateVariables(Object templateVariables)
```
  - getTemplateVariables
```
@Nullable
public Object getTemplateVariables()
```
    Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.
    
    Returns:
    
    templateVariables
  - setTemplateVariables
```
public void setTemplateVariables(Object templateVariables)
```
  - to
```
public SendEmailOptions to(List<String> to)
```
  - addToItem
```
public SendEmailOptions addToItem(String toItem)
```
  - getTo
```
@Nullable
public List<String> getTo()
```
    List of destination email addresses. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating).
    
    Returns:
    
    to
  - setTo
```
public void setTo(List<String> to)
```
  - toContacts
```
public SendEmailOptions toContacts(List<UUID> toContacts)
```
  - addToContactsItem
```
public SendEmailOptions addToContactsItem(UUID toContactsItem)
```
  - getToContacts
```
@Nullable
public List<UUID> getToContacts()
```
    Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.
    
    Returns:
    
    toContacts
  - setToContacts
```
public void setToContacts(List<UUID> toContacts)
```
  - toGroup
```
public SendEmailOptions toGroup(UUID toGroup)
```
  - getToGroup
```
@Nullable
public UUID getToGroup()
```
    Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients
    
    Returns:
    
    toGroup
  - setToGroup
```
public void setToGroup(UUID toGroup)
```
  - 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 SendEmailOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ATTACHMENTS

SERIALIZED_NAME_BCC

SERIALIZED_NAME_BODY

SERIALIZED_NAME_CC

SERIALIZED_NAME_CHARSET

SERIALIZED_NAME_FROM

SERIALIZED_NAME_IS_H_T_M_L

SERIALIZED_NAME_REPLY_TO

SERIALIZED_NAME_SEND_STRATEGY

SERIALIZED_NAME_SUBJECT

SERIALIZED_NAME_TEMPLATE

SERIALIZED_NAME_TEMPLATE_VARIABLES

SERIALIZED_NAME_TO

SERIALIZED_NAME_TO_CONTACTS

SERIALIZED_NAME_TO_GROUP

Constructor Detail

SendEmailOptions

Method Detail

attachments

addAttachmentsItem

getAttachments

setAttachments

bcc

addBccItem

getBcc

setBcc

body

getBody

setBody

cc

addCcItem

getCc

setCc

charset

getCharset

setCharset

from

getFrom

setFrom

isHTML

getIsHTML

setIsHTML

replyTo

getReplyTo

setReplyTo

sendStrategy

getSendStrategy

setSendStrategy

subject

getSubject

setSubject

template

getTemplate

setTemplate

templateVariables

getTemplateVariables

setTemplateVariables

to

addToItem

getTo

setTo

toContacts

addToContactsItem

getToContacts

setToContacts

toGroup

getToGroup

setToGroup

equals

hashCode

toString