SendEmailOptions (mailslurp-client-java 15.17.17 API)

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class SendEmailOptions
extends Object

Options for the email to be sent

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SendEmailOptions.CustomTypeAdapterFactory`
`static class`	`SendEmailOptions.SendStrategyEnum` How an email should be sent based on its recipients
`static class`	`SendEmailOptions.ValidateEmailAddressesEnum` Validate recipient email addresses before sending

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ADD_TRACKING_PIXEL`
`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_FILTER_BOUNCED_RECIPIENTS`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_HTML`
`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`
`static String`	`SERIALIZED_NAME_USE_INBOX_NAME`
`static String`	`SERIALIZED_NAME_VALIDATE_EMAIL_ADDRESSES`

Constructor Summary

Constructors
Constructor and Description

SendEmailOptions()

Constructors
Constructor and Description
`SendEmailOptions()`

Method Summary

All Methods Static 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`	`addTrackingPixel(Boolean addTrackingPixel)`
`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`	`filterBouncedRecipients(Boolean filterBouncedRecipients)`
`SendEmailOptions`	`from(String from)`
`static SendEmailOptions`	`fromJson(String jsonString)` Create an instance of SendEmailOptions given an JSON string
`Boolean`	`getAddTrackingPixel()` Add tracking pixel to email
`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
`Boolean`	`getFilterBouncedRecipients()` Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
`String`	`getFrom()` Optional from address.
`Boolean`	`getHtml()` Optional HTML flag to indicate that contents is HTML.
`Boolean`	`getIsHTML()` Optional HTML flag.
`String`	`getReplyTo()` Optional replyTo header
`SendEmailOptions.SendStrategyEnum`	`getSendStrategy()` How an email should be sent based on its recipients
`String`	`getSubject()` Optional email subject line
`UUID`	`getTemplate()` Optional template ID to use for body.
`Map<String,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.
`Boolean`	`getUseInboxName()` Use name of inbox as sender email address name.
`SendEmailOptions.ValidateEmailAddressesEnum`	`getValidateEmailAddresses()` Validate recipient email addresses before sending
`int`	`hashCode()`
`SendEmailOptions`	`html(Boolean html)`
`SendEmailOptions`	`isHTML(Boolean isHTML)`
`SendEmailOptions`	`putTemplateVariablesItem(String key, Object templateVariablesItem)`
`SendEmailOptions`	`replyTo(String replyTo)`
`SendEmailOptions`	`sendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)`
`void`	`setAddTrackingPixel(Boolean addTrackingPixel)`
`void`	`setAttachments(List<String> attachments)`
`void`	`setBcc(List<String> bcc)`
`void`	`setBody(String body)`
`void`	`setCc(List<String> cc)`
`void`	`setCharset(String charset)`
`void`	`setFilterBouncedRecipients(Boolean filterBouncedRecipients)`
`void`	`setFrom(String from)`
`void`	`setHtml(Boolean html)`
`void`	`setIsHTML(Boolean isHTML)`
`void`	`setReplyTo(String replyTo)`
`void`	`setSendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)`
`void`	`setSubject(String subject)`
`void`	`setTemplate(UUID template)`
`void`	`setTemplateVariables(Map<String,Object> templateVariables)`
`void`	`setTo(List<String> to)`
`void`	`setToContacts(List<UUID> toContacts)`
`void`	`setToGroup(UUID toGroup)`
`void`	`setUseInboxName(Boolean useInboxName)`
`void`	`setValidateEmailAddresses(SendEmailOptions.ValidateEmailAddressesEnum validateEmailAddresses)`
`SendEmailOptions`	`subject(String subject)`
`SendEmailOptions`	`template(UUID template)`
`SendEmailOptions`	`templateVariables(Map<String,Object> templateVariables)`
`SendEmailOptions`	`to(List<String> to)`
`SendEmailOptions`	`toContacts(List<UUID> toContacts)`
`SendEmailOptions`	`toGroup(UUID toGroup)`
`String`	`toJson()` Convert an instance of SendEmailOptions to an JSON string
`String`	`toString()`
`SendEmailOptions`	`useInboxName(Boolean useInboxName)`
`SendEmailOptions`	`validateEmailAddresses(SendEmailOptions.ValidateEmailAddressesEnum validateEmailAddresses)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found

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

- Field Detail
  - 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
  - SERIALIZED_NAME_TO
```
public static final String SERIALIZED_NAME_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FROM
```
public static final String SERIALIZED_NAME_FROM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CC
```
public static final String SERIALIZED_NAME_CC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BCC
```
public static final String SERIALIZED_NAME_BCC
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUBJECT
```
public static final String SERIALIZED_NAME_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REPLY_TO
```
public static final String SERIALIZED_NAME_REPLY_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BODY
```
public static final String SERIALIZED_NAME_BODY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HTML
```
public static final String SERIALIZED_NAME_HTML
```
    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_CHARSET
