MailResponse

Method Summary
	compress(int imageMaxWidth) Reduces any attached images to the maximum width given.
	deleteAttachments(boolean keepImages) Deletes attachments if any, alternately keeping image-based attachments if keepImages=true.
	deleteMessage() Flags the remote message for deletion
File[]	getAttachments() Returns list of attachments for this email
String	getBody() Returns body of email. Can be null if email has not text body
String[]	getCC() Returns list of CC addresses for email. Can be empty if there is no CC for this email
String	getContentType() Returns content type of email body
String	getDeliveryAction() Returns delivery status action reported by MTA. This method has effect only for delivery status messages.
String	getFrom() Returns sender's address
String[]	getHeaderNames() Returns list of email header names
String	getHeaderValue(String headerName) Returns email header value for specified header. If specified header has several values, this is the first value. This method is shortcut for getHeaderValues('header')[0]
String[]	getHeaderValues(String headerName) Returns list of email header values for specified header
DataList	getHeaders() Returns a DataList of the mail headers.
MailMessage	getMessage() If this MailResponse is in reply to a sent message, this returns the original message.
Data	getMetaData() Returns information about this MailResponse to assist in processing it.
int	getSize() Returns the approximate size of this message in KB.
String	getSubject() Returns subject of email
String[]	getTo() Returns list of recipient addresses for this email.
boolean	isDelivered() Returns whether message was delivered or not. This method has effect only for delivery status messages. Note that result of delivery can be inaccurate if MTA reports with non-standard action in delivery status. You can use getDeliveryAction() to handle such situations
boolean	isFailure() Returns true if the MTA report is failure. See getDeliveryAction for report.
boolean	isRelayed() Returns true if the MTA report is relay. See getDeliveryAction for report.
boolean	isTextBody() Returns true if email has text body, false otherwise
Payload	toPayload() Returns the message as a Payload.
String	toString() Returns a description of this object

Method Detail

---

compress(int imageMaxWidth)

Reduces any attached images to the maximum width given.

Parameters:

• int   imageMaxWidth Required parameter. Maximum allowed size of parameter: 8000

Since: 04-22-2021

---

deleteAttachments(boolean keepImages)

Deletes attachments if any, alternately keeping image-based attachments if keepImages=true.

Parameters:

• boolean   keepImages Required parameter.

Since: 04-22-2021

---

deleteMessage()

Flags the remote message for deletion

Since: 12-06-2013

---

File[] getAttachments()

Returns list of attachments for this email

Returns:  File[]

Since: 08-25-2010

---

String getBody()

Returns body of email. Can be null if email has not text body

Returns:  String

Since: 08-25-2010

---

String[] getCC()

Returns list of CC addresses for email. Can be empty if there is no CC for this email

Returns:  String[]

Since: 08-25-2010

---

String getContentType()

Returns content type of email body

Returns:  String

Since: 08-25-2010

---

String getDeliveryAction()

Returns delivery status action reported by MTA. This method has effect only for delivery status messages.

Returns:  String

Since: 08-25-2010

---

String getFrom()

Returns sender's address

Returns:  String

Since: 08-25-2010

---

String[] getHeaderNames()

Returns list of email header names

Returns:  String[]

Since: 08-25-2010

---

String getHeaderValue(String headerName)

Returns email header value for specified header. If specified header has several values, this is the first value. This method is shortcut for getHeaderValues('header')[0]

Parameters:

• String   headerName  - header name. Required parameter.

Returns:  String

Since: 08-25-2010

---

String[] getHeaderValues(String headerName)

Returns list of email header values for specified header

Parameters:

• String   headerName  - header name. Required parameter.

Returns:  String[]

Since: 08-25-2010

---

DataList getHeaders()

Returns a DataList of the mail headers.

Returns:  DataList

DataList Name: headers
DataList Fields: name, value

Since: 04-24-2014

---

MailMessage getMessage()

If this MailResponse is in reply to a sent message, this returns the original message.

Returns:  MailMessage

Since: 12-11-2013

---

Data getMetaData()

Returns information about this MailResponse to assist in processing it.

Returns:  Data

Since: 06-19-2020

---

int getSize()

Returns the approximate size of this message in KB.

Returns:  int

Since: 04-22-2021

---

String getSubject()

Returns subject of email

Returns:  String

Since: 08-25-2010

---

String[] getTo()

Returns list of recipient addresses for this email.

Returns:  String[]

Since: 08-25-2010

---

boolean isDelivered()

Returns whether message was delivered or not. This method has effect only for delivery status messages. Note that result of delivery can be inaccurate if MTA reports with non-standard action in delivery status. You can use getDeliveryAction() to handle such situations

Returns:  boolean

Since: 08-25-2010

---

boolean isFailure()

Returns true if the MTA report is failure. See getDeliveryAction for report.

Returns:  boolean

Since: 08-25-2010

---

boolean isRelayed()

Returns true if the MTA report is relay. See getDeliveryAction for report.

Returns:  boolean

Since: 08-25-2010

---

boolean isTextBody()

Returns true if email has text body, false otherwise

Returns:  boolean

Since: 08-25-2010

---

Payload toPayload()

Returns the message as a Payload.

Returns:  Payload

Since: 04-22-2021

---

String toString()

Returns a description of this object

Returns:  String

Since: 08-25-2010