universum.studios.android.intent

Class EmailIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<EmailIntent>

universum.studios.android.intent.EmailIntent

public class EmailIntent
extends BaseIntent<EmailIntent>

A BaseIntent builder implementation providing API for building and starting of intents targeting a e-mail related applications.

Primary e-mail addresses may be specified via to(String) or to(String...). Carbon copy addresses may be specified via cc(String) or cc(String...). If blind carbon copy addresses are also desired, these may be specified via bcc(String) or bcc(String...).

Since:

1.0

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static Matcher	EMAIL_MATCHER Matcher for valid e-mail address.
static String	URI_SCHEME Uri scheme for e-mail targeting intents.

Constructor Summary

Constructors

Constructor and Description
EmailIntent()

Method Summary

Modifier and Type	Method and Description
List<String>	addresses() Returns the list with valid primary e-mail addresses.
EmailIntent	bcc(List<String> addresses) Appends the given set of addresses to the current blind carbon copy e-mail addresses.
EmailIntent	bcc(String... addresses) Same as bcc(List) for variable array of addresses.
EmailIntent	bcc(String address) Appends the given address to the current blind carbon copy e-mail addresses.
List<String>	bccAddresses() Returns the list with valid blind carbon copy e-mail addresses.
EmailIntent	cc(List<String> addresses) Appends the given set of addresses to the current carbon copy e-mail addresses.
EmailIntent	cc(String... addresses) Same as cc(List) for variable array of addresses.
EmailIntent	cc(String address) Appends the given address to the current carbon copy e-mail addresses.
List<String>	ccAddresses() Returns the list with valid carbon copy e-mail addresses.
static Uri	createUri(List<String> addresses) Creates an Uri specific for the Intent.ACTION_SENDTO intent action from the given set of e-mail addresses.
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
CharSequence	message() Returns the message for e-mail to send.
EmailIntent	message(CharSequence message) Sets a message for e-mail to send.
protected Intent	onBuild(Context context) Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
protected boolean	onStartWith(IntentStarter starter, Intent intent) Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).
CharSequence	subject() Returns the subject for e-mail to send.
EmailIntent	subject(CharSequence subject) Set a subject for e-mail to send.
EmailIntent	to(List<String> addresses) Appends the given set of addresses to the current primary e-mail addresses to which to send an e-mail.
EmailIntent	to(String... addresses) Same as to(List) for variable array of addresses.
EmailIntent	to(String address) Appends the given address to the current primary e-mail addresses to which to send an e-mail.

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, build, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, startWith, transitions

Methods inherited from class java.lang.Object

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

Field Detail

URI_SCHEME

public static final String URI_SCHEME

Uri scheme for e-mail targeting intents.

Constant value: mailto

See Also:

Constant Field Values

EMAIL_MATCHER

public static final Matcher EMAIL_MATCHER

Matcher for valid e-mail address.

See Also:

Patterns.EMAIL_ADDRESS

Constructor Detail

EmailIntent

public EmailIntent()

Method Detail

to

public EmailIntent to(@NonNull
                      String address)

Appends the given address to the current primary e-mail addresses to which to send an e-mail.

Note, that only valid e-mail address will be added.

Parameters:

address - The desired e-mail address to add.

Returns:

This intent builder to allow methods chaining.

See Also:

to(String...), addresses()

to

public EmailIntent to(@NonNull
                      String... addresses)

Same as to(List) for variable array of addresses.

Parameters:

addresses - The desired array of e-mail addresses to add.

to

public EmailIntent to(@Nullable
                      List<String> addresses)

Appends the given set of addresses to the current primary e-mail addresses to which to send an e-mail.

Note, that only valid e-mail addresses will be added.

Parameters:

addresses - The desired set of e-mail addresses to add. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

addresses()

addresses

@NonNull
public List<String> addresses()

Returns the list with valid primary e-mail addresses.

Returns:

List with e-mail addresses specified via one of to(...) methods or Collections.EMPTY_LIST if there were no addresses specified yet.

See Also:

to(String), to(String...), to(List)

cc

public EmailIntent cc(@NonNull
                      String address)

Appends the given address to the current carbon copy e-mail addresses. See Intent.EXTRA_CC for more info.

Note, that only valid e-mail address will be added.

Parameters:

address - The desired e-mail address to add.

