com.cribbstechnologies.clients.mandrill.request

Class MandrillUsersRequest

java.lang.Object

com.cribbstechnologies.clients.mandrill.request.MandrillUsersRequest

public class MandrillUsersRequest
extends Object

This class holds various functions for the Mandrill Users API.

Author:

Brian Cribbs, brian@cribbstechnologies.com

Constructor Summary

Constructors

Constructor and Description
MandrillUsersRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DisableResponse	disableSender(MandrillRequestWithDomain disableRequest) Deprecated.
UsersInfoResponse	getInfo(BaseMandrillRequest infoRequest) Return the information about the API-connected user
UsersSendersResponse	getSenders(BaseMandrillRequest sendersRequest) Return the senders that have tried to use this account, both verified and unverified
com.fasterxml.jackson.core.type.TypeReference<List<MandrillSender>>	getUsersListReference()
BaseMandrillStringResponse	performPing(BaseMandrillRequest pingRequest) Validate an API key and respond to a ping
PingResponse	performPing2(BaseMandrillRequest pingRequest) Validate an API key and respond to a ping, this uses actually formatted JSON response
void	setRequest(MandrillRESTRequest request)
VerifyResponse	verifySender(MandrillRequestWithEmail verifyRequest) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MandrillUsersRequest

public MandrillUsersRequest()

Method Detail

getInfo

public UsersInfoResponse getInfo(BaseMandrillRequest infoRequest)
                          throws RequestFailedException

Return the information about the API-connected user

Parameters:

infoRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.BaseMandrillRequest

Throws:

RequestFailedException

performPing

public BaseMandrillStringResponse performPing(BaseMandrillRequest pingRequest)
                                       throws RequestFailedException

Validate an API key and respond to a ping

Parameters:

pingRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.BaseMandrillRequest

Throws:

RequestFailedException

performPing2

public PingResponse performPing2(BaseMandrillRequest pingRequest)
                          throws RequestFailedException

Validate an API key and respond to a ping, this uses actually formatted JSON response

Parameters:

pingRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.BaseMandrillRequest

Throws:

RequestFailedException

getSenders

public UsersSendersResponse getSenders(BaseMandrillRequest sendersRequest)
                                throws RequestFailedException

Return the senders that have tried to use this account, both verified and unverified

Parameters:

sendersRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.BaseMandrillRequest

Throws:

RequestFailedException

disableSender

@Deprecated
public DisableResponse disableSender(MandrillRequestWithDomain disableRequest)
                              throws RequestFailedException

Deprecated.

Disable a sender from being able to send

Parameters:

disableRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.MandrillRequestWithEmail

Throws:

RequestFailedException

verifySender

@Deprecated
public VerifyResponse verifySender(MandrillRequestWithEmail verifyRequest)
                            throws RequestFailedException

Deprecated.

Send an email to the given address to verify that it is an accepted sender for your Mandrill account

Parameters:

verifyRequest - a populated @see com.cribbstechnologies.clients.mandrill.model.MandrillRequestWithEmail

Throws:

RequestFailedException

setRequest

public void setRequest(MandrillRESTRequest request)

getUsersListReference

public com.fasterxml.jackson.core.type.TypeReference<List<MandrillSender>> getUsersListReference()