nullx27\ESI\MailApi

All URIs are relative to https://esi.tech.ccp.is/latest

Method	HTTP request	Description
deleteCharactersCharacterIdMailLabelsLabelId	DELETE /characters/{character_id}/mail/labels/{label_id}/	Delete a mail label
deleteCharactersCharacterIdMailMailId	DELETE /characters/{character_id}/mail/{mail_id}/	Delete a mail
getCharactersCharacterIdMail	GET /characters/{character_id}/mail/	Return mail headers
getCharactersCharacterIdMailLabels	GET /characters/{character_id}/mail/labels/	Get mail labels and unread counts
getCharactersCharacterIdMailLists	GET /characters/{character_id}/mail/lists/	Return mailing list subscriptions
getCharactersCharacterIdMailMailId	GET /characters/{character_id}/mail/{mail_id}/	Return a mail
postCharactersCharacterIdMail	POST /characters/{character_id}/mail/	Send a new mail
postCharactersCharacterIdMailLabels	POST /characters/{character_id}/mail/labels/	Create a mail label
putCharactersCharacterIdMailMailId	PUT /characters/{character_id}/mail/{mail_id}/	Update metadata about a mail

deleteCharactersCharacterIdMailLabelsLabelId

deleteCharactersCharacterIdMailLabelsLabelId($characterId, $labelId, $datasource, $token, $userAgent, $xUserAgent)

Delete a mail label