Returns:

This intent builder to allow methods chaining.

See Also:

cc(String...), ccAddresses()

cc

public EmailIntent cc(@NonNull
                      String... addresses)

Same as cc(List) for variable array of addresses.

Parameters:

addresses - The desired array of e-mail addresses to add.

cc

public EmailIntent cc(@Nullable
                      List<String> addresses)

Appends the given set of addresses to the current carbon copy e-mail addresses. See Intent.EXTRA_CC for more info.

Note, that only valid e-mail addresses will be added.

Parameters:

addresses - The desired list of e-mail addresses to add. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

cc(String), cc(String...), ccAddresses()

ccAddresses

@NonNull
public List<String> ccAddresses()

Returns the list with valid carbon copy e-mail addresses.

Returns:

List with e-mail addresses specified via one of cc(...) methods or Collections.EMPTY_LIST if there were no addresses specified yet.

See Also:

cc(String), cc(String...), cc(List)

bcc

public EmailIntent bcc(@NonNull
                       String address)

Appends the given address to the current blind carbon copy e-mail addresses. See Intent.EXTRA_BCC for more info.

Note, that only valid e-mail address will be added.

Parameters:

address - The desired e-mail address to add.

Returns:

This intent builder to allow methods chaining.

See Also:

bcc(String...), bccAddresses()

bcc

public EmailIntent bcc(@NonNull
                       String... addresses)

Same as bcc(List) for variable array of addresses.

Parameters:

addresses - The desired array of e-mail addresses to add.

bcc

public EmailIntent bcc(@Nullable
                       List<String> addresses)

Appends the given set of addresses to the current blind carbon copy e-mail addresses. See Intent.EXTRA_CC for more info.

Note, that only valid e-mail addresses will be added.

Parameters:

addresses - The desired list of e-mail addresses to add. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

bcc(String), bcc(String...), bccAddresses()

bccAddresses

@NonNull
public List<String> bccAddresses()

Returns the list with valid blind carbon copy e-mail addresses.

Returns:

List with e-mail addresses specified via one of bcc(...) methods or Collections.EMPTY_LIST if there were no addresses specified yet.

See Also:

bcc(String), bcc(String...), bcc(List)

subject

public EmailIntent subject(@NonNull
                           CharSequence subject)

Set a subject for e-mail to send. See Intent.EXTRA_SUBJECT for more info.

Parameters:

subject - The desired subject text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

subject()

subject

@NonNull
public CharSequence subject()

Returns the subject for e-mail to send.

Returns:

Subject of e-mail or empty text if not specified yet.

See Also:

subject(CharSequence)

message

public EmailIntent message(@NonNull
                           CharSequence message)

Sets a message for e-mail to send.

Parameters:

message - The desired message text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

message()

message

@NonNull
public CharSequence message()

Returns the message for e-mail to send.

Returns:

Message of e-mail or empty text if not specified yet.

See Also:

message(CharSequence)

ensureCanBuildOrThrow

protected void ensureCanBuildOrThrow()

Description copied from class: BaseIntent

Called to ensure that this builder can build its Intent from its current data.

If there are some required data missing/not specified, an exception indicating such state should be thrown. The default exception may be created via BaseIntent.cannotBuildIntentException(String).

Overrides:

ensureCanBuildOrThrow in class BaseIntent<EmailIntent>

onBuild

@NonNull
protected Intent onBuild(@NonNull
                                  Context context)

Description copied from class: BaseIntent

Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.

Specified by:

onBuild in class BaseIntent<EmailIntent>

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.

createUri

@Nullable
public static Uri createUri(@NonNull
                                      List<String> addresses)

Creates an Uri specific for the Intent.ACTION_SENDTO intent action from the given set of e-mail addresses.

Parameters:

addresses - List with e-mail addresses.

Returns:

Created Uri containing the specified addresses or null if the given list of addresses is empty.

onStartWith

protected boolean onStartWith(@NonNull
                              IntentStarter starter,
                              @NonNull
                              Intent intent)

Description copied from class: BaseIntent

Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).

This implementation always returns true.

Overrides:

onStartWith in class BaseIntent<EmailIntent>

Parameters:

starter - The starter with which to start the intent.

intent - The intent instance created by this intent builder.

Returns:

True to indicate that the intent has been started, false otherwise.