Attachment

Type	Object
Description	Object that represents an attachment in an email message sent to an Email Capture plug-in implementation. Each Attachment object contains properties for the attachment file name, attachment type, and the value of the attachment file.
Methods	getName() getType() getValue()
Parent Object(s)	Email
Child Object(s)	n/a

getName()

Function Declaration	string getName()
Type	Object method
Description	Returns the file name for an attachment in an email message.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Attachment

Example

             function process(email) {
      ...
      var attachments = email.getAttachments();
      for (var indexAtt in attachments)
      {
         logAttachment('att', attachments[indexAtt]);
      }
      ...
      
      function logAttachment(label, attachment)
      {
         nlapiLogExecution('DEBUG', 'Att - ' + label + ': ' + attachment.getName() + ', ' + attachment.getType());
         nlapiLogExecution('DEBUG', 'Att - ' + label + ' - value: ' + attachment.getValue());
      }
       ...
   } 

        

getType()

Function Declaration	string getType()
Type	Object method
Description	Returns the file type of an attachment in an email message as a string. For example, this method returns PLAINTEXT, PDF, and MISCBINARY for text, PDF, and Microsoft Word files, respectively.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Attachment

Example

             function process(email) {
      ...
      var attachments = email.getAttachments();
      for (var indexAtt in attachments)
      {
         logAttachment('att', attachments[indexAtt]);
      }
      ...
      
      function logAttachment(label, attachment)
      {
         nlapiLogExecution('DEBUG', 'Att - ' + label + ': ' + attachment.getName() + ', ' + attachment.getType());
         nlapiLogExecution('DEBUG', 'Att - ' + label + ' - value: ' + attachment.getValue());
      }
       ...
   } 

        

getValue()

Function Declaration	string getValue()
Type	Object method
Description	Returns a text string for a text file attachment or base-64 encoded string for binary attachment types of an email message. You can use getType() to define the behavior of the plug-in implementation depending on the file type of the attachment.
Returns	string
Since	2015.1
Input Parameters	None.
Parent object	Attachment

Example

             function process(email) {
      ...
      var attachments = email.getAttachments();
      for (var indexAtt in attachments)
      {
         logAttachment('att', attachments[indexAtt]);
      }
      ...
      
      function logAttachment(label, attachment)
      {
         nlapiLogExecution('DEBUG', 'Att - ' + label + ': ' + attachment.getName() + ', ' + attachment.getType());
         nlapiLogExecution('DEBUG', 'Att - ' + label + ' - value: ' + attachment.getValue());
      }
       ...
   } 

        

Related Topics

Email Capture Plug-in Interface Description

process(email)

Email

Address

General Notices