NotifyAggregate Property

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

 upsfreightship.getNotifyAggregate(index, [callback])
 upsfreightship.setNotifyAggregate(index,  notifyAggregate, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getNotifyAggregate([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setNotifyAggregate([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows:

<EMailNotificationDetail>
  <PersonalMessage>personal_message</PersonalMessage>
  <Recipients> (this aggregate can be entered up to six times)
    <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType>
    <EMailAddress>recipient_email</EMailAddress>
    <NotifyOnShipment>true_or_false</NotifyOnShipment>
    <NotifyOnException>true_or_false</NotifyOnException>
    <NotifyOnDelivery>true_or_false</NotifyOnDelivery>
    <Format>format_type</Format>
    <Localization>
      <LanguageCode>language_code</LanguageCode>
    </Localization>
  </Recipients>
</EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients aggregate can be entered up to 6 times.

This setting is optional. If NotifyAggregate is not set it will be automatically created by the class.

UPS

For UPS, the following format is valid:

<Notification> (this aggregate can be entered up to three times)
  <NotificationCode>notification_code</NotificationCode>
  <EMailMessage>
    <EMailAddress>recipient_email</EMailAddress>  (this aggregate can be entered up to five times)
    <UndeliverableEMailAddress>undeliverable_email</UndeliverableEMailAddress>
    <FromEMailAddress>sender_email</FromEMailAddress>
    <FromName>sender_name</FromName>
    <Memo>message</Memo>
    <Subject>subject</Subject>
    <SubjectCode>subject_code</SubjectCode>
  </EMailMessage>
</Notification>

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From property of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.
• the email's subject. This is optional
• an optional subject code which specifies one of the following notification codes that will appear in the subject: "01" (Shipment Reference Number 1), "02" (Shipment Reference Number 2), "03" (package Reference Number 1), "04" (package Reference Number 2), and "08" (Subject Text) for Return Notification only.

Note that this property does not apply for USPS and CanadaPost.

The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String