Class: Label

Label

An api adapter over the end points handling a specific label in a character's inbox via functions in the mail ESI endpoints. You should not usually instantiate this directly as its constructor requires an internal api instance.


new Label(mail, labelId)

Create a new Label adaptor owned by the given mail corresponding to the given labelId.

Parameters:
Name Type Description
mail Mail

The owning fleet

labelId Number

The label id of this instance

Methods


del()

Delete a mail label.

This makes an HTTP DELETE request to /characters/{character_id}/mail/labels/{label_id}/. The route version is v1.

On success, this resolves to an empty object.

This function must be used with an SSO token that has the following scopes:

  • esi-mail.organize_mail.v1
Returns:

A Promise that resolves to an empty object.

Type
Promise.<Object>