```
public static final String SERIALIZED_NAME_CHARSET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ATTACHMENTS
```
public static final String SERIALIZED_NAME_ATTACHMENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEMPLATE_VARIABLES
```
public static final String SERIALIZED_NAME_TEMPLATE_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEMPLATE
```
public static final String SERIALIZED_NAME_TEMPLATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEND_STRATEGY
```
public static final String SERIALIZED_NAME_SEND_STRATEGY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USE_INBOX_NAME
```
public static final String SERIALIZED_NAME_USE_INBOX_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ADD_TRACKING_PIXEL
```
public static final String SERIALIZED_NAME_ADD_TRACKING_PIXEL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS
```
public static final String SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALIDATE_EMAIL_ADDRESSES
```
public static final String SERIALIZED_NAME_VALIDATE_EMAIL_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - SendEmailOptions
```
public SendEmailOptions()
```
- Method Detail
  - 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)
```
  - to
```
public SendEmailOptions to(List<String> to)
```
  - addToItem
```
public SendEmailOptions addToItem(String toItem)
```
  - getTo
```
@Nullable
public List<String> getTo()
```
    List of destination email addresses. Each email address must be RFC 5322 format. 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). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.
    
    Returns:
    
    to
  - setTo
```
public void setTo(List<String> to)
```
  - from
```
public SendEmailOptions from(String from)
```
  - getFrom
```
@Nullable
public String getFrom()
```
    Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.
    
    Returns:
    
    from
  - setFrom
```
public void setFrom(String from)
```
  - 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)
```
  - 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)
```
  - subject
```
public SendEmailOptions subject(String subject)
```
  - getSubject
```
@Nullable
public String getSubject()
```
    Optional email subject line
    
    Returns:
    
    subject
  - setSubject
```
public void setSubject(String subject)
```
  - replyTo
```
public SendEmailOptions replyTo(String replyTo)
```
  - getReplyTo
```
@Nullable
public String getReplyTo()
```
    Optional replyTo header
    
    Returns:
    
    replyTo
  - setReplyTo
```
public void setReplyTo(String replyTo)
```
  - 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)
```
  - html
```
public SendEmailOptions html(Boolean html)
```
  - getHtml
```
@Nullable
public Boolean getHtml()
```
    Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.)
    
    Returns:
    
    html
  - setHtml
```
public void setHtml(Boolean html)
```
  - 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)
```
  - charset
```
public SendEmailOptions charset(String charset)
```
  - getCharset
```
@Nullable
public String getCharset()
```
    Optional charset
    
    Returns:
    
    charset
  - setCharset
```
public void setCharset(String charset)
```
  - 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 via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods.
    
    Returns:
    
    attachments
  - setAttachments
```
public void setAttachments(List<String> attachments)
```
  - templateVariables
```
public SendEmailOptions templateVariables(Map<String,Object> templateVariables)
```
  - putTemplateVariablesItem
```
public SendEmailOptions putTemplateVariablesItem(String key,
                                                 Object templateVariablesItem)
```
  - getTemplateVariables
```
@Nullable
public Map<String,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(Map<String,Object> templateVariables)
```
  - 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)
