Back to API references

SOAP API method FaxMailingDestination_mailing

Description

The processed mailing that this destination belongs to. This can be an ProcessedEmailing, ProcessedFaxMailing or a ProcessedSmsMailing.

Parameters

Name Type Description
id * string Unique identifier (id) of the object FaxMailingDestination. The method only applies to the faxmailingdestination with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
processedfaxmailing Structure of type 'processedfaxmailing'
processedemailing Structure of type 'processedemailing'
processedsmsmailing Structure of type 'processedsmsmailing'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'processedfaxmailing'

Name Type Description
registerstatus. boolean Will the status be registered?
destinationcount int The number of destinations of the faxmailing.
id int Get the ID of the mailing.
timestamp timestamp The timestamp when the mailing was sent.
description string The description of the mailing.
personalized boolean Was this mailing personalized?.
nodoubles boolean Should the mailing be send to double mailaddresses?.
individual boolean Was this mailing sent to an individual?.
test boolean Was this mailing a test?
type string The type of the mailing.
messagesperminute int The max number of messages that are sent withing one minute
archived boolean The mailing is archived.
priority int Priority of the mailing. Higher value indicates higher priority.

Structure 'processedemailing'

Name Type Description
embedded boolean Are the images embeded?
contenttype string The contenttype of the mailing.
registerclicks string Will the clicks be registered?.
registerimpressions boolean Will the impressions be registered?.
registererrors boolean Will the errors be registered?.
registerabuses boolean Will the abuses be registered?.
followupsenabled boolean Are the followups still activated?.
clickcount int The total number of clicks.
impressioncount int The total number of impressions.
errorcount int The total number of errors.
abusecount int The total number of abuses that were registered
destinationcount int The total number of destinations.
emailingtype string Get the emailing type
id int Get the ID of the mailing.
timestamp timestamp The timestamp when the mailing was sent.
description string The description of the mailing.
personalized boolean Was this mailing personalized?.
nodoubles boolean Should the mailing be send to double mailaddresses?.
individual boolean Was this mailing sent to an individual?.
test boolean Was this mailing a test?
type string The type of the mailing.
messagesperminute int The max number of messages that are sent withing one minute
archived boolean The mailing is archived.
priority int Priority of the mailing. Higher value indicates higher priority.

Structure 'processedsmsmailing'

Name Type Description
registerstatus. boolean Will the status be registered?
destinationcount int The number of destination of the mailing.
id int Get the ID of the mailing.
timestamp timestamp The timestamp when the mailing was sent.
description string The description of the mailing.
personalized boolean Was this mailing personalized?.
nodoubles boolean Should the mailing be send to double mailaddresses?.
individual boolean Was this mailing sent to an individual?.
test boolean Was this mailing a test?
type string The type of the mailing.
messagesperminute int The max number of messages that are sent withing one minute
archived boolean The mailing is archived.
priority int Priority of the mailing. Higher value indicates higher priority.