Skip to main content
Denotes a shipment in the eMarketeer module. A SpmShipment object will be responsible for the actual shipment. This object needs a SpmStaticList and a SpmMessage object as input.

Constructors

SpmShipment()

Initializes a new instance of the SpmShipment class.

Methods

addList(Integer)

Adds a list of recipients to the shipment.
Returns: CRMScript.Global.Void
You can add more than one list. If two or more of these lists contains the same address, only one email will be sent to this recipient. The lists can be of either dynamic or static types.

addListCRMProject(Integer)

Adds a CRM list of project members to shipment.
Returns: CRMScript.Global.Void

addListCRMSelection(Integer)

Adds a CRM selection to shipment.
Returns: CRMScript.Global.Void

addListSelection(Integer)

Adds a selection list to shipment.
Returns: CRMScript.Global.Void

addListTicketSelection(Integer)

Adds a ticket selection list to shipment.
Returns: CRMScript.Global.Void

save()

Saves the SpmShipment object.
Returns: CRMScript.Global.Integer - ID of the SpmShipment object.
Warning: this will activate the shipment and it will be executed at the indicated start date.

setDescription(String)

Sets the descriptive text of the SpmShipment.
Returns: CRMScript.Global.Void
It is not used in the outgoing email, but will be visible when listed in Service.

setFolderId(Integer)

Sets the folder that this SpmShipment will be stored in.
Returns: CRMScript.Global.Void
If you specify a folder ID that does not exist, the shipment will not be visible through Service.

setFrom(String)

Sets the from address of the outgoing email.
Returns: CRMScript.Global.Void
This should be an email address that is imported by Service unless you have other reasons to do so.

setMessage(Integer)

Sets the ID of the SpmMessage object that will be used for the shipment.
Returns: CRMScript.Global.Void
You must specify this for a shipment to be valid.

setSendRate(Integer)

Sets the rate of outgoing emails per minute for this shipment.
Returns: CRMScript.Global.Void
Required for a shipment! If you specify a value larger than Service actually can handle, it will send at full speed.Warning: this can lower performance of both eJournal and your mail server if set too high.

setStartDate(DateTime)

Sets the date and time when the shipment will be started.
Returns: CRMScript.Global.Void
If you specify a past date the shipment will be started immediately.