The mailman-client API

0.1

A Node.js client for mailman-core

Address Class

Extends ApiRequest
Defined in: lib/Address.js:12
Module: Address
Parent Module: mailman-client

Address extends ApiRequest to perform operations on the address resource

Properties

_info Object private

Defined in lib/Address.js:83

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

Default: null

_keys Array private

Defined in lib/Address.js:93

Keys of the _info object

Default: []

_options Object private

Inherited from BaseRequest but overwritten in lib/Address.js:25

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/Address.js:73

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

_supportedMethods Array private

Inherited from BaseRequest but overwritten in lib/Address.js:35

Supported HTTP methods

Default: ['get','post']

_template String private

Inherited from BaseRequest but overwritten in lib/Address.js:63

The URI template used to generate the URI to request

Default: ''

_url String private

Defined in lib/Address.js:54

Resource URL

display_name String

Defined in lib/Address.js:146

Display name of the address

email String private

Defined in lib/Address.js:45

Associated email address corresponding Address object

preferences Preferences

Defined in lib/Address.js:186

Getter for the Preferences instance corresponding to the current Address instance

registered_on String

Defined in lib/Address.js:153

Registration timestamp of the address

verified_on String

Defined in lib/Address.js:160

Verification timestamp of the address

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

Address
(
  • options
  • address
)

Defined in lib/Address.js:12

Parameters:

  • options Object

    A hash of options for the Address 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

  • address Object

    A hash of address object containing the location of the 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/Address.js:139

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

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/Address.js:109

Fetch the resource by making a HTTP GET request and calls the callback(if any), and provide a promise to the Address 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 Address object itself

Returns:

Promise:

Promise to the Address object itself

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

noop ()

Provided by the mailman-client module.

Defined in lib/utils/index.js:9

No operation function

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

Promise ()

Provided by the mailman-client module.

Defined in lib/utils/index.js:31

The plain BlueBird promise with no extra sugar

promisify
(
  • data
)
Promise

Provided by the mailman-client module.

Defined in lib/utils/index.js:16

Return a promise to the data with maintaining support for a node style callback(if provided)

Parameters:

  • data Object

    The object to which promise is to be provided

Returns:

Promise:

A promise to the data

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

toString () String

Defined in lib/Address.js:254

String representation of the Address object

Returns:

String:

Associated email address to the Address object

unverify
(
  • [callback]
)
Promise async

Defined in lib/Address.js:230

Verify the address and calls the callback(if any), and provide a promise to the Address 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 Address object itself

Returns:

Promise:

Promise to the Address object itself

verify
(
  • [callback]
)
Promise async

Defined in lib/Address.js:206

Verify the address and calls the callback(if any), and provide a promise to the Address 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 Address object itself

Returns:

Promise:

Promise to the Address object itself

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