SendEmailApi.APIsendEmailRequest (infobip-api-java-client 3.2.0 API)

java.lang.Object
- com.infobip.api.SendEmailApi.APIsendEmailRequest

Enclosing class:: SendEmailApi

public class SendEmailApi.APIsendEmailRequest
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendEmailApi.APIsendEmailRequest`	`attachment(File attachment)` Set attachment
`SendEmailApi.APIsendEmailRequest`	`bcc(String bcc)` Set bcc
`okhttp3.Call`	`buildCall(ApiCallback _callback)` Build call for sendEmail.
`SendEmailApi.APIsendEmailRequest`	`bulkId(String bulkId)` Set bulkId
`SendEmailApi.APIsendEmailRequest`	`callbackData(String callbackData)` Set callbackData
`SendEmailApi.APIsendEmailRequest`	`cc(String cc)` Set cc
`SendEmailApi.APIsendEmailRequest`	`defaultplaceholders(String defaultplaceholders)` Set defaultplaceholders
`EmailSendResponse`	`execute()` Execute sendEmail request.
`okhttp3.Call`	`executeAsync(ApiCallback<EmailSendResponse> _callback)` Execute sendEmail request (asynchronously).
`ApiResponse<EmailSendResponse>`	`executeWithHttpInfo()` Execute sendEmail request with HTTP info returned.
`SendEmailApi.APIsendEmailRequest`	`HTML(String HTML)` Set HTML
`SendEmailApi.APIsendEmailRequest`	`inlineImage(File inlineImage)` Set inlineImage
`SendEmailApi.APIsendEmailRequest`	`intermediateReport(Boolean intermediateReport)` Set intermediateReport
`SendEmailApi.APIsendEmailRequest`	`landingPageId(String landingPageId)` Set landingPageId
`SendEmailApi.APIsendEmailRequest`	`landingPagePlaceholders(String landingPagePlaceholders)` Set landingPagePlaceholders
`SendEmailApi.APIsendEmailRequest`	`messageId(String messageId)` Set messageId
`SendEmailApi.APIsendEmailRequest`	`notifyContentType(String notifyContentType)` Set notifyContentType
`SendEmailApi.APIsendEmailRequest`	`notifyUrl(String notifyUrl)` Set notifyUrl
`SendEmailApi.APIsendEmailRequest`	`preserverecipients(Boolean preserverecipients)` Set preserverecipients
`SendEmailApi.APIsendEmailRequest`	`replyto(String replyto)` Set replyto
`SendEmailApi.APIsendEmailRequest`	`sendAt(OffsetDateTime sendAt)` Set sendAt
`SendEmailApi.APIsendEmailRequest`	`templateid(Integer templateid)` Set templateid
`SendEmailApi.APIsendEmailRequest`	`text(String text)` Set text
`SendEmailApi.APIsendEmailRequest`	`track(Boolean track)` Set track
`SendEmailApi.APIsendEmailRequest`	`trackclicks(Boolean trackclicks)` Set trackclicks
`SendEmailApi.APIsendEmailRequest`	`trackingUrl(String trackingUrl)` Set trackingUrl
`SendEmailApi.APIsendEmailRequest`	`trackopens(Boolean trackopens)` Set trackopens

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

- Method Detail
  - cc
```
public SendEmailApi.APIsendEmailRequest cc(String cc)
```
    Set cc
    
    Parameters:
    
    cc - CC recipient email address. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - bcc
```
public SendEmailApi.APIsendEmailRequest bcc(String bcc)
```
    Set bcc
    
    Parameters:
    
    bcc - BCC recipient email address. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - text
```
public SendEmailApi.APIsendEmailRequest text(String text)
```
    Set text
    
    Parameters:
    
    text - Body of message. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - bulkId
```
public SendEmailApi.APIsendEmailRequest bulkId(String bulkId)
```
    Set bulkId
    
    Parameters:
    
    bulkId - The ID uniquely identifies the sent Email request. This filter will enable you to query delivery reports for all the messages using just one request. You will receive a bulkId in the response after sending an Email request. If you don't set your own bulkId, unique ID will be generated by our system and returned in the API response. (Optional Field) (optional)
    
    Returns:
    
    APIsendEmailRequest
  - messageId
```
public SendEmailApi.APIsendEmailRequest messageId(String messageId)
```
    Set messageId
    
    Parameters:
    
    messageId - The ID that uniquely identifies the message sent for a recipient. (Optional Field) (optional)
    
    Returns:
    
    APIsendEmailRequest
  - templateid
```
public SendEmailApi.APIsendEmailRequest templateid(Integer templateid)
```
    Set templateid
    
    Parameters:
    
    templateid - Template identifier based on which the email message is generated. The template is created over Infobip web interface. If templateId is present then html and text values are ignored. NOTE : This field supports value of broadcast templateId only. Content templateId is not supported. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - attachment
```
public SendEmailApi.APIsendEmailRequest attachment(File attachment)
```
    Set attachment
    
    Parameters:
    
    attachment - File attachment (optional)
    
    Returns:
    
    APIsendEmailRequest
  - inlineImage
```
public SendEmailApi.APIsendEmailRequest inlineImage(File inlineImage)
```
    Set inlineImage
    
    Parameters:
    
    inlineImage - Using an inline image, it is possible to insert the image file inside the HTML code of the email by using cid:FILENAME instead of providing any external link to image. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - HTML
```
public SendEmailApi.APIsendEmailRequest HTML(String HTML)
```
    Set HTML
    
    Parameters:
    
    HTML - HTML body of the message. If HTML and text fields are present, text field will be ignored and HTML will be delivered as message body. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - replyto
```
public SendEmailApi.APIsendEmailRequest replyto(String replyto)
```
    Set replyto
    
    Parameters:
    
    replyto - Email address to which recipients of the email can reply. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - defaultplaceholders
```
public SendEmailApi.APIsendEmailRequest defaultplaceholders(String defaultplaceholders)
```
    Set defaultplaceholders
    
    Parameters:
    
    defaultplaceholders - Default placeholder values used for all recipients. The values are used to generate the email message. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - preserverecipients
```
public SendEmailApi.APIsendEmailRequest preserverecipients(Boolean preserverecipients)
```
    Set preserverecipients
    
    Parameters:
    
    preserverecipients - This parameter enables preserving To recipients for an email when value is true, default value is false for this parameter. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - trackingUrl
```
public SendEmailApi.APIsendEmailRequest trackingUrl(String trackingUrl)
```
    Set trackingUrl
    
    Parameters:
    
    trackingUrl - The URL on your callback server on which the open and click notifications will be sent. If you are passing this parameter then track=true will be assigned, you don't need to pass track=true separately. See the section \\\"Tracking Notifications\\\" below for details. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - trackclicks
```
public SendEmailApi.APIsendEmailRequest trackclicks(Boolean trackclicks)
```
    Set trackclicks
    
    Parameters:
    
    trackclicks - This parameter enables or disables track click feature. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - trackopens
```
public SendEmailApi.APIsendEmailRequest trackopens(Boolean trackopens)
```
    Set trackopens
    
    Parameters:
    
    trackopens - This parameter enables or disables track open feature. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - track
```
public SendEmailApi.APIsendEmailRequest track(Boolean track)
```
    Set track
    
    Parameters:
    
    track - Enable or disable open and click tracking.Default value is true. Passing true will only enable tracking and the statistics would be visible in web interface alone. This can be explicitly overridden by trackopens and trackclikcs. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - callbackData
```
public SendEmailApi.APIsendEmailRequest callbackData(String callbackData)
```
    Set callbackData
    
    Parameters:
    
    callbackData - Additional client data that will be sent on the notifyUrl. The maximum value is 4000 characters. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - intermediateReport
```
public SendEmailApi.APIsendEmailRequest intermediateReport(Boolean intermediateReport)
```
    Set intermediateReport
    
    Parameters:
    
    intermediateReport - The real-time Intermediate delivery report that will be sent on your callback server. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - notifyUrl
```
public SendEmailApi.APIsendEmailRequest notifyUrl(String notifyUrl)
```
    Set notifyUrl
    
    Parameters:
    
    notifyUrl - The URL on your callback server on which the Delivery report will be sent. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - notifyContentType
```
public SendEmailApi.APIsendEmailRequest notifyContentType(String notifyContentType)
```
    Set notifyContentType
    
    Parameters:
    
    notifyContentType - Preferred Delivery report content type. Can be application/json or application/xml. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - sendAt
```
public SendEmailApi.APIsendEmailRequest sendAt(OffsetDateTime sendAt)
```
    Set sendAt
    
    Parameters:
    
    sendAt - To schedule message at a given time in future. Time provided should be in UTC in following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - landingPagePlaceholders
```
public SendEmailApi.APIsendEmailRequest landingPagePlaceholders(String landingPagePlaceholders)
```
    Set landingPagePlaceholders
    
    Parameters:
    
    landingPagePlaceholders - Personalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - landingPageId
```
public SendEmailApi.APIsendEmailRequest landingPageId(String landingPageId)
```
    Set landingPageId
    
    Parameters:
    
    landingPageId - Opt out landing page which will be used and displayed once end user clicks unsubscribe link. If not present default opt out landing page will be displayed. Create landing page on IB’s portal and use last 6 digits from URL to use that opt out page. (optional)
    
    Returns:
    
    APIsendEmailRequest
  - buildCall
```
public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException
```
    Build call for sendEmail.
    
    Parameters:
    
    _callback - ApiCallback API callback
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - execute
```
public EmailSendResponse execute()
                          throws ApiException
```
    Execute sendEmail request.
    
    Returns:
    
    EmailSendResponse
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - executeWithHttpInfo
```
public ApiResponse<EmailSendResponse> executeWithHttpInfo()
                                                   throws ApiException
```
    Execute sendEmail request with HTTP info returned.
    
    Returns:
    
    ApiResponse<EmailSendResponse>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - executeAsync
```
public okhttp3.Call executeAsync(ApiCallback<EmailSendResponse> _callback)
                          throws ApiException
```
    Execute sendEmail request (asynchronously).
    
    Parameters:
    
    _callback - The callback to be executed when the API call finishes
    
    Returns:
    
    The request call
    
    Throws:
    
    ApiException - If fail to process the API call, e.g. serializing the request body object

Class SendEmailApi.APIsendEmailRequest

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cc

bcc

text

bulkId

messageId

templateid

attachment

inlineImage

HTML

replyto

defaultplaceholders

preserverecipients

trackingUrl

trackclicks

trackopens

track

callbackData

intermediateReport

notifyUrl

notifyContentType

sendAt

landingPagePlaceholders

landingPageId

buildCall

execute

executeWithHttpInfo

executeAsync