SOAP API method Account_emailingTemplates

Description

An emailingtemplate is a template for sending an e-mail. The emailingtemplate can not send by itself, but an emailingdocument can be send. This method returns all the emailingtemplates of this account.

Parameters

Name	Type	Description
options	Collection of type 'options'	Array with search options where the following fields are allowed: The following fields are allowed: - modifiedfromdate: string date in mysql format to show all templates modified from this date - modifiedtodate: string date in mysql format to show all templates modified to this date - archived: boolean to determine whether to filter out archived templates or not - folder: integer with a folder id to only return templates in this folder - keyword: search templates by keyword (non strict) - order: string indicating how the templates should be ordered. Possible values are 'name', 'id', 'created', and 'modified'. Default is 'name'.
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
start	int	Optional parameter that specifies the first element in the collection to be returned. If this parameter is omitted, the first entry in the collection is also the first entry that is returned. Use this parameter is you only want to retrieve a part of the collection.
length	int	Optional parameter that can be used to limit the number of returned elements of this method. If this parameter is omitted, all entries in the collection are returned. If you specify a length, this method will not return more than the specified number of entries.
allproperties	boolean	Optional parameter that specifies if only a limited number of properties of the requested objects are returned or, when this parameter is set to true, whether all properties of the objects are returned.
* required parameters

Return values

Name	Type	Description
start	int	The first element of the collection
length	int	The number of elements that are returned
total	int	The total available elements of the collection
allproperties	int	When this element is available in the return value, the objects in the collection are fully filled, otherwise only a limited number of fields from the objects are filled
emailingtemplate	Collection of type 'emailingtemplate'

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'options'

Name	Type	Description
pair	Structure of type 'pair'

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 'emailingtemplate'

Name	Type	Description
id	int	The ID of the template.
name	string	The name of the template.