com.clicksend.models

Class FaxMessageBuilder

java.lang.Object

com.clicksend.models.FaxMessageBuilder

public class FaxMessageBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
FaxMessageBuilder() Default constructor to initialize the instance

Method Summary

Modifier and Type	Method and Description
FaxMessage	build() Build the instance with the given values
FaxMessageBuilder	country(String country) Recipient country.
FaxMessageBuilder	customString(String customString) Your reference.
FaxMessageBuilder	from(String from) Your sender id.
FaxMessageBuilder	fromEmail(String fromEmail) An email address where the reply should be emailed to.
FaxMessageBuilder	listId(Integer listId) Your list ID if sending to a whole list.
FaxMessageBuilder	schedule(Integer schedule) Leave blank for immediate delivery.
FaxMessageBuilder	source(String source) Your method of sending e.g.
FaxMessageBuilder	to(String to) Recipient fax number in E.164 format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FaxMessageBuilder

public FaxMessageBuilder()

Default constructor to initialize the instance

Method Detail

source

public FaxMessageBuilder source(String source)

Your method of sending e.g. 'wordpress', 'php', 'c#'.

to

public FaxMessageBuilder to(String to)

Recipient fax number in E.164 format.

listId

public FaxMessageBuilder listId(Integer listId)

Your list ID if sending to a whole list. Can be used instead of 'to'.

from

public FaxMessageBuilder from(String from)

Your sender id. Must be a valid fax number.

schedule

public FaxMessageBuilder schedule(Integer schedule)

Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp

customString

public FaxMessageBuilder customString(String customString)

Your reference. Will be passed back with all replies and delivery reports.

country

public FaxMessageBuilder country(String country)

Recipient country.

fromEmail

public FaxMessageBuilder fromEmail(String fromEmail)

An email address where the reply should be emailed to.

build

public FaxMessage build()

Build the instance with the given values