Class SpmShipment
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.
Syntax
Constructors
SpmShipment()
Initializes a new instance of the SpmShipment class.
Declaration
SpmShipmentMethods
addList(Integer)
Adds a list of recipients to the shipment.
Declaration
Void addList(Integer list)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | list | The ID of the list to add. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
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.
Declaration
Void addListCRMProject(Integer id)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id | ID of list to add. |
Returns
| Type | Description |
|---|---|
| Void |
addListCRMSelection(Integer)
Adds a CRM selection to shipment.
Declaration
Void addListCRMSelection(Integer id)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id | ID of selection to add. |
Returns
| Type | Description |
|---|---|
| Void |
addListSelection(Integer)
Adds a selection list to shipment.
Declaration
Void addListSelection(Integer id)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id | ID of selection list to add. |
Returns
| Type | Description |
|---|---|
| Void |
addListTicketSelection(Integer)
Adds a ticket selection list to shipment.
Declaration
Void addListTicketSelection(Integer id)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | id | ID of list to add. |
Returns
| Type | Description |
|---|---|
| Void |
save()
Saves the SpmShipment object.
Declaration
save()Returns
| Type | Description |
|---|---|
| Integer | ID of the SpmShipment object. |
Remarks
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.
Declaration
Void setDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | A text which describes this shipment. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
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.
Declaration
Void setFolderId(Integer folderId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | folderId | The ID of the folder that this shipment will be stored in. A value of -1 indicates that it should be stored in the root folder. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
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.
Declaration
Void setFrom(String from)Parameters
| Type | Name | Description |
|---|---|---|
| String | from | A string denoting the from address. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
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.
Declaration
Void setMessage(Integer messageId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | messageId | The ID of a valid SpmMessage object. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
You must specify this for a shipment to be valid.
setSendRate(Integer)
Sets the rate of outgoing emails per minute for this shipment.
Declaration
Void setSendRate(Integer sendRate)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | sendRate | The number of emails per minute sent from Service. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
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.
Declaration
Void setStartDate(DateTime start)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | start | The start date and time for this shipment. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If you specify a past date the shipment will be started immediately.