Notify Property
Collection of recipients to get notified.
Syntax
[VB.NET] Public Property Notify As NotifyDetailList
[C#] public NotifyDetailList Notify {get;}
Remarks
The Notify property is required to be provided in requests for:
- shipment status (notification(s) to be sent via e-mail) - when the RequestEmailNotification method is called, or
- Signature Proof of Delivery (SPOD) to be sent via fax - - when the FaxProofOfDelivery method is called.
In the first scenario, When a request will be made for e-mail notifications:
For each idx = 0 to NotifyCount - 1, this must be set to an instance of the NotifyDetail type, which will contain specific information about the recipient to be notified via email, before calling the RequestEmailNotification method. See the NotifyDetail type for more information.
Each recipient to receive an e-mail notification has an Email (required), RecipientType (optional), and NotificationFlags (optional) tied to it.
For instance, if the recipients' list consists of one recipient:
component.Notify[0].Email = "test@test.com"; component.Notify[0].RecipientType = rtShipper;
In the second scenario, When a request will be made for Signature Proof of Delivery (SPOD) via fax (when the FaxProofOfDelivery method is called): the NotifyCount will automatically be set to 1. In this case, the Notify should be set to an instance of the NotifyDetail type, which will contain only the Name and Fax of the recipient to get the SPOD via fax.
component.Recipients[0].Name = "John Doe"; component.Recipients[0].Fax ="1234567890";
This property is not available at design time.