Delete a mail label --- Alternate route: /dev/characters/{character_id}/mail/labels/{label_id}/ Alternate route: /legacy/characters/{character_id}/mail/labels/{label_id}/ Alternate route: /v1/characters/{character_id}/mail/labels/{label_id}/

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$labelId = 56; // int | An EVE label id
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $apiInstance->deleteCharactersCharacterIdMailLabelsLabelId($characterId, $labelId, $datasource, $token, $userAgent, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->deleteCharactersCharacterIdMailLabelsLabelId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
labelId	int	An EVE label id
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

void (empty response body)

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteCharactersCharacterIdMailMailId

deleteCharactersCharacterIdMailMailId($characterId, $mailId, $datasource, $token, $userAgent, $xUserAgent)

Delete a mail

Delete a mail --- Alternate route: /dev/characters/{character_id}/mail/{mail_id}/ Alternate route: /legacy/characters/{character_id}/mail/{mail_id}/ Alternate route: /v1/characters/{character_id}/mail/{mail_id}/

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$mailId = 56; // int | An EVE mail ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $apiInstance->deleteCharactersCharacterIdMailMailId($characterId, $mailId, $datasource, $token, $userAgent, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->deleteCharactersCharacterIdMailMailId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
mailId	int	An EVE mail ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

void (empty response body)

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdMail

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMail200Ok[] getCharactersCharacterIdMail($characterId, $datasource, $labels, $lastMailId, $token, $userAgent, $xUserAgent)

Return mail headers

Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards. --- Alternate route: /dev/characters/{character_id}/mail/ Alternate route: /legacy/characters/{character_id}/mail/ Alternate route: /v1/characters/{character_id}/mail/ --- This route is cached for up to 30 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$labels = array(56); // int[] | Fetch only mails that match one or more of the given labels
$lastMailId = 56; // int | List only mail with an ID lower than the given ID, if present
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getCharactersCharacterIdMail($characterId, $datasource, $labels, $lastMailId, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->getCharactersCharacterIdMail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
labels	int[]	Fetch only mails that match one or more of the given labels	[optional]
lastMailId	int	List only mail with an ID lower than the given ID, if present	[optional]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMail200Ok[]

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdMailLabels

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailLabelsOk getCharactersCharacterIdMailLabels($characterId, $datasource, $token, $userAgent, $xUserAgent)

Get mail labels and unread counts

Return a list of the users mail labels, unread counts for each label and a total unread count. --- Alternate route: /dev/characters/{character_id}/mail/labels/ Alternate route: /v3/characters/{character_id}/mail/labels/ --- This route is cached for up to 30 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getCharactersCharacterIdMailLabels($characterId, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->getCharactersCharacterIdMailLabels: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailLabelsOk

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdMailLists

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailLists200Ok[] getCharactersCharacterIdMailLists($characterId, $datasource, $token, $userAgent, $xUserAgent)

Return mailing list subscriptions

Return all mailing lists that the character is subscribed to --- Alternate route: /dev/characters/{character_id}/mail/lists/ Alternate route: /legacy/characters/{character_id}/mail/lists/ Alternate route: /v1/characters/{character_id}/mail/lists/ --- This route is cached for up to 120 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getCharactersCharacterIdMailLists($characterId, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->getCharactersCharacterIdMailLists: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailLists200Ok[]

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdMailMailId

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailMailIdOk getCharactersCharacterIdMailMailId($characterId, $mailId, $datasource, $token, $userAgent, $xUserAgent)

Return a mail

Return the contents of an EVE mail --- Alternate route: /dev/characters/{character_id}/mail/{mail_id}/ Alternate route: /legacy/characters/{character_id}/mail/{mail_id}/ Alternate route: /v1/characters/{character_id}/mail/{mail_id}/ --- This route is cached for up to 30 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$mailId = 56; // int | An EVE mail ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->getCharactersCharacterIdMailMailId($characterId, $mailId, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->getCharactersCharacterIdMailMailId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
mailId	int	An EVE mail ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

\nullx27\ESI\nullx27\ESI\Models\GetCharactersCharacterIdMailMailIdOk

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postCharactersCharacterIdMail

int postCharactersCharacterIdMail($characterId, $mail, $datasource, $token, $userAgent, $xUserAgent)

Send a new mail

Create and send a new mail --- Alternate route: /dev/characters/{character_id}/mail/ Alternate route: /legacy/characters/{character_id}/mail/ Alternate route: /v1/characters/{character_id}/mail/

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$mail = new \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailMail(); // \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailMail | The mail to send
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->postCharactersCharacterIdMail($characterId, $mail, $datasource, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->postCharactersCharacterIdMail: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
mail	\nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailMail	The mail to send
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

int

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postCharactersCharacterIdMailLabels

int postCharactersCharacterIdMailLabels($characterId, $datasource, $label, $token, $userAgent, $xUserAgent)

Create a mail label

Create a mail label --- Alternate route: /dev/characters/{character_id}/mail/labels/ Alternate route: /legacy/characters/{character_id}/mail/labels/ Alternate route: /v2/characters/{character_id}/mail/labels/

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$label = new \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailLabelsLabel(); // \nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailLabelsLabel | Label to create
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $apiInstance->postCharactersCharacterIdMailLabels($characterId, $datasource, $label, $token, $userAgent, $xUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->postCharactersCharacterIdMailLabels: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
label	\nullx27\ESI\nullx27\ESI\Models\PostCharactersCharacterIdMailLabelsLabel	Label to create	[optional]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

int

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putCharactersCharacterIdMailMailId

putCharactersCharacterIdMailMailId($characterId, $contents, $mailId, $datasource, $token, $userAgent, $xUserAgent)

Update metadata about a mail

Update metadata about a mail --- Alternate route: /dev/characters/{character_id}/mail/{mail_id}/ Alternate route: /legacy/characters/{character_id}/mail/{mail_id}/ Alternate route: /v1/characters/{character_id}/mail/{mail_id}/

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
$config = nullx27\ESI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new nullx27\ESI\Api\MailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$characterId = 56; // int | An EVE character ID
$contents = new \nullx27\ESI\nullx27\ESI\Models\PutCharactersCharacterIdMailMailIdContents(); // \nullx27\ESI\nullx27\ESI\Models\PutCharactersCharacterIdMailMailIdContents | Data used to update the mail
$mailId = 56; // int | An EVE mail ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$userAgent = "userAgent_example"; // string | Client identifier, takes precedence over headers
$xUserAgent = "xUserAgent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $apiInstance->putCharactersCharacterIdMailMailId($characterId, $contents, $mailId, $datasource, $token, $userAgent, $xUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling MailApi->putCharactersCharacterIdMailMailId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
characterId	int	An EVE character ID
contents	\nullx27\ESI\nullx27\ESI\Models\PutCharactersCharacterIdMailMailIdContents	Data used to update the mail
mailId	int	An EVE mail ID
datasource	string	The server name you would like data from	[optional] [default to tranquility]
token	string	Access token to use if unable to set a header	[optional]
userAgent	string	Client identifier, takes precedence over headers	[optional]
xUserAgent	string	Client identifier, takes precedence over User-Agent	[optional]

Return type

void (empty response body)

Authorization

evesso

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MailApi.md

Latest commit

History

MailApi.md

File metadata and controls

nullx27\ESI\MailApi

deleteCharactersCharacterIdMailLabelsLabelId

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMail

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailLabels

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailLists

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers

postCharactersCharacterIdMail

Example

Parameters

Return type

Authorization

HTTP request headers

postCharactersCharacterIdMailLabels

Example

Parameters

Return type

Authorization

HTTP request headers

putCharactersCharacterIdMailMailId

Example

Parameters

Return type

Authorization

HTTP request headers