Package security.whisper.javastix.coo.objects

Class EmailMessage.Builder

java.lang.Object
security.whisper.javastix.coo.objects.EmailMessage.Builder
Enclosing class:
EmailMessage
@NotThreadSafe public static final class EmailMessage.Builder extends Object
Builds instances of type EmailMessage. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • from

      @CanIgnoreReturnValue public final EmailMessage.Builder from(EmailMessageCoo instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.coo.objects.EmailMessageCoo instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final EmailMessage.Builder from(BundleableObject instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.bundle.BundleableObject instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final EmailMessage.Builder from(StixCustomProperties instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.common.StixCustomProperties instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final EmailMessage.Builder from(CyberObservableObjectCommonProperties instance)
      Fill a builder with attribute values from the provided security.whisper.javastix.coo.CyberObservableObjectCommonProperties instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • isMultipart

      @CanIgnoreReturnValue @JsonPropertyDescription("Indicates whether the email body contains multiple MIME parts.") public final EmailMessage.Builder isMultipart(Boolean isMultipart)
      Initializes the value for the isMultipart attribute.
      Parameters:
      isMultipart - The value for isMultipart (can be null)
      Returns:
      this builder for use in a chained invocation

    • date

      @CanIgnoreReturnValue public final EmailMessage.Builder date(StixInstant date)
      Initializes the optional value date to date.
      Parameters:
      date - The value for date
      Returns:
      this builder for chained invocation

    • date

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the date/time that the email message was sent.") public final EmailMessage.Builder date(Optional<? extends StixInstant> date)
      Initializes the optional value date to date.
      Parameters:
      date - The value for date
      Returns:
      this builder for use in a chained invocation

    • contentType

      @CanIgnoreReturnValue public final EmailMessage.Builder contentType(String contentType)
      Initializes the optional value contentType to contentType.
      Parameters:
      contentType - The value for contentType
      Returns:
      this builder for chained invocation

    • contentType

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the value of the \'Content-Type\' header of the email message.") public final EmailMessage.Builder contentType(Optional<String> contentType)
      Initializes the optional value contentType to contentType.
      Parameters:
      contentType - The value for contentType
      Returns:
      this builder for use in a chained invocation

    • fromRef

      @CanIgnoreReturnValue public final EmailMessage.Builder fromRef(String fromRef)
      Initializes the optional value fromRef to fromRef.
      Parameters:
      fromRef - The value for fromRef
      Returns:
      this builder for chained invocation

    • fromRef

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the value of the \'From:\' header of the email message.") public final EmailMessage.Builder fromRef(Optional<String> fromRef)
      Initializes the optional value fromRef to fromRef.
      Parameters:
      fromRef - The value for fromRef
      Returns:
      this builder for use in a chained invocation

    • senderRef

      @CanIgnoreReturnValue public final EmailMessage.Builder senderRef(String senderRef)
      Initializes the optional value senderRef to senderRef.
      Parameters:
      senderRef - The value for senderRef
      Returns:
      this builder for chained invocation

    • senderRef

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies the value of the \'From\' field of the email message") public final EmailMessage.Builder senderRef(Optional<String> senderRef)
      Initializes the optional value senderRef to senderRef.
      Parameters:
      senderRef - The value for senderRef
      Returns:
      this builder for use in a chained invocation

    • type

      @CanIgnoreReturnValue public final EmailMessage.Builder type(String type)
      Initializes the value for the type attribute.
      Parameters:
      type - The value for type (can be null)
      Returns:
      this builder for use in a chained invocation

    • addExtension

      @CanIgnoreReturnValue public final EmailMessage.Builder addExtension(@Nullable CyberObservableExtension element)
      Adds one element to extensions set.
      Parameters:
      element - A extensions element
      Returns:
      this builder for use in a chained invocation

    • addExtensions

      @CanIgnoreReturnValue public final EmailMessage.Builder addExtensions(CyberObservableExtension... elements)
      Adds elements to extensions set.
      Parameters:
      elements - An array of extensions elements
      Returns:
      this builder for use in a chained invocation

    • extensions

      @CanIgnoreReturnValue @JsonPropertyDescription("Specifies any extensions of the object, as a dictionary.") public final EmailMessage.Builder extensions(Iterable<? extends CyberObservableExtension> elements)
      Sets or replaces all elements for extensions set.
      Parameters:
      elements - An iterable of extensions elements
      Returns:
      this builder for use in a chained invocation

    • addAllExtensions

      @CanIgnoreReturnValue public final EmailMessage.Builder addAllExtensions(Iterable<? extends CyberObservableExtension> elements)
      Adds elements to extensions set.
      Parameters:
      elements - An iterable of extensions elements
      Returns:
      this builder for use in a chained invocation

    • observableObjectKey

      @CanIgnoreReturnValue public final EmailMessage.Builder observableObjectKey(String observableObjectKey)
      Initializes the value for the observableObjectKey attribute.

      If not set, this attribute will have a default value as returned by the initializer of observableObjectKey.

      Parameters:
      observableObjectKey - The value for observableObjectKey
      Returns:
      this builder for use in a chained invocation

    • defanged

      @CanIgnoreReturnValue public final EmailMessage.Builder defanged(boolean defanged)
      Initializes the optional value defanged to defanged.
      Parameters:
      defanged - The value for defanged
      Returns:
      this builder for chained invocation

    • defanged

      @CanIgnoreReturnValue @JsonPropertyDescription("Indicates whether the data contained in the SCO has been defanged.") public final EmailMessage.Builder defanged(Optional<Boolean> defanged)
      Initializes the optional value defanged to defanged.
      Parameters:
      defanged - The value for defanged
      Returns:
      this builder for use in a chained invocation

    • putCustomProperty

      @CanIgnoreReturnValue public final EmailMessage.Builder putCustomProperty(String key, Object value)
      Put one entry to the customProperties map.
      Parameters:
      key - The key in the customProperties map
      value - The associated value in the customProperties map
      Returns:
      this builder for use in a chained invocation

    • putCustomProperty

      @CanIgnoreReturnValue public final EmailMessage.Builder putCustomProperty(Map.Entry<String,? extends Object> entry)
      Put one entry to the customProperties map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation

    • customProperties

      @CanIgnoreReturnValue public final EmailMessage.Builder customProperties(Map<String,? extends Object> entries)
      Sets or replaces all mappings from the specified map as entries for the customProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the customProperties map
      Returns:
      this builder for use in a chained invocation

    • putAllCustomProperties

      @CanIgnoreReturnValue public final EmailMessage.Builder putAllCustomProperties(Map<String,? extends Object> entries)
      Put all mappings from the specified map as entries to customProperties map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the customProperties map
      Returns:
      this builder for use in a chained invocation

    • addObjectMarkingRef

      @CanIgnoreReturnValue public final EmailMessage.Builder addObjectMarkingRef(@Nullable MarkingDefinitionDm element)
      Adds one element to objectMarkingRefs set.
      Parameters:
      element - A objectMarkingRefs element
      Returns:
      this builder for use in a chained invocation

    • addObjectMarkingRefs

      @CanIgnoreReturnValue public final EmailMessage.Builder addObjectMarkingRefs(MarkingDefinitionDm... elements)
      Adds elements to objectMarkingRefs set.
      Parameters:
      elements - An array of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • objectMarkingRefs

      @CanIgnoreReturnValue public final EmailMessage.Builder objectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Sets or replaces all elements for objectMarkingRefs set.
      Parameters:
      elements - An iterable of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • addAllObjectMarkingRefs

      @CanIgnoreReturnValue public final EmailMessage.Builder addAllObjectMarkingRefs(Iterable<? extends MarkingDefinitionDm> elements)
      Adds elements to objectMarkingRefs set.
      Parameters:
      elements - An iterable of objectMarkingRefs elements
      Returns:
      this builder for use in a chained invocation

    • addGranularMarking

      @CanIgnoreReturnValue public final EmailMessage.Builder addGranularMarking(@Nullable GranularMarkingDm element)
      Adds one element to granularMarkings set.
      Parameters:
      element - A granularMarkings element
      Returns:
      this builder for use in a chained invocation

    • addGranularMarkings

      @CanIgnoreReturnValue public final EmailMessage.Builder addGranularMarkings(GranularMarkingDm... elements)
      Adds elements to granularMarkings set.
      Parameters:
      elements - An array of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • granularMarkings

      @CanIgnoreReturnValue public final EmailMessage.Builder granularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Sets or replaces all elements for granularMarkings set.
      Parameters:
      elements - An iterable of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • addAllGranularMarkings

      @CanIgnoreReturnValue public final EmailMessage.Builder addAllGranularMarkings(Iterable<? extends GranularMarkingDm> elements)
      Adds elements to granularMarkings set.
      Parameters:
      elements - An iterable of granularMarkings elements
      Returns:
      this builder for use in a chained invocation

    • hydrated

      @CanIgnoreReturnValue public final EmailMessage.Builder hydrated(boolean hydrated)
      Initializes the value for the hydrated attribute.
      Parameters:
      hydrated - The value for hydrated
      Returns:
      this builder for use in a chained invocation

    • toJsonString

      @CanIgnoreReturnValue public final EmailMessage.Builder toJsonString(String toJsonString)
      Initializes the value for the toJsonString attribute.
      Parameters:
      toJsonString - The value for toJsonString (can be null)
      Returns:
      this builder for use in a chained invocation

    • build

      public EmailMessage build()
      Builds a new EmailMessage.
      Returns:
      An immutable instance of EmailMessage
      Throws:
      IllegalStateException - if any required attributes are missing