```
  - sendStrategy
```
public SendEmailOptions sendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)
```
  - getSendStrategy
```
@Nullable
public SendEmailOptions.SendStrategyEnum getSendStrategy()
```
    How an email should be sent based on its recipients
    
    Returns:
    
    sendStrategy
  - setSendStrategy
```
public void setSendStrategy(SendEmailOptions.SendStrategyEnum sendStrategy)
```
  - useInboxName
```
public SendEmailOptions useInboxName(Boolean useInboxName)
```
  - getUseInboxName
```
@Nullable
public Boolean getUseInboxName()
```
    Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name.
    
    Returns:
    
    useInboxName
  - setUseInboxName
```
public void setUseInboxName(Boolean useInboxName)
```
  - addTrackingPixel
```
public SendEmailOptions addTrackingPixel(Boolean addTrackingPixel)
```
  - getAddTrackingPixel
```
@Nullable
public Boolean getAddTrackingPixel()
```
    Add tracking pixel to email
    
    Returns:
    
    addTrackingPixel
  - setAddTrackingPixel
```
public void setAddTrackingPixel(Boolean addTrackingPixel)
```
  - filterBouncedRecipients
```
public SendEmailOptions filterBouncedRecipients(Boolean filterBouncedRecipients)
```
  - getFilterBouncedRecipients
```
@Nullable
public Boolean getFilterBouncedRecipients()
```
    Filter recipients to remove any bounced recipients from to, bcc, and cc before sending
    
    Returns:
    
    filterBouncedRecipients
  - setFilterBouncedRecipients
```
public void setFilterBouncedRecipients(Boolean filterBouncedRecipients)
```
  - validateEmailAddresses
```
public SendEmailOptions validateEmailAddresses(SendEmailOptions.ValidateEmailAddressesEnum validateEmailAddresses)
```
  - getValidateEmailAddresses
```
@Nullable
public SendEmailOptions.ValidateEmailAddressesEnum getValidateEmailAddresses()
```
    Validate recipient email addresses before sending
    
    Returns:
    
    validateEmailAddresses
  - setValidateEmailAddresses
```
public void setValidateEmailAddresses(SendEmailOptions.ValidateEmailAddressesEnum validateEmailAddresses)
```
  - 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
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to SendEmailOptions
  - fromJson
```
public static SendEmailOptions fromJson(String jsonString)
                                 throws IOException
```
    Create an instance of SendEmailOptions given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SendEmailOptions
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to SendEmailOptions
  - toJson
```
public String toJson()
```
    Convert an instance of SendEmailOptions to an JSON string
    
    Returns:
    
    JSON string

Class SendEmailOptions

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TO_CONTACTS

SERIALIZED_NAME_TO_GROUP

SERIALIZED_NAME_TO

SERIALIZED_NAME_FROM

SERIALIZED_NAME_CC

SERIALIZED_NAME_BCC

SERIALIZED_NAME_SUBJECT

SERIALIZED_NAME_REPLY_TO

SERIALIZED_NAME_BODY

SERIALIZED_NAME_HTML

SERIALIZED_NAME_IS_H_T_M_L

SERIALIZED_NAME_CHARSET

SERIALIZED_NAME_ATTACHMENTS

SERIALIZED_NAME_TEMPLATE_VARIABLES

SERIALIZED_NAME_TEMPLATE

SERIALIZED_NAME_SEND_STRATEGY

SERIALIZED_NAME_USE_INBOX_NAME

SERIALIZED_NAME_ADD_TRACKING_PIXEL

SERIALIZED_NAME_FILTER_BOUNCED_RECIPIENTS

SERIALIZED_NAME_VALIDATE_EMAIL_ADDRESSES

openapiFields

openapiRequiredFields

Constructor Detail

SendEmailOptions

Method Detail

toContacts

addToContactsItem

getToContacts

setToContacts

toGroup

getToGroup

setToGroup

to

addToItem

getTo

setTo

from

getFrom

setFrom

cc

addCcItem

getCc

setCc

bcc

addBccItem

getBcc

setBcc

subject

getSubject

setSubject

replyTo

getReplyTo

setReplyTo

body

getBody

setBody

html

getHtml

setHtml

isHTML

getIsHTML

setIsHTML

charset

getCharset

setCharset

attachments

addAttachmentsItem

getAttachments

setAttachments

templateVariables

putTemplateVariablesItem

getTemplateVariables

setTemplateVariables