fr.sii.ogham.email.builder

Class CidBuilder

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<AttachImageBuilder>

fr.sii.ogham.email.builder.CidBuilder

All Implemented Interfaces:

Builder<IdGenerator>, Parent<AttachImageBuilder>

public class CidBuilder
extends AbstractParent<AttachImageBuilder>
implements Builder<IdGenerator>

Configures how images are attached to Emails. Image defined in a html must be referenced by a Content-ID (or CID) if the image is attached to the email. You can define how CIDs are generated.

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
CidBuilder(AttachImageBuilder parent, BuildContext buildContext) Initializes with the parent (used when calling AbstractParent.and() method for fluent chaining).

Method Summary

Modifier and Type	Method and Description
IdGenerator	build() Instantiate and configures the instance.
CidBuilder	generator(IdGenerator generator) Image defined in a html must be referenced by a Content-ID (or CID) if the image is attached to the email.
CidBuilder	sequential() Image defined in a html must be referenced by a Content-ID (or CID) if the image is attached to the email.

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

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

Constructor Detail

CidBuilder

public CidBuilder(AttachImageBuilder parent,
                  BuildContext buildContext)

Initializes with the parent (used when calling AbstractParent.and() method for fluent chaining).

Parameters:

parent - the parent builder

buildContext - for registering instances and property evaluation

Method Detail

generator

public CidBuilder generator(IdGenerator generator)

Image defined in a html must be referenced by a Content-ID (or CID) if the image is attached to the email. You can define how CIDs are generated by defining an IdGenerator.

Use this method to provide custom CID generation strategy.

Any call to this method preempts any other configuration.

If this method is called several times, only the last provided value is used.

If null value is provided, it disables custom generator.

Parameters:

generator - the cid generator

Returns:

this instance for fluent chaining

sequential

public CidBuilder sequential()

Image defined in a html must be referenced by a Content-ID (or CID) if the image is attached to the email. You can define how CIDs are generated by defining an IdGenerator.

Enables basic sequential CID generation: 0, 1, 2, 3...

Returns:

this instance for fluent chaining

build

public IdGenerator build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<IdGenerator>

Returns:

The built instance