Manual - Intelligent Mail

PHP

Introduction

Intelligent Mail code allows you to encode postal codes in the United States including a tracking code.
You must set the tracking code with the setTrackingCode() method before calling the parse() method.
The parse() method takes the zipcode as its parameter.
The zipcode must be one of those values:

  • 5 numbers(ZIP Code)
  • 9 numbers(ZIP Code + 4)
  • 11 numbers(ZIP Code + 4 + 2 numbers)

This class inherits the BCGBarcode1D class.

Example

Methods

BCGintelligentmail's Methods

BCGBarcode1D's Methods

BCGBarcode's Methods

Code Example


<?php

use BarcodeBakery\Common\BCGFontFile;

use BarcodeBakery\Common\BCGColor;

use BarcodeBakery\Common\BCGDrawing;

use BarcodeBakery\Barcode\BCGintelligentmail;



$font = new BCGFontFile(__DIR__ . '/font/Arial.ttf', 18);

$colorBlack = new BCGColor(0, 0, 0);

$colorWhite = new BCGColor(255, 255, 255);



// Barcode Part

$code = new BCGintelligentmail();

$code->setScale(2);

$code->setForegroundColor($colorBlack);

$code->setBackgroundColor($colorWhite);

$code->setFont($font);

$code->setTrackingCode('01', '234', '567094', '987654321');

$code->parse('98103');



// Drawing Part

$drawing = new BCGDrawing($code, $colorWhite);



header('Content-Type: image/png');



$drawing->finish(BCGDrawing::IMG_FORMAT_PNG);

?>

Method explanations

  • getQuietZone() — Gets if the quiet zone will be drawn
    Returns
    bool - true if activated, false otherwise
  • setQuietZone($quietZone) — Specifies to draw a quiet zone around the barcode
    Description
    To be read correctly, the Intelligent Mail must have a quiet zone around the image. You can, however, turn this off.
    The default value is true.
  • setTrackingCode($barcodeIdentifier, $serviceTypeIdentifier, $mailerIdentifier, $serialNumber) — Sets the tracking code
    Description
    Add some information to the barcode such as:
    - Barcode Identifier: Assigned by USPS, encodes the pre-sort identification. 2 digits, last digit must be between 0 and 4.
    - Service Type: Assigned by USPS, type of service of the mail. 3 digits.
    - Mailer Identifier: Assigned by USPS as unique id to identify your business. 6 or 9 digits.
    - Serial Number: Assigned by the mailer for uniquely identifying and tracking mail pieces. 9 digits if mailer identifier is 6 digits. 6 otherwise.
  • getThickness() — Returns the thickness of the barcode
    Description
    The thickness of the barcode in pixels. The value isn't multiplied by the scale.
    Returns
    int - value in pixels
  • setThickness($thickness) — Specifies the thickness of the barcode
    Description
    The thickness of the barcode in pixels. This is the vertical size.
  • getLabel() — Gets the label
    Description
    Returns the real value that will be displayed with the barcode. You have to have called the parse() method first.
    Returns
    string - final label
  • setLabel($label) — Sets the label
    Description
    The text label will be written below or above the barcode depending on the barcode. You can write the special value BCGBarcode1D::AUTO_LABEL if you would like your text to be chosen automatically. It will be the value passed to the parse() method.
  • getFont() — Gets the text font for the label
    Description
    Gets the text font for the label.
    Returns
    BCGFontFile, BCGFontPhp, or int
  • setFont($font) — Sets the text font for the label
    Description
    The value of the argument can be either an instance of the BCGFontFile class, BCGFontPhp, or a number between 1 and 5.
    If you are using numbers 1 through 5, PHP fonts are used. Check the PHP Manual.
  • getChecksum() — Gets the checksum appended to the barcode
    Description
    Returns the value that will be appended to the barcode. This method must be called after the method parse().
    Returns
    int - checksum added or false if no checkum is included
  • setDisplayChecksum($display) — Specifies the checksum to be added to the label
    Description
    Setting true will append the checksum to the default label.
    The default value is true.
  • parse($text) — Analyzes a $text message to draw afterwards
    Description
    The data you pass to the $text argument must be supported by the type of barcode you use.
    Check each barcode's introduction section to obtain more information on how to use this method within each symbology.
  • draw($image) — Draws the barcode on the $image
    Description
    The value of the $image argument must be an image resource. The size of the image can be defined by the value received from getDimension().
  • getDimension($width, $height) — Returns an array containing the required size for the image
    Description
    Returns an array in which the first index is the image width and the second index is the image height.
    The arguments are used to specify the starting point of the drawing. Should be 0 for both.
    The BCGDrawing class uses this method to create the image resource.
    Returns
    array(int, int) - [0] is the width, [1] is the height
  • getScale() — Gets the scale of the barcode
    Description
    Gets the scale of the barcode. The value is the number of the "smallest" unit in pixel.
    Returns
    int - value in pixels
  • setScale($scale) — Sets the scale of the barcode
    Description
    The barcode will be $x times bigger. Then a pixel will be $x by $x for its size.
  • getForegroundColor() — Gets the color of the bars
    Description
    Gets the color of the bars of the barcode.
    Returns
    BCGColor
  • setForegroundColor($color) — Sets the color of the bars
    Description
    Sets the color of the bars of the barcode. By default, the color is black. This argument can be a BCGColor class or any other argument that BCGColor can accept in its constructor.
  • getBackgroundColor() — Gets the color of the spaces
    Description
    Gets the color of the spaces of the barcode.
    Returns
    BCGColor
  • setBackgroundColor($color) — Sets the color of the spaces
    Description
    Sets the color of the spaces of the barcode. By default, the color is white. This argument can be a BCGColor class or any other argument that BCGColor can accept in its constructor.
  • setColor($foregroundColor, $backgroundColor) — Sets the color of the bars and spaces
    Description
    An easy and fast method to set the color of the bars and spaces. Check the setForegroundColor() and setBackgroundColor().
  • getOffsetX() — Gets the X offset
    Description
    Gets the X offset of the barcode in pixels. The value isn't multiplied by the scale.
    Returns
    int - value in pixels
  • setOffsetX($value) — Sets the X offset
    Description
    Specifies the X offset of the barcode in pixels multiplied by the scale. The required size returned by getDimension() will be modified accordingly.
  • getOffsetY() — Gets the Y offset
    Description
    Gets the Y offset of the barcode in pixels. The value isn't multiplied by the scale.
    Returns
    int - value in pixels
  • setOffsetY($value) — Sets the Y offset
    Description
    Specifies the Y offset of the barcode in pixels multiplied by the scale. The required size returned by getDimension() will be modified accordingly.
  • addLabel($label) — Adds a label to the graphic
    Description
    Adds a BCGLabel object to the drawing.
  • removeLabel($label) — Removes a label from the graphic
    Description
    Removes a specific BCGLabel object from the drawing.
  • clearLabels() — Removes the labels from the graphic
    Description
    Clears the BCGLabel objects from the drawing.