Email

Type	Interface input object
Description	Object that represents an email message sent to the Email Capture plug-in implementation. Use the methods available to the Email object to retrieve the following properties: Sender and recipient headers. The From, To, Cc, and ReplyTo properties of the email message as an Address object. See getFrom(), getTo(), getCc(), and getReplyTo(). Date. Date the email message was sent. See getSentDate(). Subject field and email body. The value of the subject field and the value of the email body as a text string or HTML string. See getSubject(), getTextBody(), and getHtmlBody(). Attachment. An array of all attachments as Attachment objects. See getAttachments().
Methods	getFrom() getTo() getCc() getReplyTo() getSentDate() getSubject() getTextBody() getHtmlBody() getAttachments()
Parent Object(s)	n/a
Child Object(s)	Address Attachment

getFrom()

Function Declaration	Address getFrom()
Type	Object method
Description	Returns an array of Address objects that represent the from header on an email message sent to an Email Capture plug-in implementation.
Returns	Address[]
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var fromAddress = email.getFrom();
      logAddress('from', fromAddress);
      ...
   } 

        

getTo()

Function Declaration	Address getTo()
Type	Object method
Description	Returns an array of Address objects that represent the to header on an email message sent to an Email Capture plug-in implementation.
Returns	Address
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var to = email.getTo();
      for (var indexTo in to)
      {
         logAddress('to', to[indexTo]);
      }
      ...
   } 

        

getCc()

Function Declaration	Address getCc()
Type	Object method
Description	Returns an array of Address objects that represent the cc header on an email message sent to an Email Capture plug-in implementation.
Returns	Address
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var cc = email.getCc();
      for (var indexCc in cc)
      {
         logAddress('cc', cc[indexCc]);
      }
      ...
   } 

        

getReplyTo()

Function Declaration	Address getReplyTo()
Type	Object method
Description	Returns an Address object that represents the reply-to header on an email message sent to an Email Capture plug-in implementation.
Returns	Address
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var replyAddr = email.getReplyTo();
      ...
   } 

        

getSentDate()

Function Declaration	Date getSentDate()
Type	Object method
Description	Returns a JavaScript Date object that represents the sent date on an email message sent to an Email Capture plug-in implementation.
Returns	Date
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var date = email.getSentDate();
      ...
   } 

        

getSubject()

Function Declaration	string getSubject()
Type	Object method
Description	Returns a string that represents the subject field in an email message sent to an Email Capture plug-in implementation. Returns an empty string if the email message does not contain text in the subject field.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var subject = email.getSubject();
      ...
   } 

        

getTextBody()

Function Declaration	string getTextBody()
Type	Object method
Description	Returns a string that represents the plaintext part of the body of an email message sent to an Email Capture plug-in implementation. Returns null if there is no text in the body of the email message. If there is text in the body field, this method returns a string regardless of the format of the email message. For example, if an email message was sent in HTML format, the string contains the text of the body field without any HTML formatting.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      log('text body', email.getTextBody());
      ...
   } 

        

getHtmlBody()

Function Declaration	string getHtmlBody()
Type	Object method
Description	Returns a string that represents the HTML content included in the body field of an email message sent to an Email Capture plug-in implementation. Returns null if there is no HTML content in the body of the email message. For example, this method returns null if the body of an email message contains plain text with no formatting.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      log('html body', email.getHtmlBody());
      ...
   } 

        

getAttachments()

Function Declaration	Attachment[] getAttachments()
Type	Object method
Description	Returns an array of Attachment objects that represent the attachments included in an email message. Returns an empty array of the email message if does not include an attachment. Use the methods available to the Attachment object to get the name, type, and value of each attachment.
Returns	Attachment[]
Since	2015.1
Input Parameters	None.
Parent object	Email

Example

             function process(email) {
      ...
      var attachments = email.getAttachments();
      for (var indexAtt in attachments)
      {
         logAttachment('att', attachments[indexAtt]);
      }
      ...
   } 

        

Related Topics

• Email Capture Plug-in Interface Description
• process(email)
• Address
• Attachment

General Notices