The mailman-client API

0.1

A Node.js client for mailman-core

Domain Class

Extends ApiRequest
Defined in: lib/Domain.js:13
Module: Domain
Parent Module: mailman-client

Domain extends ApiRequest to perform operations on the domain resource

Properties

_info Object private

Defined in lib/Domain.js:74

Object containing the resource information, will be null if getInfo() is never called

Default: null

_keys Array private

Defined in lib/Domain.js:84

Keys of the _info object

Default: []

_options Object private

Inherited from BaseRequest but overwritten in lib/Domain.js:26

Configuration options such as the endpoint of the API, auth parameters etc.

Default: {}

_params Object private

The object containing the query parameters

Default: {}

_path Object private

Inherited from BaseRequest but overwritten in lib/Domain.js:94

Object containing request path variables used to assemble the request URI

Default: {}

_queryParams Boolean private

A boolean flag that is set when there are query parameters to be rendered

Default: false

_rootTemplate String private

Defined in lib/Domain.js:45

Root template string for the domain resource used to assemble other endpoints under this category

_supportedMethods Array private

Inherited from BaseRequest but overwritten in lib/Domain.js:64

Supported HTTP methods

Default: ['get','post','delete']

_template String private

Inherited from BaseRequest but overwritten in lib/Domain.js:54

The URI template used to generate the URI to request

Default: ''

_url String private

Defined in lib/Domain.js:36

URL of the domain resource

base_url String

Defined in lib/Domain.js:146

Base URL of the domain

description String

Defined in lib/Domain.js:153

Description of the domain

mail_host String

Defined in lib/Domain.js:160

Mail host of the domain

url_host String

Defined in lib/Domain.js:166

URL host of the domain

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Constructor

Domain
(
  • options
  • url
)

Defined in lib/Domain.js:13

Parameters:

  • options Object

    A hash of options for the Domain instance

    • endpoint String

      The endpoint URI to request

    • [username] String optional

      A username for authenticating API requests

    • [password] String optional

      A password for authenticating API requests

  • url String

    Location of the domain resource on the server

Methods

_auth () Object private

Performs auth on the superagent request object if implied externally

Returns:

Object:

The superagent request object by performing auth on it

_checkAuthParameters () Boolean private

Checks if authentication is externally forced on the request object by passing in username & password

Returns:

Boolean:

Returns true if auth is forced else false

_checkMethodSupport
(
  • method
)
Boolean private

Verify that the request object in use supports a HTTP method

Parameters:

  • method String

    An HTTP method to check ('get', 'post', etc)

Returns:

Boolean:

Returns true if the HTTP method is supported else it will throw

_renderPath () String private

Renders the request path by using _path and _template

Returns:

String:

The rendered path string

_renderQuery () String private

Compose query string by using the recorded query parameters

Returns:

String:

Returns the query string to be appended in the final URI

_renderURI () String private

Renders the URI to request after checking for query parameters

Returns:

String:

The URI enpoint to request

_setAccessors () private

Defined in lib/Domain.js:139

Set the accessors on the object for the resource information i.e _info object

addOwner
(
  • owner
  • [callback]
)
Promise async

Defined in lib/Domain.js:294

Add a list owner

Parameters:

  • owner String

    Email address of the owner to be added

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The Domain object itself

Returns:

Promise:

Promise to the Domain object itself

createList
(
  • listName
  • [callback]
)
Promise async

Defined in lib/Domain.js:245

Create a List correspoding to the domain

Parameters:

  • listName String

    Name of the list to be ctreated

  • [callback] Function optional

    The callback function to be invoked with the created List instance

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The created List instance

Returns:

Promise:

Promise to the created List instance

delete
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the DELETE request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

get
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the GET request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

getInfo
(
  • [callback]
)
Promise async

Defined in lib/Domain.js:109

Fetch the resource by making a HTTP GET request and calls the callback(if any), and provide a promise to the Domain object itself

Parameters:

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The Domain object itself

Returns:

Promise:

Promise to the Domain object itself

getLists
(
  • [callback]
)
Promise async

Defined in lib/Domain.js:212

Gives the lists i.e List instances under the current domain

Parameters:

  • [callback] Function optional

    The callback function to be invoked with an array of List instances

    • err Error | Object

      Any errors encountered during the request

    • result Object

      An array of List instances

Returns:

Promise:

Promise to an array of List instances

getOwners
(
  • [callback]
)
Promise async

Defined in lib/Domain.js:185

Gives the owners i.e User instances corresponding to the domain

Parameters:

  • [callback] Function optional

    The callback function to be invoked with an array of User instances

    • err Error | Object

      Any errors encountered during the request

    • result Object

      An array of User instances

Returns:

Promise:

Promise to an array of User instances

head
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the HEAD request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

patch
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The patch data

  • [callback] Function optional

    A callback to invoke with the results of the PATCH request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

post
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The post data

  • [callback] Function optional

    A callback to invoke with the results of the POST request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

put
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The put data

  • [callback] Function optional

    A callback to invoke with the results of the PUT request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

query
(
  • key
  • [value]
)
Object chainable

Record query parameters to be rendered in the final URI

Parameters:

  • key String | Object

    The name of the query parameter or an object containing query parameters as key,val pairs repectively

  • [value] String | Array optional

    If the supplied key is a String, then value can be of type Array or String

Returns:

Object:

Returns the ApiRequest instance itself if the arguments are in the required form else throw an Error

removeOwners
(
  • [callback]
)
Promise async

Defined in lib/Domain.js:273

Remove all the list owners

Parameters:

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The Domain object itself

Returns:

Promise:

Promise to the Domain object itself

toString () String

Defined in lib/Domain.js:317

String representation of the Domain object

Returns:

String:

Returns the string representation of the Domain object

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index